KxVolume (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspace.model.KxVolume

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KxVolume
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The structure that contains the metadata of the volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KxVolume()

Constructors
Constructor and Description
`KxVolume()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KxVolume`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAvailabilityZoneIds()` The identifier of the availability zones.
`String`	`getAzMode()` The number of availability zones you want to assign per volume.
`Date`	`getCreatedTimestamp()` The timestamp at which the volume was created in FinSpace.
`String`	`getDescription()` A description of the volume.
`Date`	`getLastModifiedTimestamp()` The last time that the volume was updated in FinSpace.
`String`	`getStatus()` The status of volume.
`String`	`getStatusReason()` The error message when a failed state occurs.
`String`	`getVolumeName()` A unique identifier for the volume.
`String`	`getVolumeType()` The type of file system volume.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailabilityZoneIds(Collection<String> availabilityZoneIds)` The identifier of the availability zones.
`void`	`setAzMode(String azMode)` The number of availability zones you want to assign per volume.
`void`	`setCreatedTimestamp(Date createdTimestamp)` The timestamp at which the volume was created in FinSpace.
`void`	`setDescription(String description)` A description of the volume.
`void`	`setLastModifiedTimestamp(Date lastModifiedTimestamp)` The last time that the volume was updated in FinSpace.
`void`	`setStatus(String status)` The status of volume.
`void`	`setStatusReason(String statusReason)` The error message when a failed state occurs.
`void`	`setVolumeName(String volumeName)` A unique identifier for the volume.
`void`	`setVolumeType(String volumeType)` The type of file system volume.
`String`	`toString()` Returns a string representation of this object.
`KxVolume`	`withAvailabilityZoneIds(Collection<String> availabilityZoneIds)` The identifier of the availability zones.
`KxVolume`	`withAvailabilityZoneIds(String... availabilityZoneIds)` The identifier of the availability zones.
`KxVolume`	`withAzMode(KxAzMode azMode)` The number of availability zones you want to assign per volume.
`KxVolume`	`withAzMode(String azMode)` The number of availability zones you want to assign per volume.
`KxVolume`	`withCreatedTimestamp(Date createdTimestamp)` The timestamp at which the volume was created in FinSpace.
`KxVolume`	`withDescription(String description)` A description of the volume.
`KxVolume`	`withLastModifiedTimestamp(Date lastModifiedTimestamp)` The last time that the volume was updated in FinSpace.
`KxVolume`	`withStatus(KxVolumeStatus status)` The status of volume.
`KxVolume`	`withStatus(String status)` The status of volume.
`KxVolume`	`withStatusReason(String statusReason)` The error message when a failed state occurs.
`KxVolume`	`withVolumeName(String volumeName)` A unique identifier for the volume.
`KxVolume`	`withVolumeType(KxVolumeType volumeType)` The type of file system volume.
`KxVolume`	`withVolumeType(String volumeType)` The type of file system volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KxVolume
```
public KxVolume()
```
- Method Detail
  - setVolumeName
```
public void setVolumeName(String volumeName)
```
    A unique identifier for the volume.
    
    Parameters:
    
    volumeName - A unique identifier for the volume.
  - getVolumeName
```
public String getVolumeName()
```
    A unique identifier for the volume.
    
    Returns:
    
    A unique identifier for the volume.
  - withVolumeName
```
public KxVolume withVolumeName(String volumeName)
```
    A unique identifier for the volume.
    
    Parameters:
    
    volumeName - A unique identifier for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeType
```
public void setVolumeType(String volumeType)
```
    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Parameters:
    
    volumeType - The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    See Also:
    
    KxVolumeType
  - getVolumeType
```
public String getVolumeType()
```
    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Returns:
    
    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    See Also:
    
    KxVolumeType
  - withVolumeType
```
public KxVolume withVolumeType(String volumeType)
```
    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Parameters:
    
    volumeType - The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxVolumeType
  - withVolumeType
```
public KxVolume withVolumeType(KxVolumeType volumeType)
```
    The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Parameters:
    
    volumeType - The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxVolumeType
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    KxVolumeStatus
  - getStatus
```
public String getStatus()
```
    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.
    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:
    
    KxVolumeStatus
  - withStatus
```
public KxVolume withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxVolumeStatus
  - withStatus
```
public KxVolume withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxVolumeStatus
  - setDescription
```
public void setDescription(String description)
```
    A description of the volume.
    
    Parameters:
    
    description - A description of the volume.
  - getDescription
```
public String getDescription()
```
    A description of the volume.
    
    Returns:
    
    A description of the volume.
  - withDescription
```
public KxVolume withDescription(String description)
```
    A description of the volume.
    
    Parameters:
    
    description - A description of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The error message when a failed state occurs.
    
    Parameters:
    
    statusReason - The error message when a failed state occurs.
  - getStatusReason
```
public String getStatusReason()
```
    The error message when a failed state occurs.
    
    Returns:
    
    The error message when a failed state occurs.
  - withStatusReason
```
public KxVolume withStatusReason(String statusReason)
```
    The error message when a failed state occurs.
    
    Parameters:
    
    statusReason - The error message when a failed state occurs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAzMode
```
public void setAzMode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    KxAzMode
  - getAzMode
```
public String getAzMode()
```
    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.
    
    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:
    
    KxAzMode
  - withAzMode
```
public KxVolume withAzMode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxAzMode
  - withAzMode
```
public KxVolume withAzMode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KxAzMode
  - getAvailabilityZoneIds
```
public List<String> getAvailabilityZoneIds()
```
    The identifier of the availability zones.
    
    Returns:
    
    The identifier of the availability zones.
  - setAvailabilityZoneIds
```
public void setAvailabilityZoneIds(Collection<String> availabilityZoneIds)
```
    The identifier of the availability zones.
    
    Parameters:
    
    availabilityZoneIds - The identifier of the availability zones.
  - withAvailabilityZoneIds
```
public KxVolume withAvailabilityZoneIds(String... availabilityZoneIds)
```
    The identifier of the availability zones.
    
    NOTE: This method appends the values to the existing list (if any). Use setAvailabilityZoneIds(java.util.Collection) or withAvailabilityZoneIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    availabilityZoneIds - The identifier of the availability zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAvailabilityZoneIds
```
public KxVolume withAvailabilityZoneIds(Collection<String> availabilityZoneIds)
```
    The identifier of the availability zones.
    
    Parameters:
    
    availabilityZoneIds - The identifier of the availability zones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date 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.
    
    Parameters:
    
    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.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    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.
  - withCreatedTimestamp
```
public KxVolume withCreatedTimestamp(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTimestamp
```
public void setLastModifiedTimestamp(Date 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.
    
    Parameters:
    
    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.
  - getLastModifiedTimestamp
```
public Date getLastModifiedTimestamp()
```
    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.
  - withLastModifiedTimestamp
```
public KxVolume withLastModifiedTimestamp(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KxVolume clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class KxVolume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KxVolume

Method Detail

setVolumeName

getVolumeName

withVolumeName

setVolumeType

getVolumeType

withVolumeType

withVolumeType

setStatus

getStatus

withStatus

withStatus

setDescription

getDescription

withDescription

setStatusReason

getStatusReason

withStatusReason

setAzMode

getAzMode

withAzMode

withAzMode

getAvailabilityZoneIds

setAvailabilityZoneIds

withAvailabilityZoneIds

withAvailabilityZoneIds

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

setLastModifiedTimestamp

getLastModifiedTimestamp

withLastModifiedTimestamp

toString

equals

hashCode

clone

marshall