Package software.amazon.awssdk.services.s3.model

Class CreateSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3.model.S3Request

software.amazon.awssdk.services.s3.model.CreateSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSessionRequest
extends S3Request
implements ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSessionRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the bucket that you create a session for.
static CreateSessionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSessionRequest.Builder>	serializableBuilderClass()
SessionMode	sessionMode()	Specifies the mode of the session that will be created, either ReadWrite or ReadOnly.
String	sessionModeAsString()	Specifies the mode of the session that will be created, either ReadWrite or ReadOnly.
CreateSessionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sessionMode

public final SessionMode sessionMode()

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

If the service returns an enum value that is not available in the current SDK version, sessionMode will return SessionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sessionModeAsString().

Returns:

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

See Also:

SessionMode

sessionModeAsString

public final String sessionModeAsString()

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

If the service returns an enum value that is not available in the current SDK version, sessionMode will return SessionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sessionModeAsString().

Returns:

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint APIs on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

See Also:

SessionMode

bucket

public final String bucket()

The name of the bucket that you create a session for.

Returns:

The name of the bucket that you create a session for.

toBuilder

public CreateSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

Specified by:

toBuilder in class S3Request

builder

public static CreateSessionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo