com.ibm.cos.v2.services.s3.model

Interface GetObjectAttributesRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetObjectAttributesRequest

@Mutable
 @NotThreadSafe
public static interface GetObjectAttributesRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>

Method Summary

Modifier and Type	Method and Description
GetObjectAttributesRequest.Builder	bucket(String bucket) The name of the bucket that contains the object.
GetObjectAttributesRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
GetObjectAttributesRequest.Builder	key(String key) The object key.
GetObjectAttributesRequest.Builder	maxParts(Integer maxParts) Sets the maximum number of parts to return.
GetObjectAttributesRequest.Builder	objectAttributes(Collection<ObjectAttributes> objectAttributes) Specifies the fields at the root level that you want returned in the response.
GetObjectAttributesRequest.Builder	objectAttributes(ObjectAttributes... objectAttributes) Specifies the fields at the root level that you want returned in the response.
GetObjectAttributesRequest.Builder	objectAttributesWithStrings(Collection<String> objectAttributes) Specifies the fields at the root level that you want returned in the response.
GetObjectAttributesRequest.Builder	objectAttributesWithStrings(String... objectAttributes) Specifies the fields at the root level that you want returned in the response.
GetObjectAttributesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetObjectAttributesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetObjectAttributesRequest.Builder	partNumberMarker(Integer partNumberMarker) Specifies the part after which listing should begin.
GetObjectAttributesRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectAttributesRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectAttributesRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use when encrypting the object (for example, AES256).
GetObjectAttributesRequest.Builder	sseCustomerKey(String sseCustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
GetObjectAttributesRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
GetObjectAttributesRequest.Builder	versionId(String versionId) The version ID used to reference a specific version of the object.

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

GetObjectAttributesRequest.Builder bucket(String bucket)

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

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.

Object Lambda access points are not supported by directory buckets.

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 name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

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.

Object Lambda access points are not supported by directory buckets.

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

GetObjectAttributesRequest.Builder key(String key)

The object key.

Parameters:

key - The object key.

Returns:

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

versionId

GetObjectAttributesRequest.Builder versionId(String versionId)

The version ID used to reference a specific version of the object.

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Parameters:

versionId - The version ID used to reference a specific version of the object.

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Returns:

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

maxParts

GetObjectAttributesRequest.Builder maxParts(Integer maxParts)

Sets the maximum number of parts to return.

Parameters:

maxParts - Sets the maximum number of parts to return.

Returns:

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

partNumberMarker

GetObjectAttributesRequest.Builder partNumberMarker(Integer partNumberMarker)

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Parameters:

partNumberMarker - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Returns:

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

sseCustomerAlgorithm

GetObjectAttributesRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

Returns:

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

sseCustomerKey

GetObjectAttributesRequest.Builder sseCustomerKey(String sseCustomerKey)

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This functionality is not supported for directory buckets.

Returns:

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

sseCustomerKeyMD5

GetObjectAttributesRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

Returns:

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

requestPayer

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

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

expectedBucketOwner

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

objectAttributesWithStrings

GetObjectAttributesRequest.Builder objectAttributesWithStrings(Collection<String> objectAttributes)

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Parameters:

objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Returns:

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

objectAttributesWithStrings

GetObjectAttributesRequest.Builder objectAttributesWithStrings(String... objectAttributes)

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Parameters:

objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Returns:

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

objectAttributes

GetObjectAttributesRequest.Builder objectAttributes(Collection<ObjectAttributes> objectAttributes)

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Parameters:

objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Returns:

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

objectAttributes

GetObjectAttributesRequest.Builder objectAttributes(ObjectAttributes... objectAttributes)

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Parameters:

objectAttributes - Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Returns:

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

overrideConfiguration

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

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