java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.finspace.model.FinspaceResponse
    - - software.amazon.awssdk.services.finspace.model.GetKxVolumeResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetKxVolumeResponse.Builder,GetKxVolumeResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetKxVolumeResponse
extends FinspaceResponse
implements ToCopyableBuilder<GetKxVolumeResponse.Builder,GetKxVolumeResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetKxVolumeResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<KxAttachedCluster>`	`attachedClusters()`	A list of cluster identifiers that a volume is attached to.
`List<String>`	`availabilityZoneIds()`	The identifier of the availability zones.
`KxAzMode`	`azMode()`	The number of availability zones you want to assign per volume.
`String`	`azModeAsString()`	The number of availability zones you want to assign per volume.
`static GetKxVolumeResponse.Builder`	`builder()`
`Instant`	`createdTimestamp()`	The timestamp at which the volume was created in FinSpace.
`String`	`description()`	A description of the volume.
`String`	`environmentId()`	A unique identifier for the kdb environment, whose clusters can attach to the volume.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachedClusters()`	For responses, this returns true if the service returned a value for the AttachedClusters property.
`boolean`	`hasAvailabilityZoneIds()`	For responses, this returns true if the service returned a value for the AvailabilityZoneIds property.
`int`	`hashCode()`
`Instant`	`lastModifiedTimestamp()`	The last time that the volume was updated in FinSpace.
`KxNAS1Configuration`	`nas1Configuration()`	Specifies the configuration for the Network attached storage (NAS_1) file system volume.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetKxVolumeResponse.Builder>`	`serializableBuilderClass()`
`KxVolumeStatus`	`status()`	The status of volume creation.
`String`	`statusAsString()`	The status of volume creation.
`String`	`statusReason()`	The error message when a failed state occurs.
`GetKxVolumeResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`volumeArn()`	The ARN identifier of the volume.
`String`	`volumeName()`	A unique identifier for the volume.
`KxVolumeType`	`volumeType()`	The type of file system volume.
`String`	`volumeTypeAsString()`	The type of file system volume.

Methods inherited from class software.amazon.awssdk.services.finspace.model.FinspaceResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - environmentId
```
public final String environmentId()
```
    A unique identifier for the kdb environment, whose clusters can attach to the volume.
    
    Returns:
    
    A unique identifier for the kdb environment, whose clusters can attach to the volume.
  - 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:
    
    KxVolumeType
  - 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:
    
    KxVolumeType
  - volumeArn
```
public final String volumeArn()
```
    The ARN identifier of the volume.
    
    Returns:
    
    The ARN identifier of the volume.
  - nas1Configuration
```
public final KxNAS1Configuration nas1Configuration()
```
    Specifies the configuration for the Network attached storage (NAS_1) file system volume.
    
    Returns:
    
    Specifies the configuration for the Network attached storage (NAS_1) file system volume.
  - status
```
public final KxVolumeStatus status()
```
    The status of volume creation.
    
    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 creation.
    
    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
  - statusAsString
```
public final String statusAsString()
```
    The status of volume creation.
    
    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 creation.
    
    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
  - statusReason
```
public final String statusReason()
```
    The error message when a failed state occurs.
    
    Returns:
    
    The error message when a failed state occurs.
  - 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.
  - description
```
public final String description()
```
    A description of the volume.
    
    Returns:
    
    A description of the volume.
  - 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:
    
    KxAzMode
  - 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:
    
    KxAzMode
  - 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.
  - 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.
  - hasAttachedClusters
```
public final boolean hasAttachedClusters()
```
    For responses, this returns true if the service returned a value for the AttachedClusters 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.
  - attachedClusters
```
public final List<KxAttachedCluster> attachedClusters()
```
    A list of cluster identifiers that a volume is attached to.
    
    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 hasAttachedClusters() method.
    
    Returns:
    
    A list of cluster identifiers that a volume is attached to.
  - toBuilder
```
public GetKxVolumeResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetKxVolumeResponse.Builder,GetKxVolumeResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetKxVolumeResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetKxVolumeResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetKxVolumeResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.finspace.model.FinspaceResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

environmentId

volumeName

volumeType

volumeTypeAsString

volumeArn

nas1Configuration

status

statusAsString

statusReason

createdTimestamp

description

azMode

azModeAsString

hasAvailabilityZoneIds

availabilityZoneIds

lastModifiedTimestamp

hasAttachedClusters

attachedClusters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField