Package software.amazon.awssdk.services.s3.model

Interface RestoreRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RestoreRequest.Builder,RestoreRequest>, SdkBuilder<RestoreRequest.Builder,RestoreRequest>, SdkPojo

Enclosing class:

RestoreRequest

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

Method Summary

Modifier and Type	Method	Description
RestoreRequest.Builder	days(Integer days)	Lifetime of the active copy in days.
RestoreRequest.Builder	description(String description)	The optional description for the job.
default RestoreRequest.Builder	glacierJobParameters(Consumer<GlacierJobParameters.Builder> glacierJobParameters)	S3 Glacier related parameters pertaining to this job.
RestoreRequest.Builder	glacierJobParameters(GlacierJobParameters glacierJobParameters)	S3 Glacier related parameters pertaining to this job.
default RestoreRequest.Builder	outputLocation(Consumer<OutputLocation.Builder> outputLocation)	Describes the location where the restore job's output is stored.
RestoreRequest.Builder	outputLocation(OutputLocation outputLocation)	Describes the location where the restore job's output is stored.
default RestoreRequest.Builder	selectParameters(Consumer<SelectParameters.Builder> selectParameters)
RestoreRequest.Builder	selectParameters(SelectParameters selectParameters)
RestoreRequest.Builder	tier(String tier)	Retrieval tier at which the restore will be processed.
RestoreRequest.Builder	tier(Tier tier)	Retrieval tier at which the restore will be processed.
RestoreRequest.Builder	type(String type)
RestoreRequest.Builder	type(RestoreRequestType type)

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

days

RestoreRequest.Builder days(Integer days)

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

Parameters:

days - Lifetime of the active copy in days. Do not use with restores that specify OutputLocation .

The Days element is required for regular restores, and must not be provided for select requests.

Returns:

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

glacierJobParameters

RestoreRequest.Builder glacierJobParameters(GlacierJobParameters glacierJobParameters)

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Parameters:

glacierJobParameters - S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

Returns:

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

glacierJobParameters

default RestoreRequest.Builder glacierJobParameters(Consumer<GlacierJobParameters.Builder> glacierJobParameters)

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

This is a convenience method that creates an instance of the GlacierJobParameters.Builder avoiding the need to create one manually via GlacierJobParameters.builder().

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

Parameters:

glacierJobParameters - a consumer that will call methods on GlacierJobParameters.Builder

Returns:

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

See Also:

glacierJobParameters(GlacierJobParameters)

type

RestoreRequest.Builder type(String type)

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Type of restore request.

Parameters:

type -

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Type of restore request.

Returns:

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

See Also:

RestoreRequestType, RestoreRequestType

type

RestoreRequest.Builder type(RestoreRequestType type)

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Type of restore request.

Parameters:

type -

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Type of restore request.

Returns:

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

See Also:

RestoreRequestType, RestoreRequestType

tier

RestoreRequest.Builder tier(String tier)

Retrieval tier at which the restore will be processed.

Parameters:

tier - Retrieval tier at which the restore will be processed.

Returns:

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

See Also:

Tier, Tier

tier

RestoreRequest.Builder tier(Tier tier)

Retrieval tier at which the restore will be processed.

Parameters:

tier - Retrieval tier at which the restore will be processed.

Returns:

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

See Also:

Tier, Tier

description

RestoreRequest.Builder description(String description)

The optional description for the job.

Parameters:

description - The optional description for the job.

Returns:

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

selectParameters

RestoreRequest.Builder selectParameters(SelectParameters selectParameters)

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Describes the parameters for Select job types.

Parameters:

selectParameters -

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Describes the parameters for Select job types.

Returns:

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

selectParameters

default RestoreRequest.Builder selectParameters(Consumer<SelectParameters.Builder> selectParameters)

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Describes the parameters for Select job types.

This is a convenience method that creates an instance of the SelectParameters.Builder avoiding the need to create one manually via SelectParameters.builder().

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

Parameters:

selectParameters - a consumer that will call methods on SelectParameters.Builder

Returns:

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

See Also:

selectParameters(SelectParameters)

outputLocation

RestoreRequest.Builder outputLocation(OutputLocation outputLocation)

Describes the location where the restore job's output is stored.

Parameters:

outputLocation - Describes the location where the restore job's output is stored.

Returns:

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

outputLocation

default RestoreRequest.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation)

Describes the location where the restore job's output is stored.

This is a convenience method that creates an instance of the OutputLocation.Builder avoiding the need to create one manually via OutputLocation.builder().

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

Parameters:

outputLocation - a consumer that will call methods on OutputLocation.Builder

Returns:

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

See Also:

outputLocation(OutputLocation)