CreateSessionResponse (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkResponse
- - com.ibm.cos.v2.awscore.AwsResponse
  - - com.ibm.cos.v2.services.s3.model.S3Response
    - - com.ibm.cos.v2.services.s3.model.CreateSessionResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateSessionResponse.Builder,CreateSessionResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateSessionResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateSessionResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`bucketKeyEnabled()` Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).
`static CreateSessionResponse.Builder`	`builder()`
`SessionCredentials`	`credentials()` The established temporary security credentials for the created session.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateSessionResponse.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The server-side encryption algorithm used when you store objects in the directory bucket.
`String`	`serverSideEncryptionAsString()` The server-side encryption algorithm used when you store objects in the directory bucket.
`String`	`ssekmsEncryptionContext()` If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.
`String`	`ssekmsKeyId()` If you specify `x-amz-server-side-encryption` with `aws:kms`, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.
`CreateSessionResponse.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 com.ibm.cos.v2.services.s3.model.S3Response
responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse
sdkHttpResponse

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
  - serverSideEncryption
```
public final ServerSideEncryption serverSideEncryption()
```
    The server-side encryption algorithm used when you store objects in the directory bucket.
    
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().
    
    Returns:
    
    The server-side encryption algorithm used when you store objects in the directory bucket.
    
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionAsString
```
public final String serverSideEncryptionAsString()
```
    The server-side encryption algorithm used when you store objects in the directory bucket.
    
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().
    
    Returns:
    
    The server-side encryption algorithm used when you store objects in the directory bucket.
    
    See Also:
    
    ServerSideEncryption
  - ssekmsKeyId
```
public final String ssekmsKeyId()
```
    If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.
    
    Returns:
    
    If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.
  - ssekmsEncryptionContext
```
public final String ssekmsEncryptionContext()
```
    If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
    
    Returns:
    
    If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
  - bucketKeyEnabled
```
public final Boolean bucketKeyEnabled()
```
    Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).
    
    Returns:
    
    Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).
  - credentials
```
public final SessionCredentials credentials()
```
    The established temporary security credentials for the created session.
    
    Returns:
    
    The established temporary security credentials for the created session.
  - toBuilder
```
public CreateSessionResponse.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<CreateSessionResponse.Builder,CreateSessionResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateSessionResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateSessionResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - 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.

Class CreateSessionResponse

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

serverSideEncryption

serverSideEncryptionAsString

ssekmsKeyId

ssekmsEncryptionContext

bucketKeyEnabled

credentials

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField