Class KxVolume

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

The structure that contains the metadata of the volume.

See Also:

  • Method Details

    • volumeName

      public final String volumeName()

      A unique identifier for the volume.

      Returns:
      A unique identifier for the volume.

    • volumeType

      public final KxVolumeType volumeType()

      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

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

      Returns:
      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
      See Also:

    • volumeTypeAsString

      public final String volumeTypeAsString()

      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

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

      Returns:
      The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
      See Also:

    • status

      public final KxVolumeStatus status()

      The status of volume.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

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

      Returns:
      The status of volume.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of volume.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

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

      Returns:
      The status of volume.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

      See Also:

    • description

      public final String description()

      A description of the volume.

      Returns:
      A description of the volume.

    • statusReason

      public final String statusReason()

      The error message when a failed state occurs.

      Returns:
      The error message when a failed state occurs.

    • azMode

      public final KxAzMode azMode()

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

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

      Returns:
      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
      See Also:

    • azModeAsString

      public final String azModeAsString()

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

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

      Returns:
      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
      See Also:

    • hasAvailabilityZoneIds

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

    • availabilityZoneIds

      public final List<String> availabilityZoneIds()

      The identifier of the availability zones.

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

      Returns:
      The identifier of the availability zones.

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • lastModifiedTimestamp

      public final Instant lastModifiedTimestamp()

      The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • toBuilder

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

    • builder

      public static KxVolume.Builder builder()

    • serializableBuilderClass

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