DescribeDbSnapshotsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeDbSnapshotsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeDbSnapshotsRequest.Builder`	`builder()`
`String`	`dbInstanceIdentifier()` The ID of the DB instance to retrieve the list of DB snapshots for.
`String`	`dbiResourceId()` A specific DB resource ID to describe.
`String`	`dbSnapshotIdentifier()` A specific DB snapshot identifier to describe.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` A filter that specifies one or more DB snapshots to describe.
`<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()` A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account.
`Boolean`	`includeShared()` A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore.
`String`	`marker()` An optional pagination token provided by a previous `DescribeDBSnapshots` request.
`Integer`	`maxRecords()` The maximum number of records to include in the response.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeDbSnapshotsRequest.Builder>`	`serializableBuilderClass()`
`String`	`snapshotType()` The type of snapshots to be returned.
`DescribeDbSnapshotsRequest.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
  - dbInstanceIdentifier
```
public final String dbInstanceIdentifier()
```
    The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
    
    Constraints:
    - If supplied, must match the identifier of an existing DBInstance.
    Returns:
    The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
    
    Constraints:
    
    If supplied, must match the identifier of an existing DBInstance.
  - dbSnapshotIdentifier
```
public final String dbSnapshotIdentifier()
```
    A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
    
    Constraints:
    - If supplied, must match the identifier of an existing DBSnapshot.
    - If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
    Returns:
    A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
    
    Constraints:
    
    If supplied, must match the identifier of an existing DBSnapshot.
    
    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
  - snapshotType
```
public final String snapshotType()
```
    The type of snapshots to be returned. You can specify one of the following values:
    - automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
    - manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
    - shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
    - public - Return all DB snapshots that have been marked as public.
    - awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
      
      For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
      
      The awsbackup type does not apply to Aurora.
    If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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.
    Returns:
    The type of snapshots to be returned. You can specify one of the following values:
    
    automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
    
    manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
    
    shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
    
    public - Return all DB snapshots that have been marked as public.
    
    awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
    
    For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
    
    The awsbackup type does not apply to Aurora.
    
    If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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.
  - 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()
```
    A filter that specifies one or more DB snapshots to describe.
    
    Supported filters:
    - db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
    - db-snapshot-id - Accepts DB snapshot identifiers.
    - dbi-resource-id - Accepts identifiers of source DB instances.
    - snapshot-type - Accepts types of DB snapshots.
    - engine - Accepts names of database engines.
    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:
    A filter that specifies one or more DB snapshots to describe.
    
    Supported filters:
    
    db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
    
    db-snapshot-id - Accepts DB snapshot identifiers.
    
    dbi-resource-id - Accepts identifiers of source DB instances.
    
    snapshot-type - Accepts types of DB snapshots.
    
    engine - Accepts names of database engines.
  - 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 called a marker is included in the response so that you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    Default: 100
    
    Constraints: Minimum 20, maximum 100.
  - marker
```
public final String marker()
```
    An optional pagination token provided by a previous DescribeDBSnapshots 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 DescribeDBSnapshots 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()
```
    A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
    
    You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
    
    You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
    
    This setting doesn't apply to RDS Custom.
  - includePublic
```
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 Amazon Web Services account. By default, the public snapshots are not included.
    
    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
    
    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
    
    This setting doesn't apply to RDS Custom.
  - dbiResourceId
```
public final String dbiResourceId()
```
    A specific DB resource ID to describe.
    
    Returns:
    
    A specific DB resource ID to describe.
  - toBuilder
```
public DescribeDbSnapshotsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeDbSnapshotsRequest.Builder,DescribeDbSnapshotsRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static DescribeDbSnapshotsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeDbSnapshotsRequest.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 DescribeDbSnapshotsRequest

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

dbInstanceIdentifier

dbSnapshotIdentifier

snapshotType

hasFilters

filters

maxRecords

marker

includeShared

includePublic

dbiResourceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields