com.ibm.cos.v2.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

@Mutable
 @NotThreadSafe
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)
GetObjectTaggingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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 com.ibm.cos.v2.services.s3.model.S3Request.Builder

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.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.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Parameters:

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

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is 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

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

Parameters:

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:

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder