Class AssociateFileSystemRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AssociateFileSystemRequest.Builder,AssociateFileSystemRequest>

@Generated("software.amazon.awssdk:codegen") public final class AssociateFileSystemRequest extends StorageGatewayRequest implements ToCopyableBuilder<AssociateFileSystemRequest.Builder,AssociateFileSystemRequest>
  • Method Details

    • userName

      public final String userName()

      The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

      Returns:
      The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    • password

      public final String password()

      The password of the user credential.

      Returns:
      The password of the user credential.
    • clientToken

      public final String clientToken()

      A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

      Returns:
      A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
    • 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.
    • locationARN

      public final String locationARN()

      The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    • 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 that can be assigned to the file system association. 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 that can be assigned to the file system association. Each tag is a key-value pair.
    • 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.
    • 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 the 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 the 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.

    • 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<AssociateFileSystemRequest.Builder,AssociateFileSystemRequest>
      Specified by:
      toBuilder in class StorageGatewayRequest
      Returns:
      a builder for type T
    • builder

      public static AssociateFileSystemRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AssociateFileSystemRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.