Class PutLifecycleConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutLifecycleConfigurationRequest.Builder,
PutLifecycleConfigurationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ID of the file system for which you are creating theLifecycleConfiguration
object (String).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LifecyclePolicies property.final List
<LifecyclePolicy> An array ofLifecyclePolicy
objects that define the file system'sLifecycleConfiguration
object.static Class
<? extends PutLifecycleConfigurationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
An array of
LifecyclePolicy
objects that define the file system'sLifecycleConfiguration
object. ALifecycleConfiguration
object informs EFS 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 thePutLifecycleConfiguration
API action, Amazon EFS requires that eachLifecyclePolicy
object have only a single transition. This means that in a request body,LifecyclePolicies
must be structured as an array ofLifecyclePolicy
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'sLifecycleConfiguration
object. ALifecycleConfiguration
object informs EFS 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 thePutLifecycleConfiguration
API action, Amazon EFS requires that eachLifecyclePolicy
object have only a single transition. This means that in a request body,LifecyclePolicies
must be structured as an array ofLifecyclePolicy
objects, one object for each storage transition. See the example requests in the following section for more information. -
-
-
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 interfaceToCopyableBuilder<PutLifecycleConfigurationRequest.Builder,
PutLifecycleConfigurationRequest> - Specified by:
toBuilder
in classEfsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-