Class FileCacheCreating
- java.lang.Object
-
- software.amazon.awssdk.services.fsx.model.FileCacheCreating
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FileCacheCreating.Builder,FileCacheCreating>
@Generated("software.amazon.awssdk:codegen") public final class FileCacheCreating extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FileCacheCreating.Builder,FileCacheCreating>
The response object for the Amazon File Cache resource being created in the
CreateFileCacheoperation.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFileCacheCreating.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FileCacheCreating.Builderbuilder()BooleancopyTagsToDataRepositoryAssociations()A boolean flag indicating whether tags for the cache should be copied to data repository associations.InstantcreationTime()Returns the value of the CreationTime property for this object.List<String>dataRepositoryAssociationIds()A list of IDs of data repository associations that are associated with this cache.StringdnsName()The Domain Name System (DNS) name for the cache.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FileCacheFailureDetailsfailureDetails()A structure providing details of any failures that occurred in creating a cache.StringfileCacheId()The system-generated, unique ID of the cache.FileCacheTypefileCacheType()The type of cache, which must beLUSTRE.StringfileCacheTypeAsString()The type of cache, which must beLUSTRE.StringfileCacheTypeVersion()The Lustre version of the cache, which must be2.12.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataRepositoryAssociationIds()For responses, this returns true if the service returned a value for the DataRepositoryAssociationIds property.inthashCode()booleanhasNetworkInterfaceIds()For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.booleanhasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringkmsKeyId()Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.FileCacheLifecyclelifecycle()The lifecycle status of the cache.StringlifecycleAsString()The lifecycle status of the cache.FileCacheLustreConfigurationlustreConfiguration()The configuration for the Amazon File Cache resource.List<String>networkInterfaceIds()Returns the value of the NetworkInterfaceIds property for this object.StringownerId()Returns the value of the OwnerId property for this object.StringresourceARN()Returns the value of the ResourceARN property for this object.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends FileCacheCreating.Builder>serializableBuilderClass()IntegerstorageCapacity()The storage capacity of the cache in gibibytes (GiB).List<String>subnetIds()Returns the value of the SubnetIds property for this object.List<Tag>tags()Returns the value of the Tags property for this object.FileCacheCreating.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()Returns the value of the VpcId property for 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
-
ownerId
public final String ownerId()
Returns the value of the OwnerId property for this object.- Returns:
- The value of the OwnerId property for this object.
-
creationTime
public final Instant creationTime()
Returns the value of the CreationTime property for this object.- Returns:
- The value of the CreationTime property for this object.
-
fileCacheId
public final String fileCacheId()
The system-generated, unique ID of the cache.
- Returns:
- The system-generated, unique ID of the cache.
-
fileCacheType
public final FileCacheType fileCacheType()
The type of cache, which must be
LUSTRE.If the service returns an enum value that is not available in the current SDK version,
fileCacheTypewill returnFileCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileCacheTypeAsString().- Returns:
- The type of cache, which must be
LUSTRE. - See Also:
FileCacheType
-
fileCacheTypeAsString
public final String fileCacheTypeAsString()
The type of cache, which must be
LUSTRE.If the service returns an enum value that is not available in the current SDK version,
fileCacheTypewill returnFileCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileCacheTypeAsString().- Returns:
- The type of cache, which must be
LUSTRE. - See Also:
FileCacheType
-
fileCacheTypeVersion
public final String fileCacheTypeVersion()
The Lustre version of the cache, which must be
2.12.- Returns:
- The Lustre version of the cache, which must be
2.12.
-
lifecycle
public final FileCacheLifecycle lifecycle()
The lifecycle status of the cache. The following are the possible values and what they mean:
-
AVAILABLE- The cache is in a healthy state, and is reachable and available for use. -
CREATING- The new cache is being created. -
DELETING- An existing cache is being deleted. -
UPDATING- The cache is undergoing a customer-initiated update. -
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
If the service returns an enum value that is not available in the current SDK version,
lifecyclewill returnFileCacheLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleAsString().- Returns:
- The lifecycle status of the cache. The following are the possible values and what they mean:
-
AVAILABLE- The cache is in a healthy state, and is reachable and available for use. -
CREATING- The new cache is being created. -
DELETING- An existing cache is being deleted. -
UPDATING- The cache is undergoing a customer-initiated update. -
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
-
- See Also:
FileCacheLifecycle
-
-
lifecycleAsString
public final String lifecycleAsString()
The lifecycle status of the cache. The following are the possible values and what they mean:
-
AVAILABLE- The cache is in a healthy state, and is reachable and available for use. -
CREATING- The new cache is being created. -
DELETING- An existing cache is being deleted. -
UPDATING- The cache is undergoing a customer-initiated update. -
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
If the service returns an enum value that is not available in the current SDK version,
lifecyclewill returnFileCacheLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleAsString().- Returns:
- The lifecycle status of the cache. The following are the possible values and what they mean:
-
AVAILABLE- The cache is in a healthy state, and is reachable and available for use. -
CREATING- The new cache is being created. -
DELETING- An existing cache is being deleted. -
UPDATING- The cache is undergoing a customer-initiated update. -
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
-
- See Also:
FileCacheLifecycle
-
-
failureDetails
public final FileCacheFailureDetails failureDetails()
A structure providing details of any failures that occurred in creating a cache.
- Returns:
- A structure providing details of any failures that occurred in creating a cache.
-
storageCapacity
public final Integer storageCapacity()
The storage capacity of the cache in gibibytes (GiB).
- Returns:
- The storage capacity of the cache in gibibytes (GiB).
-
vpcId
public final String vpcId()
Returns the value of the VpcId property for this object.- Returns:
- The value of the VpcId property for this object.
-
hasSubnetIds
public final boolean hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds 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.
-
subnetIds
public final List<String> subnetIds()
Returns the value of the SubnetIds property for this object.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
hasSubnetIds()method.- Returns:
- The value of the SubnetIds property for this object.
-
hasNetworkInterfaceIds
public final boolean hasNetworkInterfaceIds()
For responses, this returns true if the service returned a value for the NetworkInterfaceIds 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.
-
networkInterfaceIds
public final List<String> networkInterfaceIds()
Returns the value of the NetworkInterfaceIds property for this object.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
hasNetworkInterfaceIds()method.- Returns:
- The value of the NetworkInterfaceIds property for this object.
-
dnsName
public final String dnsName()
The Domain Name System (DNS) name for the cache.
- Returns:
- The Domain Name System (DNS) name for the cache.
-
kmsKeyId
public final String kmsKeyId()
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyIdisn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.- Returns:
- Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File
Cache. If a
KmsKeyIdisn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
-
resourceARN
public final String resourceARN()
Returns the value of the ResourceARN property for this object.- Returns:
- The value of the ResourceARN property for this object.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
Returns the value of the Tags property for this object.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
hasTags()method.- Returns:
- The value of the Tags property for this object.
-
copyTagsToDataRepositoryAssociations
public final Boolean copyTagsToDataRepositoryAssociations()
A boolean flag indicating whether tags for the cache should be copied to data repository associations.
- Returns:
- A boolean flag indicating whether tags for the cache should be copied to data repository associations.
-
lustreConfiguration
public final FileCacheLustreConfiguration lustreConfiguration()
The configuration for the Amazon File Cache resource.
- Returns:
- The configuration for the Amazon File Cache resource.
-
hasDataRepositoryAssociationIds
public final boolean hasDataRepositoryAssociationIds()
For responses, this returns true if the service returned a value for the DataRepositoryAssociationIds 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.
-
dataRepositoryAssociationIds
public final List<String> dataRepositoryAssociationIds()
A list of IDs of data repository associations that are associated with this cache.
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
hasDataRepositoryAssociationIds()method.- Returns:
- A list of IDs of data repository associations that are associated with this cache.
-
toBuilder
public FileCacheCreating.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FileCacheCreating.Builder,FileCacheCreating>
-
builder
public static FileCacheCreating.Builder builder()
-
serializableBuilderClass
public static Class<? extends FileCacheCreating.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-