Package 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("software.amazon.awssdk:codegen")
public final class DescribeBackupsRequest
extends FSxRequest
implements ToCopyableBuilder<DescribeBackupsRequest.Builder,DescribeBackupsRequest>

The request object for the DescribeBackups operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeBackupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	backupIds()	The IDs of the backups that you want to retrieve.
static DescribeBackupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	The filters structure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupIds()	For responses, this returns true if the service returned a value for the BackupIds property.
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	Maximum number of backups to return in the response.
String	nextToken()	An opaque pagination token returned from a previous DescribeBackups operation.
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()

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

backupIds

public final List<String> backupIds()

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

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

Returns:

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

hasFilters

public final boolean hasFilters()

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

filters

public final List<Filter> filters()

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

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

Returns:

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

maxResults

public final Integer maxResults()

Maximum number of backups to return in the response. 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. 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()

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

Returns:

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation 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