software.amazon.awssdk.services.rds.model

Class DescribeDBSnapshotsRequest

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:

ToCopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDBSnapshotsRequest.Builder

Method Summary

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	dbSnapshotIdentifier() A specific DB snapshot identifier to describe.
boolean	equals(Object obj)
List<Filter>	filters() This parameter is not currently supported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	includePublic() True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false.
Boolean	includeShared() True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false.
String	marker() An optional pagination token provided by a previous DescribeDBSnapshots request.
Integer	maxRecords() The maximum number of records to include in the response.
static Class<? extends DescribeDBSnapshotsRequest.Builder>	serializableBuilderClass()
String	snapshotType() The type of snapshots to be returned.
DescribeDBSnapshotsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbInstanceIdentifier

public String dbInstanceIdentifier()

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not 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 can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

dbSnapshotIdentifier

public String dbSnapshotIdentifier()

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. 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 parameter can't be used in conjunction with DBInstanceIdentifier. 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 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 AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

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 setting the IncludeShared parameter to true. You can include public 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 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 AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

• shared - Return all manual DB snapshots that have been shared to my AWS account.

• public - Return all DB snapshots that have been marked as public.

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 setting the IncludeShared parameter to true. You can include public 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.

filters

public List<Filter> filters()

This parameter is not currently supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

This parameter is not currently supported.

maxRecords

public 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 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

public 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 Boolean includeShared()

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Returns:

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

includePublic

public Boolean includePublic()

True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Returns:

True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

toBuilder

public DescribeDBSnapshotsRequest.Builder 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 interface ToCopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>

Specified by:

toBuilder in class RDSRequest

Returns:

a builder for type T

builder

public static DescribeDBSnapshotsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDBSnapshotsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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