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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStorageVirtualMachine.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SvmActiveDirectoryConfigurationactiveDirectoryConfiguration()Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.static StorageVirtualMachine.Builderbuilder()InstantcreationTime()Returns the value of the CreationTime property for this object.SvmEndpointsendpoints()The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfileSystemId()Returns the value of the FileSystemId property for this object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StorageVirtualMachineLifecyclelifecycle()Describes the SVM's lifecycle status.StringlifecycleAsString()Describes the SVM's lifecycle status.LifecycleTransitionReasonlifecycleTransitionReason()Describes why the SVM lifecycle state changed.Stringname()The name of the SVM, if provisioned.StringresourceARN()Returns the value of the ResourceARN property for this object.StorageVirtualMachineRootVolumeSecurityStylerootVolumeSecurityStyle()The security style of the root volume of the SVM.StringrootVolumeSecurityStyleAsString()The security style of the root volume of the SVM.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends StorageVirtualMachine.Builder>serializableBuilderClass()StringstorageVirtualMachineId()The SVM's system generated unique ID.StorageVirtualMachineSubtypesubtype()Describes the SVM's subtype.StringsubtypeAsString()Describes the SVM's subtype.List<Tag>tags()Returns the value of the Tags property for this object.StorageVirtualMachine.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringuuid()The SVM's UUID (universally unique identifier).-
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
-
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, andSmbendpoints.- 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, andSmbendpoints.
-
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,
lifecyclewill returnStorageVirtualMachineLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleAsString().- 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:
StorageVirtualMachineLifecycle
-
-
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,
lifecyclewill returnStorageVirtualMachineLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleAsString().- 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:
StorageVirtualMachineLifecycle
-
-
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,
subtypewill returnStorageVirtualMachineSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubtypeAsString().- Returns:
- Describes the SVM's subtype.
- See Also:
StorageVirtualMachineSubtype
-
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,
subtypewill returnStorageVirtualMachineSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubtypeAsString().- Returns:
- Describes the SVM's subtype.
- See Also:
StorageVirtualMachineSubtype
-
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 theisEmpty()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,
rootVolumeSecurityStylewill returnStorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrootVolumeSecurityStyleAsString().- Returns:
- The security style of the root volume of the SVM.
- See Also:
StorageVirtualMachineRootVolumeSecurityStyle
-
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,
rootVolumeSecurityStylewill returnStorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrootVolumeSecurityStyleAsString().- Returns:
- The security style of the root volume of the SVM.
- See Also:
StorageVirtualMachineRootVolumeSecurityStyle
-
toBuilder
public StorageVirtualMachine.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StorageVirtualMachine.Builder,StorageVirtualMachine>
-
builder
public static StorageVirtualMachine.Builder builder()
-
serializableBuilderClass
public static Class<? extends StorageVirtualMachine.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-