FileCache (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.fsx.model.FileCache

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FileCache.Builder,FileCache>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class FileCache
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FileCache.Builder,FileCache>
```
A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FileCache.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FileCache.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FileCache.Builder`	`builder()`
`Instant`	`creationTime()` 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.
`String`	`dnsName()` The Domain Name System (DNS) name for the cache.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FileCacheFailureDetails`	`failureDetails()` A structure providing details of any failures that occurred.
`String`	`fileCacheId()` The system-generated, unique ID of the cache.
`FileCacheType`	`fileCacheType()` The type of cache, which must be `LUSTRE`.
`String`	`fileCacheTypeAsString()` The type of cache, which must be `LUSTRE`.
`String`	`fileCacheTypeVersion()` The Lustre version of the cache, which must be `2.12`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDataRepositoryAssociationIds()` For responses, this returns true if the service returned a value for the DataRepositoryAssociationIds property.
`int`	`hashCode()`
`boolean`	`hasNetworkInterfaceIds()` For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`String`	`kmsKeyId()` Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.
`FileCacheLifecycle`	`lifecycle()` The lifecycle status of the cache.
`String`	`lifecycleAsString()` The lifecycle status of the cache.
`FileCacheLustreConfiguration`	`lustreConfiguration()` The configuration for the Amazon File Cache resource.
`List<String>`	`networkInterfaceIds()` Returns the value of the NetworkInterfaceIds property for this object.
`String`	`ownerId()` Returns the value of the OwnerId property for this object.
`String`	`resourceARN()` Returns the value of the ResourceARN property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FileCache.Builder>`	`serializableBuilderClass()`
`Integer`	`storageCapacity()` The storage capacity of the cache in gibibytes (GiB).
`List<String>`	`subnetIds()` Returns the value of the SubnetIds property for this object.
`FileCache.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` 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, fileCacheType will return FileCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileCacheTypeAsString().
    
    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, fileCacheType will return FileCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileCacheTypeAsString().
    
    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, lifecycle will return FileCacheLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    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, lifecycle will return FileCacheLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().
    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.
    
    Returns:
    
    A structure providing details of any failures that occurred.
  - 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 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.
  - 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 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.
  - 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 KmsKeyId isn'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 KmsKeyId isn'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.
  - 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 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.
  - 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 FileCache.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FileCache.Builder,FileCache>
  - builder
```
public static FileCache.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FileCache.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

Class FileCache

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

ownerId

creationTime

fileCacheId

fileCacheType

fileCacheTypeAsString

fileCacheTypeVersion

lifecycle

lifecycleAsString

failureDetails

storageCapacity

vpcId

hasSubnetIds

subnetIds

hasNetworkInterfaceIds

networkInterfaceIds

dnsName

kmsKeyId

resourceARN

lustreConfiguration

hasDataRepositoryAssociationIds

dataRepositoryAssociationIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields