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

Interface RestoreObjectRequest.Builder

All Superinterfaces:

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

Enclosing class:

RestoreObjectRequest

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

Method Summary

Modifier and Type	Method and Description
RestoreObjectRequest.Builder	bucket(String bucket) The bucket name containing the object to restore.
RestoreObjectRequest.Builder	checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.
RestoreObjectRequest.Builder	checksumAlgorithm(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.
RestoreObjectRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
RestoreObjectRequest.Builder	key(String key) Object key for which the action was initiated.
RestoreObjectRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
RestoreObjectRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
RestoreObjectRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
RestoreObjectRequest.Builder	requestPayer(String 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.
RestoreObjectRequest.Builder	restoreRequest(RestoreRequest restoreRequest) Sets the value of the RestoreRequest property for this object.
RestoreObjectRequest.Builder	versionId(String versionId) VersionId 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

RestoreObjectRequest.Builder bucket(String bucket)

The bucket name containing the object to restore.

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.

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 bucket name containing the object to restore.

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.

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

RestoreObjectRequest.Builder key(String 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

RestoreObjectRequest.Builder versionId(String 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

RestoreObjectRequest.Builder restoreRequest(RestoreRequest 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 the RestoreRequest.Builder avoiding the need to create one manually via RestoreRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to restoreRequest(RestoreRequest).

Parameters:

restoreRequest - a consumer that will call methods on RestoreRequest.Builder

Returns:

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

See Also:

restoreRequest(RestoreRequest)

requestPayer

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

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

checksumAlgorithm

RestoreObjectRequest.Builder checksumAlgorithm(String 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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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 corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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, ChecksumAlgorithm

checksumAlgorithm

RestoreObjectRequest.Builder checksumAlgorithm(ChecksumAlgorithm 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 or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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 corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 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, ChecksumAlgorithm

expectedBucketOwner

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

overrideConfiguration

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

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