Package software.amazon.awssdk.services.storagegateway.model

Class DescribeWorkingStorageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

software.amazon.awssdk.services.storagegateway.model.DescribeWorkingStorageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWorkingStorageResponse.Builder,DescribeWorkingStorageResponse>

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

A JSON object containing the following fields:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeWorkingStorageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeWorkingStorageResponse.Builder	builder()
List<String>	diskIds()	An array of the gateway's local disk IDs that are configured as working storage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN()	Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDiskIds()	For responses, this returns true if the service returned a value for the DiskIds property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeWorkingStorageResponse.Builder>	serializableBuilderClass()
DescribeWorkingStorageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	workingStorageAllocatedInBytes()	The total working storage in bytes allocated for the gateway.
Long	workingStorageUsedInBytes()	The total working storage in bytes in use by the gateway.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

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

gatewayARN

public final String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

hasDiskIds

public final boolean hasDiskIds()

For responses, this returns true if the service returned a value for the DiskIds 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.

diskIds

public final List<String> diskIds()

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

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

Returns:

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

workingStorageUsedInBytes

public final Long workingStorageUsedInBytes()

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

Returns:

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

workingStorageAllocatedInBytes

public final Long workingStorageAllocatedInBytes()

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

Returns:

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

toBuilder

public DescribeWorkingStorageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWorkingStorageResponse.Builder,DescribeWorkingStorageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeWorkingStorageResponse.Builder builder()

serializableBuilderClass

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