Class DescribeDbClusterSnapshotsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,
DescribeDbClusterSnapshotsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ID of the DB cluster to retrieve the list of DB cluster snapshots for.final String
A specific DB cluster snapshot identifier to describe.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
This parameter is not currently supported.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 Boolean
True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false.final Boolean
True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false.final String
marker()
An optional pagination token provided by a previousDescribeDBClusterSnapshots
request.final Integer
The maximum number of records to include in the response.static Class
<? extends DescribeDbClusterSnapshotsRequest.Builder> final String
The type of DB 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
-
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 is not case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
- Returns:
- 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 is not case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
-
-
-
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.
- Returns:
- 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.
-
-
-
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 Neptune for my Amazon account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon 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 setting theIncludeShared
parameter totrue
. You can include public DB cluster snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.- Returns:
- 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 Neptune for my Amazon account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon 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 setting theIncludeShared
parameter totrue
. You can include public DB cluster snapshots with these results by setting theIncludePublic
parameter totrue
.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
. -
-
-
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
This parameter is not currently supported.
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:
- This parameter is not currently supported.
-
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 that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- 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 that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
-
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 byMaxRecords
.- Returns:
- 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 byMaxRecords
.
-
includePublic
True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is
false
. The default is false.You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
- Returns:
- True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon
account, and otherwise false. The default is
false
. The default is false.You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
-
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<DescribeDbClusterSnapshotsRequest.Builder,
DescribeDbClusterSnapshotsRequest> - Specified by:
toBuilder
in classNeptuneRequest
- 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
-