software.amazon.awssdk.services.s3.model

Interface GetObjectTaggingRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetObjectTaggingRequest

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

Method Summary

Modifier and Type	Method and Description
GetObjectTaggingRequest.Builder	bucket(String bucket) The bucket name containing the object for which to get the tagging information.
GetObjectTaggingRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account id of the expected bucket owner.
GetObjectTaggingRequest.Builder	key(String key) Object key for which to get the tagging information.
GetObjectTaggingRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetObjectTaggingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetObjectTaggingRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectTaggingRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectTaggingRequest.Builder	versionId(String versionId) The versionId of the object for which to get the tagging information.

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

GetObjectTaggingRequest.Builder bucket(String bucket)

The bucket name containing the object for which to get the tagging information.

When using this API 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 operation 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 Simple Storage Service Developer Guide.

When using this API 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 operation 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 Simple Storage Service Developer Guide.

Parameters:

bucket - The bucket name containing the object for which to get the tagging information.

When using this API 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 operation 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 Simple Storage Service Developer Guide.

When using this API 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 operation 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 Simple Storage Service Developer Guide.

Returns:

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

key

GetObjectTaggingRequest.Builder key(String key)

Object key for which to get the tagging information.

Parameters:

key - Object key for which to get the tagging information.

Returns:

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

versionId

GetObjectTaggingRequest.Builder versionId(String versionId)

The versionId of the object for which to get the tagging information.

Parameters:

versionId - The versionId of the object for which to get the tagging information.

Returns:

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

expectedBucketOwner

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

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

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

GetObjectTaggingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.