Package software.amazon.awssdk.services.efs.model

Class PutLifecycleConfigurationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.efs.model.EfsRequest

software.amazon.awssdk.services.efs.model.PutLifecycleConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutLifecycleConfigurationRequest
extends EfsRequest
implements ToCopyableBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutLifecycleConfigurationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutLifecycleConfigurationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId()	The ID of the file system for which you are creating the LifecycleConfiguration object (String).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLifecyclePolicies()	For responses, this returns true if the service returned a value for the LifecyclePolicies property.
List<LifecyclePolicy>	lifecyclePolicies()	An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutLifecycleConfigurationRequest.Builder>	serializableBuilderClass()
PutLifecycleConfigurationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

fileSystemId

public final String fileSystemId()

The ID of the file system for which you are creating the LifecycleConfiguration object (String).

Returns:

The ID of the file system for which you are creating the LifecycleConfiguration object (String).

hasLifecyclePolicies

public final boolean hasLifecyclePolicies()

For responses, this returns true if the service returned a value for the LifecyclePolicies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

lifecyclePolicies

public final List<LifecyclePolicy> lifecyclePolicies()

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs lifecycle management of the following:

• TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

• TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

  File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

  The Archive storage class is available only for file systems that use the Elastic throughput mode and the General Purpose performance mode.

• TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLifecyclePolicies() method.

Returns:

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs lifecycle management of the following:

• TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

• TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

  File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

  The Archive storage class is available only for file systems that use the Elastic throughput mode and the General Purpose performance mode.

• TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

toBuilder

public PutLifecycleConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>

Specified by:

toBuilder in class EfsRequest

builder

public static PutLifecycleConfigurationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo