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

Class GetObjectLegalHoldRequest

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.GetObjectLegalHoldRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetObjectLegalHoldRequest.Builder,GetObjectLegalHoldRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetObjectLegalHoldRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The bucket name containing the object whose legal hold status you want to retrieve.
static GetObjectLegalHoldRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expectedBucketOwner()	The account ID of the expected bucket owner.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The key name for the object whose legal hold status you want to retrieve.
RequestPayer	requestPayer()	Returns the value of the RequestPayer property for this object.
String	requestPayerAsString()	Returns the value of the RequestPayer property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends GetObjectLegalHoldRequest.Builder>	serializableBuilderClass()
GetObjectLegalHoldRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionId()	The version ID of the object whose legal hold status you want to retrieve.

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

bucket

public final String bucket()

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

Returns:

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

key

public final String key()

The key name for the object whose legal hold status you want to retrieve.

Returns:

The key name for the object whose legal hold status you want to retrieve.

versionId

public final String versionId()

The version ID of the object whose legal hold status you want to retrieve.

Returns:

The version ID of the object whose legal hold status you want to retrieve.

requestPayer

public final RequestPayer requestPayer()

Returns the value of the RequestPayer property for this object.

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

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

requestPayerAsString

public final String requestPayerAsString()

Returns the value of the RequestPayer property for this object.

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

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

expectedBucketOwner

public final String expectedBucketOwner()

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

toBuilder

public GetObjectLegalHoldRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetObjectLegalHoldRequest.Builder,GetObjectLegalHoldRequest>

Specified by:

toBuilder in class S3Request

builder

public static GetObjectLegalHoldRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetObjectLegalHoldRequest.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