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() (Optional) IDs of the backups you want to retrieve (String).
static DescribeBackupsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() (Optional) Filters structure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() (Optional) Maximum number of backups to return in the response (integer).
String	nextToken() (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String).
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBackupsRequest.Builder>	serializableBuilderClass()
DescribeBackupsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

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

backupIds

public List<String> backupIds()

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

Returns:

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

filters

public List<Filter> filters()

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

Returns:

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

maxResults

public Integer maxResults()

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

(Optional) 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 String nextToken()

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

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

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

Specified by:

toBuilder in class FSxRequest

Returns:

a builder for type T

builder

public static DescribeBackupsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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