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(value="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 and Description
static interface	DescribeWorkingStorageResponse.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasDiskIds() Returns true if the DiskIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeWorkingStorageResponse.Builder>	serializableBuilderClass()
DescribeWorkingStorageResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the DiskIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasDiskIds() to see if a value was sent in this field.

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()

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<DescribeWorkingStorageResponse.Builder,DescribeWorkingStorageResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

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)

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.