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

Class RestoreRequest

java.lang.Object

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

All Implemented Interfaces:

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

@Generated(value="com.ibm.cos.v2: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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GlacierJobParameters	glacierJobParameters() S3 Glacier related parameters pertaining to this job.
int	hashCode()
OutputLocation	outputLocation() Describes the location where the restore job's output is stored.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SelectParameters	selectParameters()
static Class<? extends RestoreRequest.Builder>	serializableBuilderClass()
Tier	tier() Retrieval tier at which the restore will be processed.
String	tierAsString() 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() Returns a string representation of this object.
RestoreRequestType	type()
String	typeAsString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

days

public final 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.

Returns:

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.

glacierJobParameters

public final GlacierJobParameters glacierJobParameters()

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

Returns:

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

type

public final 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.

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:

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.

See Also:

RestoreRequestType

typeAsString

public final String typeAsString()

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.

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:

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.

See Also:

RestoreRequestType

tier

public final Tier tier()

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:

Retrieval tier at which the restore will be processed.

See Also:

Tier

tierAsString

public final String tierAsString()

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:

Retrieval tier at which the restore will be processed.

See Also:

Tier

description

public final String description()

The optional description for the job.

Returns:

The optional description for the job.

selectParameters

public final 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.

Returns:

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.

outputLocation

public final 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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final 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.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.