Interface GetObjectRetentionRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetObjectRetentionRequest.Builder,GetObjectRetentionRequest>
,S3Request.Builder
,SdkBuilder<GetObjectRetentionRequest.Builder,GetObjectRetentionRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- GetObjectRetentionRequest
public static interface GetObjectRetentionRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<GetObjectRetentionRequest.Builder,GetObjectRetentionRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetObjectRetentionRequest.Builder
bucket(String bucket)
The bucket name containing the object whose retention settings you want to retrieve.GetObjectRetentionRequest.Builder
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.GetObjectRetentionRequest.Builder
key(String key)
The key name for the object whose retention settings you want to retrieve.GetObjectRetentionRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetObjectRetentionRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetObjectRetentionRequest.Builder
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.GetObjectRetentionRequest.Builder
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.GetObjectRetentionRequest.Builder
versionId(String versionId)
The version ID for the object whose retention settings you want to retrieve.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
bucket
GetObjectRetentionRequest.Builder bucket(String bucket)
The bucket name containing the object whose retention settings you want to retrieve.
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.
- Parameters:
bucket
- The bucket name containing the object whose retention settings you want to retrieve.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
key
GetObjectRetentionRequest.Builder key(String key)
The key name for the object whose retention settings you want to retrieve.
- Parameters:
key
- The key name for the object whose retention settings you want to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
GetObjectRetentionRequest.Builder versionId(String versionId)
The version ID for the object whose retention settings you want to retrieve.
- Parameters:
versionId
- The version ID for the object whose retention settings you want to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestPayer
GetObjectRetentionRequest.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
GetObjectRetentionRequest.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
GetObjectRetentionRequest.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 code403 Forbidden
(access denied).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetObjectRetentionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
GetObjectRetentionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-