Class FileSystemAssociationInfo

java.lang.Object
software.amazon.awssdk.services.storagegateway.model.FileSystemAssociationInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FileSystemAssociationInfo.Builder,FileSystemAssociationInfo>
@Generated("software.amazon.awssdk:codegen") public final class FileSystemAssociationInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FileSystemAssociationInfo.Builder,FileSystemAssociationInfo>

Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.

See Also:

  • Method Details

    • fileSystemAssociationARN

      public final String fileSystemAssociationARN()

      The Amazon Resource Name (ARN) of the file system association.

      Returns:
      The Amazon Resource Name (ARN) of the file system association.

    • locationARN

      public final String locationARN()

      The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.

      Returns:
      The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.

    • fileSystemAssociationStatus

      public final String fileSystemAssociationStatus()

      The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

      Returns:
      The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

    • auditDestinationARN

      public final String auditDestinationARN()

      The Amazon Resource Name (ARN) of the storage used for the audit logs.

      Returns:
      The Amazon Resource Name (ARN) of the storage used for the audit logs.

    • gatewayARN

      public final String gatewayARN()
      Returns the value of the GatewayARN property for this object.
      Returns:
      The value of the GatewayARN 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 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.

    • tags

      public final List<Tag> tags()

      A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.

      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:
      A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.

    • cacheAttributes

      public final CacheAttributes cacheAttributes()
      Returns the value of the CacheAttributes property for this object.
      Returns:
      The value of the CacheAttributes property for this object.

    • endpointNetworkConfiguration

      public final EndpointNetworkConfiguration endpointNetworkConfiguration()

      Specifies network configuration information for the gateway associated with the Amazon FSx file system.

      If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

      Returns:
      Specifies network configuration information for the gateway associated with the Amazon FSx file system.

      If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

    • hasFileSystemAssociationStatusDetails

      public final boolean hasFileSystemAssociationStatusDetails()
      For responses, this returns true if the service returned a value for the FileSystemAssociationStatusDetails 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.

    • fileSystemAssociationStatusDetails

      public final List<FileSystemAssociationStatusDetail> fileSystemAssociationStatusDetails()

      An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.

      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 hasFileSystemAssociationStatusDetails() method.

      Returns:
      An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.

    • toBuilder

      public FileSystemAssociationInfo.Builder 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 interface ToCopyableBuilder<FileSystemAssociationInfo.Builder,FileSystemAssociationInfo>
      Returns:
      a builder for type T

    • builder

      public static FileSystemAssociationInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FileSystemAssociationInfo.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.