Package software.amazon.awssdk.services.s3control.model

Class S3InitiateRestoreObjectOperation

java.lang.Object

software.amazon.awssdk.services.s3control.model.S3InitiateRestoreObjectOperation

All Implemented Interfaces:

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

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

Contains the configuration parameters for a POST Object restore job. S3 Batch Operations passes every object to the underlying RestoreObject API operation. For more information about the parameters for this operation, see RestoreObject.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3InitiateRestoreObjectOperation.Builder

Method Summary

Modifier and Type	Method	Description
static S3InitiateRestoreObjectOperation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expirationInDays()	This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
S3GlacierJobTier	glacierJobTier()	S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
String	glacierJobTierAsString()	S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends S3InitiateRestoreObjectOperation.Builder>	serializableBuilderClass()
S3InitiateRestoreObjectOperation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

expirationInDays

public final Integer expirationInDays()

This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

Returns:

This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

glacierJobTier

public final S3GlacierJobTier glacierJobTier()

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

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

Returns:

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

See Also:

S3GlacierJobTier

glacierJobTierAsString

public final String glacierJobTierAsString()

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

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

Returns:

S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

See Also:

S3GlacierJobTier

toBuilder

public S3InitiateRestoreObjectOperation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3InitiateRestoreObjectOperation.Builder,S3InitiateRestoreObjectOperation>

builder

public static S3InitiateRestoreObjectOperation.Builder builder()

serializableBuilderClass

public static Class<? extends S3InitiateRestoreObjectOperation.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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