Class CreateLocationFsxOntapRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datasync.model.DataSyncRequest
software.amazon.awssdk.services.datasync.model.CreateLocationFsxOntapRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLocationFsxOntapRequest.Builder,CreateLocationFsxOntapRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLocationFsxOntapRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationFsxOntapRequest.Builder,CreateLocationFsxOntapRequest>

  • Method Details

    • protocol

      public final FsxProtocol protocol()
      Returns the value of the Protocol property for this object.
      Returns:
      The value of the Protocol property for this object.

    • hasSecurityGroupArns

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

    • securityGroupArns

      public final List<String> securityGroupArns()

      Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

      • Network File System (NFS): TCP ports 111, 635, and 2049

      • Server Message Block (SMB): TCP port 445

      Your file system's security groups must also allow inbound traffic on the same ports.

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

      Returns:
      Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

      • Network File System (NFS): TCP ports 111, 635, and 2049

      • Server Message Block (SMB): TCP port 445

      Your file system's security groups must also allow inbound traffic on the same ports.

    • storageVirtualMachineArn

      public final String storageVirtualMachineArn()

      Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

      Returns:
      Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.

    • subdirectory

      public final String subdirectory()

      Specifies a path to the file share in the SVM where you'll copy your data.

      You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

      Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

      Returns:
      Specifies a path to the file share in the SVM where you'll copy your data.

      You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

      Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

    • 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<TagListEntry> tags()

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

      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:
      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

    • toBuilder

      public CreateLocationFsxOntapRequest.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<CreateLocationFsxOntapRequest.Builder,CreateLocationFsxOntapRequest>
      Specified by:
      toBuilder in class DataSyncRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLocationFsxOntapRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateLocationFsxOntapRequest.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.