Interface RestoreRequest.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RestoreRequest.Builder,
,RestoreRequest> SdkBuilder<RestoreRequest.Builder,
,RestoreRequest> SdkPojo
- Enclosing class:
RestoreRequest
-
Method Summary
Modifier and TypeMethodDescriptionLifetime of the active copy in days.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.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.outputLocation
(OutputLocation outputLocation) Describes the location where the restore job's output is stored.default RestoreRequest.Builder
selectParameters
(Consumer<SelectParameters.Builder> selectParameters) Describes the parameters for Select job types.selectParameters
(SelectParameters selectParameters) Describes the parameters for Select job types.Retrieval tier at which the restore will be processed.Retrieval tier at which the restore will be processed.Type of restore request.type
(RestoreRequestType type) Type of restore request.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, sdkFields
-
Method Details
-
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 specifyOutputLocation
.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
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 specifyOutputLocation
.- 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
This is a convenience method that creates an instance of theOutputLocation
.GlacierJobParameters.Builder
avoiding the need to create one manually viaGlacierJobParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toglacierJobParameters(GlacierJobParameters)
.- Parameters:
glacierJobParameters
- a consumer that will call methods onGlacierJobParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
Type of restore request.
- Parameters:
type
- Type of restore request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
Type of restore request.
- Parameters:
type
- Type of restore request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
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
Describes the parameters for Select job types.
- Parameters:
selectParameters
- 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) Describes the parameters for Select job types.
This is a convenience method that creates an instance of theSelectParameters.Builder
avoiding the need to create one manually viaSelectParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselectParameters(SelectParameters)
.- Parameters:
selectParameters
- a consumer that will call methods onSelectParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Describes the location where the restore job's output is stored.
This is a convenience method that creates an instance of theOutputLocation.Builder
avoiding the need to create one manually viaOutputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputLocation(OutputLocation)
.- Parameters:
outputLocation
- a consumer that will call methods onOutputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-