software.amazon.awssdk.services.s3.model

Interface PutObjectTaggingRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>, S3Request.Builder, SdkBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutObjectTaggingRequest

public static interface PutObjectTaggingRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectTaggingRequest.Builder,PutObjectTaggingRequest>

Method Summary

Modifier and Type	Method and Description
PutObjectTaggingRequest.Builder	bucket(String bucket) The bucket name containing the object.
PutObjectTaggingRequest.Builder	contentMD5(String contentMD5) The MD5 hash for the request body.
PutObjectTaggingRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
PutObjectTaggingRequest.Builder	key(String key) Name of the object key.
PutObjectTaggingRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutObjectTaggingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutObjectTaggingRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
PutObjectTaggingRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
default PutObjectTaggingRequest.Builder	tagging(Consumer<Tagging.Builder> tagging) Container for the TagSet and Tag elements
PutObjectTaggingRequest.Builder	tagging(Tagging tagging) Container for the TagSet and Tag elements
PutObjectTaggingRequest.Builder	versionId(String versionId) The versionId of the object that the tag-set will be added to.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

bucket

PutObjectTaggingRequest.Builder bucket(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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Parameters:

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 AWS 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

key

PutObjectTaggingRequest.Builder key(String key)

Name of the object key.

Parameters:

key - Name of the object key.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionId

PutObjectTaggingRequest.Builder versionId(String versionId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

contentMD5

PutObjectTaggingRequest.Builder contentMD5(String contentMD5)

The MD5 hash for the request body.

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

Parameters:

contentMD5 - The MD5 hash for the request body.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tagging

PutObjectTaggingRequest.Builder tagging(Tagging tagging)

Container for the TagSet and Tag elements

Parameters:

tagging - Container for the TagSet and Tag elements

Returns:

Returns a reference to this object so that method calls can be chained together.

tagging

default PutObjectTaggingRequest.Builder tagging(Consumer<Tagging.Builder> tagging)

Container for the TagSet and Tag elements

This is a convenience that creates an instance of the Tagging.Builder avoiding the need to create one manually via Tagging.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagging(Tagging).

Parameters:

tagging - a consumer that will call methods on Tagging.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tagging(Tagging)

expectedBucketOwner

PutObjectTaggingRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestPayer

PutObjectTaggingRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

requestPayer

PutObjectTaggingRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

overrideConfiguration

PutObjectTaggingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutObjectTaggingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder