com.ibm.cos.v2.services.s3.model

Class SessionCredentials

java.lang.Object

com.ibm.cos.v2.services.s3.model.SessionCredentials

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SessionCredentials.Builder,SessionCredentials>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class SessionCredentials
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SessionCredentials.Builder,SessionCredentials>

The established temporary security credentials of the session.

Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SessionCredentials.Builder

Method Summary

Modifier and Type	Method and Description
String	accessKeyId() A unique identifier that's associated with a secret access key.
static SessionCredentials.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Instant	expiration() Temporary security credentials expire after a specified interval.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretAccessKey() A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests.
static Class<? extends SessionCredentials.Builder>	serializableBuilderClass()
String	sessionToken() A part of the temporary security credentials.
SessionCredentials.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

accessKeyId

public final String accessKeyId()

A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

Returns:

A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

secretAccessKey

public final String secretAccessKey()

A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

Returns:

A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

sessionToken

public final String sessionToken()

A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

Returns:

A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

expiration

public final Instant expiration()

Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

Returns:

Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

toBuilder

public SessionCredentials.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SessionCredentials.Builder,SessionCredentials>

Returns:

a builder for type T

builder

public static SessionCredentials.Builder builder()

serializableBuilderClass

public static Class<? extends SessionCredentials.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.