Class GetObjectTaggingRequest
- 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.GetObjectTaggingRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetObjectTaggingRequest.Builder,GetObjectTaggingRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetObjectTaggingRequest extends S3Request implements ToCopyableBuilder<GetObjectTaggingRequest.Builder,GetObjectTaggingRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetObjectTaggingRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
bucket()
The bucket name containing the object for which to get the tagging information.static GetObjectTaggingRequest.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()
String
key()
Object key for which to get the tagging information.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 GetObjectTaggingRequest.Builder>
serializableBuilderClass()
GetObjectTaggingRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionId()
The versionId of the object for which to get the tagging information.-
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 bucket name containing the object for which to get the tagging information.
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.
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 bucket name containing the object for which to get the tagging information.
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.
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()
Object key for which to get the tagging information.
- Returns:
- Object key for which to get the tagging information.
-
versionId
public final String versionId()
The versionId of the object for which to get the tagging information.
- Returns:
- The versionId of the object for which to get the tagging information.
-
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).
-
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
-
toBuilder
public GetObjectTaggingRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetObjectTaggingRequest.Builder,GetObjectTaggingRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static GetObjectTaggingRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetObjectTaggingRequest.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
-
-