Package software.amazon.awssdk.services.datasync.model

Class DescribeStorageSystemResourcesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResourcesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStorageSystemResourcesRequest.Builder,DescribeStorageSystemResourcesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStorageSystemResourcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStorageSystemResourcesRequest.Builder	builder()
String	discoveryJobArn()	Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<DiscoveryResourceFilter,List<String>>	filter()	Filters the storage system resources that you want returned.
Map<String,List<String>>	filterAsStrings()	Filters the storage system resources that you want returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilter()	For responses, this returns true if the service returned a value for the Filter property.
int	hashCode()
boolean	hasResourceIds()	For responses, this returns true if the service returned a value for the ResourceIds property.
Integer	maxResults()	Specifies the maximum number of storage system resources that you want to list in a response.
String	nextToken()	Specifies an opaque string that indicates the position to begin the next list of results in the response.
List<String>	resourceIds()	Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about.
DiscoveryResourceType	resourceType()	Specifies what kind of storage system resources that you want information about.
String	resourceTypeAsString()	Specifies what kind of storage system resources that you want information about.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStorageSystemResourcesRequest.Builder>	serializableBuilderClass()
DescribeStorageSystemResourcesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

discoveryJobArn

public final String discoveryJobArn()

Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.

Returns:

Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.

resourceType

public final DiscoveryResourceType resourceType()

Specifies what kind of storage system resources that you want information about.

If the service returns an enum value that is not available in the current SDK version, resourceType will return DiscoveryResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

Specifies what kind of storage system resources that you want information about.

See Also:

DiscoveryResourceType

resourceTypeAsString

public final String resourceTypeAsString()

Specifies what kind of storage system resources that you want information about.

If the service returns an enum value that is not available in the current SDK version, resourceType will return DiscoveryResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

Specifies what kind of storage system resources that you want information about.

See Also:

DiscoveryResourceType

hasResourceIds

public final boolean hasResourceIds()

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

resourceIds

public final List<String> resourceIds()

Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.

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

Returns:

Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.

filter

public final Map<DiscoveryResourceFilter,List<String>> filter()

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

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

Returns:

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

hasFilter

public final boolean hasFilter()

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

filterAsStrings

public final Map<String,List<String>> filterAsStrings()

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

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

Returns:

Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).

maxResults

public final Integer maxResults()

Specifies the maximum number of storage system resources that you want to list in a response.

Returns:

Specifies the maximum number of storage system resources that you want to list in a response.

nextToken

public final String nextToken()

Specifies an opaque string that indicates the position to begin the next list of results in the response.

Returns:

Specifies an opaque string that indicates the position to begin the next list of results in the response.

toBuilder

public DescribeStorageSystemResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStorageSystemResourcesRequest.Builder,DescribeStorageSystemResourcesRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static DescribeStorageSystemResourcesRequest.Builder builder()

serializableBuilderClass

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