Class GetObjectAttributesRequest
- 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.GetObjectAttributesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetObjectAttributesRequest extends S3Request implements ToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetObjectAttributesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
bucket()
The name of the bucket that contains the object.static GetObjectAttributesRequest.Builder
builder()
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()
boolean
hasObjectAttributes()
For responses, this returns true if the service returned a value for the ObjectAttributes property.String
key()
The object key.Integer
maxParts()
Sets the maximum number of parts to return.List<ObjectAttributes>
objectAttributes()
Specifies the fields at the root level that you want returned in the response.List<String>
objectAttributesAsStrings()
Specifies the fields at the root level that you want returned in the response.Integer
partNumberMarker()
Specifies the part after which listing should begin.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 GetObjectAttributesRequest.Builder>
serializableBuilderClass()
String
sseCustomerAlgorithm()
Specifies the algorithm to use when encrypting the object (for example, AES256).String
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.String
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.GetObjectAttributesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionId()
The version ID used to reference a specific version of the object.-
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 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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.- Returns:
- 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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
-
key
public final String key()
The object key.
- Returns:
- The object key.
-
versionId
public final 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 specifynull
to theversionId
query parameter in the request.- Returns:
- 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 specifynull
to theversionId
query parameter in the request.
-
maxParts
public final Integer maxParts()
Sets the maximum number of parts to return.
- Returns:
- Sets the maximum number of parts to return.
-
partNumberMarker
public final Integer partNumberMarker()
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
- Returns:
- Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
-
sseCustomerAlgorithm
public final String sseCustomerAlgorithm()
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- Returns:
- Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
-
sseCustomerKey
public final 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.
- Returns:
- 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.
-
sseCustomerKeyMD5
public final 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.
- Returns:
- 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.
-
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 returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- 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 returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
expectedBucketOwner
public final 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).- Returns:
- 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).
-
objectAttributes
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasObjectAttributes()
method.- Returns:
- Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
-
hasObjectAttributes
public final boolean hasObjectAttributes()
For responses, this returns true if the service returned a value for the ObjectAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
objectAttributesAsStrings
public final List<String> objectAttributesAsStrings()
Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasObjectAttributes()
method.- Returns:
- Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
-
toBuilder
public GetObjectAttributesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetObjectAttributesRequest.Builder,GetObjectAttributesRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static GetObjectAttributesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetObjectAttributesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-