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

Class DescribeVtlDevicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeVtlDevicesRequest.Builder,DescribeVtlDevicesRequest>

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

DescribeVTLDevicesInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeVtlDevicesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeVtlDevicesRequest.Builder	builder()
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)
int	hashCode()
boolean	hasVtlDeviceARNs()	For responses, this returns true if the service returned a value for the VTLDeviceARNs property.
Integer	limit()	Specifies that the number of VTL devices described be limited to the specified number.
String	marker()	An opaque string that indicates the position at which to begin describing the VTL devices.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeVtlDevicesRequest.Builder>	serializableBuilderClass()
DescribeVtlDevicesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	vtlDeviceARNs()	An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

hasVtlDeviceARNs

public final boolean hasVtlDeviceARNs()

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

vtlDeviceARNs

public final List<String> vtlDeviceARNs()

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

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

Returns:

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

marker

public final String marker()

An opaque string that indicates the position at which to begin describing the VTL devices.

Returns:

An opaque string that indicates the position at which to begin describing the VTL devices.

limit

public final Integer limit()

Specifies that the number of VTL devices described be limited to the specified number.

Returns:

Specifies that the number of VTL devices described be limited to the specified number.

toBuilder

public DescribeVtlDevicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeVtlDevicesRequest.Builder,DescribeVtlDevicesRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static DescribeVtlDevicesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVtlDevicesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo