software.amazon.awssdk.services.s3.model

Class PutObjectTaggingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutObjectTaggingRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The bucket name containing the object.
static PutObjectTaggingRequest.Builder	builder()
ChecksumAlgorithm	checksumAlgorithm() Indicates the algorithm used to create the checksum for the object when using the SDK.
String	checksumAlgorithmAsString() Indicates the algorithm used to create the checksum for the object when using the SDK.
String	contentMD5() The MD5 hash for the request body.
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() Name of the object key.
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 PutObjectTaggingRequest.Builder>	serializableBuilderClass()
Tagging	tagging() Container for the TagSet and Tag elements
PutObjectTaggingRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionId() The versionId of the object that the tag-set will be added to.

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.

When using this action with an access point, 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.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Returns:

The bucket name containing the object.

When using this action with an access point, 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.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

key

public final String key()

Name of the object key.

Returns:

Name of the object key.

versionId

public final String versionId()

The versionId of the object that the tag-set will be added to.

Returns:

The versionId of the object that the tag-set will be added to.

contentMD5

public final String contentMD5()

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

checksumAlgorithm

public final ChecksumAlgorithm checksumAlgorithm()

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

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

Returns:

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

See Also:

ChecksumAlgorithm

checksumAlgorithmAsString

public final String checksumAlgorithmAsString()

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

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

Returns:

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

See Also:

ChecksumAlgorithm

tagging

public final Tagging tagging()

Container for the TagSet and Tag elements

Returns:

Container for the TagSet and Tag elements

expectedBucketOwner

public final String expectedBucketOwner()

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

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

toBuilder

public PutObjectTaggingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>

Specified by:

toBuilder in class S3Request

builder

public static PutObjectTaggingRequest.Builder builder()

serializableBuilderClass

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