Package software.amazon.awssdk.services.fsx.model

Class DescribeFileSystemsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fsx.model.FSxRequest

software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFileSystemsRequest.Builder,DescribeFileSystemsRequest>

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

The request object for DescribeFileSystems operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFileSystemsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeFileSystemsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fileSystemIds()	IDs of the file systems whose descriptions you want to retrieve (String).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFileSystemIds()	For responses, this returns true if the service returned a value for the FileSystemIds property.
int	hashCode()
Integer	maxResults()	Maximum number of file systems to return in the response (integer).
String	nextToken()	Opaque pagination token returned from a previous DescribeFileSystems operation (String).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFileSystemsRequest.Builder>	serializableBuilderClass()
DescribeFileSystemsRequest.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

hasFileSystemIds

public final boolean hasFileSystemIds()

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

fileSystemIds

public final List<String> fileSystemIds()

IDs of the file systems whose descriptions you want to retrieve (String).

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

Returns:

IDs of the file systems whose descriptions you want to retrieve (String).

maxResults

public final Integer maxResults()

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

Returns:

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

nextToken

public final String nextToken()

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Returns:

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

toBuilder

public DescribeFileSystemsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFileSystemsRequest.Builder,DescribeFileSystemsRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static DescribeFileSystemsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo