software.amazon.awssdk.services.fsx.model

Class DescribeBackupsRequest

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.DescribeBackupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

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

The request object for DescribeBackups operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBackupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	backupIds() IDs of the backups you want to retrieve (String).
static DescribeBackupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() Filters structure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupIds() Returns true if the BackupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFilters() Returns true if the Filters 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()
Integer	maxResults() Maximum number of backups to return in the response (integer).
String	nextToken() Opaque pagination token returned from a previous DescribeBackups operation (String).
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBackupsRequest.Builder>	serializableBuilderClass()
DescribeBackupsRequest.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

hasBackupIds

public final boolean hasBackupIds()

Returns true if the BackupIds 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.

backupIds

public final List<String> backupIds()

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

hasFilters

public final boolean hasFilters()

Returns true if the Filters 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.

filters

public final List<Filter> filters()

Filters structure. Supported names are file-system-id and backup-type.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

Filters structure. Supported names are file-system-id and backup-type.

maxResults

public final Integer maxResults()

Maximum number of backups 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 backups 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 DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Returns:

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

toBuilder

public DescribeBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

Specified by:

toBuilder in class FSxRequest

builder

public static DescribeBackupsRequest.Builder builder()

serializableBuilderClass

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