Package software.amazon.awssdk.services.fsx.model

Class StorageVirtualMachine

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

Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.

See Also:

  • Method Details

    • activeDirectoryConfiguration

      public final SvmActiveDirectoryConfiguration activeDirectoryConfiguration()

      Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

      Returns:
      Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

    • 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.

    • endpoints

      public final SvmEndpoints endpoints()

      The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

      Returns:
      The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

    • fileSystemId

      public final String fileSystemId()
      Returns the value of the FileSystemId property for this object.
      Returns:
      The value of the FileSystemId property for this object.

    • lifecycle

      public final StorageVirtualMachineLifecycle lifecycle()

      Describes the SVM's lifecycle status.

      • CREATED - The SVM is fully available for use.

      • CREATING - Amazon FSx is creating the new SVM.

      • DELETING - Amazon FSx is deleting an existing SVM.

      • FAILED - Amazon FSx was unable to create the SVM.

      • MISCONFIGURED - The SVM is in a failed but recoverable state.

      • PENDING - Amazon FSx has not started creating the SVM.

      If the service returns an enum value that is not available in the current SDK version, lifecycle will return StorageVirtualMachineLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

      Returns:
      Describes the SVM's lifecycle status.

      • CREATED - The SVM is fully available for use.

      • CREATING - Amazon FSx is creating the new SVM.

      • DELETING - Amazon FSx is deleting an existing SVM.

      • FAILED - Amazon FSx was unable to create the SVM.

      • MISCONFIGURED - The SVM is in a failed but recoverable state.

      • PENDING - Amazon FSx has not started creating the SVM.

      See Also:

    • lifecycleAsString

      public final String lifecycleAsString()

      Describes the SVM's lifecycle status.

      • CREATED - The SVM is fully available for use.

      • CREATING - Amazon FSx is creating the new SVM.

      • DELETING - Amazon FSx is deleting an existing SVM.

      • FAILED - Amazon FSx was unable to create the SVM.

      • MISCONFIGURED - The SVM is in a failed but recoverable state.

      • PENDING - Amazon FSx has not started creating the SVM.

      If the service returns an enum value that is not available in the current SDK version, lifecycle will return StorageVirtualMachineLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

      Returns:
      Describes the SVM's lifecycle status.

      • CREATED - The SVM is fully available for use.

      • CREATING - Amazon FSx is creating the new SVM.

      • DELETING - Amazon FSx is deleting an existing SVM.

      • FAILED - Amazon FSx was unable to create the SVM.

      • MISCONFIGURED - The SVM is in a failed but recoverable state.

      • PENDING - Amazon FSx has not started creating the SVM.

      See Also:

    • name

      public final String name()

      The name of the SVM, if provisioned.

      Returns:
      The name of the SVM, if provisioned.

    • 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.

    • storageVirtualMachineId

      public final String storageVirtualMachineId()

      The SVM's system generated unique ID.

      Returns:
      The SVM's system generated unique ID.

    • subtype

      public final StorageVirtualMachineSubtype subtype()

      Describes the SVM's subtype.

      If the service returns an enum value that is not available in the current SDK version, subtype will return StorageVirtualMachineSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().

      Returns:
      Describes the SVM's subtype.
      See Also:

    • subtypeAsString

      public final String subtypeAsString()

      Describes the SVM's subtype.

      If the service returns an enum value that is not available in the current SDK version, subtype will return StorageVirtualMachineSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().

      Returns:
      Describes the SVM's subtype.
      See Also:

    • uuid

      public final String uuid()

      The SVM's UUID (universally unique identifier).

      Returns:
      The SVM's UUID (universally unique identifier).

    • 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()
      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.

    • lifecycleTransitionReason

      public final LifecycleTransitionReason lifecycleTransitionReason()

      Describes why the SVM lifecycle state changed.

      Returns:
      Describes why the SVM lifecycle state changed.

    • rootVolumeSecurityStyle

      public final StorageVirtualMachineRootVolumeSecurityStyle rootVolumeSecurityStyle()

      The security style of the root volume of the SVM.

      If the service returns an enum value that is not available in the current SDK version, rootVolumeSecurityStyle will return StorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootVolumeSecurityStyleAsString().

      Returns:
      The security style of the root volume of the SVM.
      See Also:

    • rootVolumeSecurityStyleAsString

      public final String rootVolumeSecurityStyleAsString()

      The security style of the root volume of the SVM.

      If the service returns an enum value that is not available in the current SDK version, rootVolumeSecurityStyle will return StorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootVolumeSecurityStyleAsString().

      Returns:
      The security style of the root volume of the SVM.
      See Also:

    • toBuilder

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

    • builder

      public static StorageVirtualMachine.Builder builder()

    • serializableBuilderClass

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