Class DescribeBackupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeBackupsRequest.Builder,
DescribeBackupsRequest>
The request object for the DescribeBackups
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe IDs of the backups that you want to retrieve.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
The filters structure.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the BackupIds property.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Integer
Maximum number of backups to return in the response.final String
An opaque pagination token returned from a previousDescribeBackups
operation.static Class
<? extends DescribeBackupsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
The filters structure. The supported names are
file-system-id
,backup-type
,file-system-type
, andvolume-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
, andvolume-id
.
-
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
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
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 interfaceToCopyableBuilder<DescribeBackupsRequest.Builder,
DescribeBackupsRequest> - Specified by:
toBuilder
in classFSxRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-