@Generated(value="software.amazon.awssdk:codegen") public final class DescribeDbClusterSnapshotsRequest extends RdsRequest implements ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeDbClusterSnapshotsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeDbClusterSnapshotsRequest.Builder |
builder() |
String |
dbClusterIdentifier()
The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
|
String |
dbClusterSnapshotIdentifier()
A specific DB cluster snapshot identifier to describe.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<Filter> |
filters()
A filter that specifies one or more DB cluster snapshots to describe.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasFilters()
Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
Boolean |
includePublic()
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or
restored by any AWS account.
|
Boolean |
includeShared()
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this
AWS account has been given permission to copy or restore.
|
String |
marker()
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
Integer |
maxRecords()
The maximum number of records to include in the response.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeDbClusterSnapshotsRequest.Builder> |
serializableBuilderClass() |
String |
snapshotType()
The type of DB cluster snapshots to be returned.
|
DescribeDbClusterSnapshotsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String dbClusterIdentifier()
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in
conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
DBClusterSnapshotIdentifier
parameter. This parameter isn't
case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
public final String dbClusterSnapshotIdentifier()
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be
specified.
public final String snapshotType()
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my
AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are
returned. You can include shared DB cluster snapshots with these results by enabling the
IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling
the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS
for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster
snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the
IncludeShared
parameter. You can include public DB cluster snapshots with these results by
enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The
IncludePublic
parameter doesn't apply when SnapshotType
is set to
shared
. The IncludeShared
parameter doesn't apply when
SnapshotType
is set to public
.
public final boolean hasFilters()
public final List<Filter> filters()
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFilters()
to see if a value was sent in this field.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
public final Integer maxRecords()
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords
value, a pagination token called a marker is included in the response so you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
public final String marker()
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DescribeDBClusterSnapshots
request. If
this parameter is specified, the response includes only records beyond the marker, up to the value
specified by MaxRecords
.public final Boolean includeShared()
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the
ModifyDBClusterSnapshotAttribute
API action.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account
by the ModifyDBClusterSnapshotAttribute
API action.
public final Boolean includePublic()
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
public DescribeDbClusterSnapshotsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>
toBuilder
in class RdsRequest
public static DescribeDbClusterSnapshotsRequest.Builder builder()
public static Class<? extends DescribeDbClusterSnapshotsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.