DescribeDbClusterSnapshotsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.docdb.model.DocDbRequest
    - - software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDbClusterSnapshotsRequest
extends DocDbRequest
implements ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>

Represents the input to DescribeDBClusterSnapshots.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeDbClusterSnapshotsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeDbClusterSnapshotsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeDbClusterSnapshotsRequest.Builder`	`builder()`
`String`	`dbClusterIdentifier()` The ID of the cluster to retrieve the list of cluster snapshots for.
`String`	`dbClusterSnapshotIdentifier()` A specific cluster snapshot identifier to describe.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` This parameter is not currently supported.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Boolean`	`includePublic()` Set to `true` to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise `false`.
`Boolean`	`includeShared()` Set to `true` to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise `false`.
`String`	`marker()` An optional pagination token provided by a previous 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 cluster snapshots to be returned.
`DescribeDbClusterSnapshotsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbClusterIdentifier
```
public final String dbClusterIdentifier()
```
    The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
    
    Constraints:
    - If provided, must match the identifier of an existing DBCluster.
    Returns:
    The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
    
    Constraints:
    
    If provided, must match the identifier of an existing DBCluster.
  - dbClusterSnapshotIdentifier
```
public final String dbClusterSnapshotIdentifier()
```
    A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
    
    Constraints:
    - If provided, 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 cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
    
    Constraints:
    
    If provided, must match the identifier of an existing DBClusterSnapshot.
    
    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
  - snapshotType
```
public final String 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 account.
    - manual - Return all cluster snapshots that you have manually created for your account.
    - shared - Return all manual cluster snapshots that have been shared to your account.
    - public - Return all cluster snapshots that have been marked as public.
    If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.
    
    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.
    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 account.
    
    manual - Return all cluster snapshots that you have manually created for your account.
    
    shared - Return all manual cluster snapshots that have been shared to your account.
    
    public - Return all cluster snapshots that have been marked as public.
    
    If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
    
    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.
  - 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 the isEmpty() 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
```
public final List<Filter> 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
```
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 (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 (marker) is included in the response so that the remaining results can be retrieved.
    
    Default: 100
    
    Constraints: Minimum 20, maximum 100.
  - marker
```
public final String marker()
```
    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    Returns:
    
    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - includeShared
```
public final Boolean includeShared()
```
    Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.
    
    Returns:
    
    Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.
  - includePublic
```
public final Boolean includePublic()
```
    Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.
    
    Returns:
    
    Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.
  - toBuilder
```
public DescribeDbClusterSnapshotsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>
    
    Specified by:
    
    toBuilder in class DocDbRequest
  - builder
```
public static DescribeDbClusterSnapshotsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeDbClusterSnapshotsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeDbClusterSnapshotsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbClusterIdentifier

dbClusterSnapshotIdentifier

snapshotType

hasFilters

filters

maxRecords

marker

includeShared

includePublic

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields