Class ListClusterSnapshotsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListClusterSnapshotsRequest.Builder,
ListClusterSnapshotsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN identifier of the elastic cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of elastic cluster snapshot results to receive in the response.final String
A pagination token provided by a previous request.static Class
<? extends ListClusterSnapshotsRequest.Builder> final String
The type of cluster snapshots to be returned.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
-
clusterArn
The ARN identifier of the elastic cluster.
- Returns:
- The ARN identifier of the elastic cluster.
-
maxResults
The maximum number of elastic cluster snapshot results to receive in the response.
- Returns:
- The maximum number of elastic cluster snapshot results to receive in the response.
-
nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by
max-results
.If there is no more data in the responce, the
nextToken
will not be returned.- Returns:
- A pagination token provided by a previous request. If this parameter is specified, the response includes
only records beyond this token, up to the value specified by
max-results
.If there is no more data in the responce, the
nextToken
will not be returned.
-
snapshotType
The type of cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. -
manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.
- Returns:
- The type of cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. -
manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.
-
-
-
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<ListClusterSnapshotsRequest.Builder,
ListClusterSnapshotsRequest> - Specified by:
toBuilder
in classDocDbElasticRequest
- 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
-