Interface RestoreObjectRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RestoreObjectRequest.Builder,
,RestoreObjectRequest> S3Request.Builder
,SdkBuilder<RestoreObjectRequest.Builder,
,RestoreObjectRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RestoreObjectRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe bucket name containing the object to restore.checksumAlgorithm
(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.checksumAlgorithm
(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.expectedBucketOwner
(String expectedBucketOwner) The account ID of the expected bucket owner.Object key for which the action was initiated.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestPayer
(String requestPayer) Sets the value of the RequestPayer property for this object.requestPayer
(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.default RestoreObjectRequest.Builder
restoreRequest
(Consumer<RestoreRequest.Builder> restoreRequest) Sets the value of the RestoreRequest property for this object.restoreRequest
(RestoreRequest restoreRequest) Sets the value of the RestoreRequest property for this object.VersionId used to reference a specific version of the object.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 Details
-
bucket
The bucket name containing the object to restore.
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.- Parameters:
bucket
- The bucket name containing the object to restore.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:
- Returns a reference to this object so that method calls can be chained together.
-
key
Object key for which the action was initiated.
- Parameters:
key
- Object key for which the action was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
VersionId used to reference a specific version of the object.
- Parameters:
versionId
- VersionId used to reference a specific version of the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreRequest
Sets the value of the RestoreRequest property for this object.- Parameters:
restoreRequest
- The new value for the RestoreRequest property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreRequest
default RestoreObjectRequest.Builder restoreRequest(Consumer<RestoreRequest.Builder> restoreRequest) Sets the value of the RestoreRequest property for this object. This is a convenience method that creates an instance of theRestoreRequest.Builder
avoiding the need to create one manually viaRestoreRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torestoreRequest(RestoreRequest)
.- Parameters:
restoreRequest
- a consumer that will call methods onRestoreRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
checksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.- Parameters:
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a correspondingx-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
checksumAlgorithm
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.- Parameters:
checksumAlgorithm
- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a correspondingx-amz-checksum
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
RestoreObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
RestoreObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-