software.amazon.awssdk.services.s3.model

Class RestoreRequest

java.lang.Object

software.amazon.awssdk.services.s3.model.RestoreRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RestoreRequest.Builder,RestoreRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RestoreRequest.Builder,RestoreRequest>

Container for restore job parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestoreRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RestoreRequest.Builder	builder()
Integer	days() Lifetime of the active copy in days.
String	description() The optional description for the job.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GlacierJobParameters	glacierJobParameters() Glacier related parameters pertaining to this job.
int	hashCode()
OutputLocation	outputLocation() Describes the location where the restore job's output is stored.
List<SdkField<?>>	sdkFields()
SelectParameters	selectParameters() Describes the parameters for Select job types.
static Class<? extends RestoreRequest.Builder>	serializableBuilderClass()
Tier	tier() Glacier retrieval tier at which the restore will be processed.
String	tierAsString() Glacier retrieval tier at which the restore will be processed.
RestoreRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
RestoreRequestType	type() Type of restore request.
String	typeAsString() Type of restore request.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

days

public Integer days()

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

Returns:

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

glacierJobParameters

public GlacierJobParameters glacierJobParameters()

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

Returns:

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

type

public RestoreRequestType type()

Type of restore request.

If the service returns an enum value that is not available in the current SDK version, type will return RestoreRequestType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Type of restore request.

See Also:

RestoreRequestType

typeAsString

public String typeAsString()

Type of restore request.

If the service returns an enum value that is not available in the current SDK version, type will return RestoreRequestType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Type of restore request.

See Also:

RestoreRequestType

tier

public Tier tier()

Glacier retrieval tier at which the restore will be processed.

If the service returns an enum value that is not available in the current SDK version, tier will return Tier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

Returns:

Glacier retrieval tier at which the restore will be processed.

See Also:

Tier

tierAsString

public String tierAsString()

Glacier retrieval tier at which the restore will be processed.

If the service returns an enum value that is not available in the current SDK version, tier will return Tier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

Returns:

Glacier retrieval tier at which the restore will be processed.

See Also:

Tier

description

public String description()

The optional description for the job.

Returns:

The optional description for the job.

selectParameters

public SelectParameters selectParameters()

Describes the parameters for Select job types.

Returns:

Describes the parameters for Select job types.

outputLocation

public OutputLocation outputLocation()

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

Returns:

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

toBuilder

public RestoreRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RestoreRequest.Builder,RestoreRequest>

Returns:

a builder for type T

builder

public static RestoreRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RestoreRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.