Class DescribeBackupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeBackupsRequest.Builder,
DescribeBackupsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
One or more filters to limit the items returned in the response.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 Filters property.final int
hashCode()
final Integer
The maximum number of backups to return in the response.final String
TheNextToken
value that you received in the previous response.static Class
<? extends DescribeBackupsRequest.Builder> final Boolean
Designates whether or not to sort the return backups by ascending chronological order of generation.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
-
nextToken
The
NextToken
value that you received in the previous response. Use this value to get more backups.- Returns:
- The
NextToken
value that you received in the previous response. Use this value to get more backups.
-
maxResults
The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a
NextToken
value.- Returns:
- The maximum number of backups to return in the response. When there are more backups than the number you
specify, the response contains a
NextToken
value.
-
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
One or more filters to limit the items returned in the response.
Use the
backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).Use the
sourceBackupIds
filter to return only the backups created from a source backup. ThesourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.Use the
clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).Use the
states
filter to return only backups that match the specified state.Use the
neverExpires
filter to return backups filtered by the value in theneverExpires
parameter.True
returns all backups exempt from the backup retention policy.False
returns all backups with a backup retention policy defined at the cluster.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:
- One or more filters to limit the items returned in the response.
Use the
backupIds
filter to return only the specified backups. Specify backups by their backup identifier (ID).Use the
sourceBackupIds
filter to return only the backups created from a source backup. ThesourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.Use the
clusterIds
filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).Use the
states
filter to return only backups that match the specified state.Use the
neverExpires
filter to return backups filtered by the value in theneverExpires
parameter.True
returns all backups exempt from the backup retention policy.False
returns all backups with a backup retention policy defined at the cluster.
-
sortAscending
Designates whether or not to sort the return backups by ascending chronological order of generation.
- Returns:
- Designates whether or not to sort the return backups by ascending chronological order of generation.
-
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 classCloudHsmV2Request
- 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
-