com.amazonaws.services.docdb.model

Class DescribeDBClusterSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdb.model.DescribeDBClusterSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBClusterSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input to DescribeDBClusterSnapshots.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBClusterSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeDBClusterSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBClusterIdentifier() The ID of the cluster to retrieve the list of cluster snapshots for.
String	getDBClusterSnapshotIdentifier() A specific cluster snapshot identifier to describe.
List<Filter>	getFilters() This parameter is not currently supported.
Boolean	getIncludePublic() Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false.
Boolean	getIncludeShared() Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false.
String	getMarker() An optional pagination token provided by a previous request.
Integer	getMaxRecords() The maximum number of records to include in the response.
String	getSnapshotType() The type of cluster snapshots to be returned.
int	hashCode()
Boolean	isIncludePublic() Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false.
Boolean	isIncludeShared() Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false.
void	setDBClusterIdentifier(String dBClusterIdentifier) The ID of the cluster to retrieve the list of cluster snapshots for.
void	setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier) A specific cluster snapshot identifier to describe.
void	setFilters(Collection<Filter> filters) This parameter is not currently supported.
void	setIncludePublic(Boolean includePublic) Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false.
void	setIncludeShared(Boolean includeShared) Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false.
void	setMarker(String marker) An optional pagination token provided by a previous request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setSnapshotType(String snapshotType) The type of cluster snapshots to be returned.
String	toString() Returns a string representation of this object.
DescribeDBClusterSnapshotsRequest	withDBClusterIdentifier(String dBClusterIdentifier) The ID of the cluster to retrieve the list of cluster snapshots for.
DescribeDBClusterSnapshotsRequest	withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier) A specific cluster snapshot identifier to describe.
DescribeDBClusterSnapshotsRequest	withFilters(Collection<Filter> filters) This parameter is not currently supported.
DescribeDBClusterSnapshotsRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeDBClusterSnapshotsRequest	withIncludePublic(Boolean includePublic) Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false.
DescribeDBClusterSnapshotsRequest	withIncludeShared(Boolean includeShared) Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false.
DescribeDBClusterSnapshotsRequest	withMarker(String marker) An optional pagination token provided by a previous request.
DescribeDBClusterSnapshotsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDBClusterSnapshotsRequest	withSnapshotType(String snapshotType) The type of cluster snapshots to be returned.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDBClusterSnapshotsRequest

public DescribeDBClusterSnapshotsRequest()

Method Detail

setDBClusterIdentifier

public void setDBClusterIdentifier(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.

Parameters:

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.

getDBClusterIdentifier

public String getDBClusterIdentifier()

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.

withDBClusterIdentifier

public DescribeDBClusterSnapshotsRequest withDBClusterIdentifier(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDBClusterSnapshotIdentifier

public void setDBClusterSnapshotIdentifier(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.

Parameters:

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.

getDBClusterSnapshotIdentifier

public String getDBClusterSnapshotIdentifier()

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.

withDBClusterSnapshotIdentifier

public DescribeDBClusterSnapshotsRequest withDBClusterSnapshotIdentifier(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSnapshotType

public void setSnapshotType(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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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.

Parameters:

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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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.

getSnapshotType

public String getSnapshotType()

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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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.

withSnapshotType

public DescribeDBClusterSnapshotsRequest withSnapshotType(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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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.

Parameters:

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 Amazon Web Services account.

• manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

• shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

This parameter is not currently supported.

Returns:

This parameter is not currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

withFilters

public DescribeDBClusterSnapshotsRequest withFilters(Filter... filters)

This parameter is not currently supported.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeDBClusterSnapshotsRequest withFilters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxRecords

public void setMaxRecords(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.

Parameters:

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.

getMaxRecords

public Integer getMaxRecords()

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.

withMaxRecords

public DescribeDBClusterSnapshotsRequest withMaxRecords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMarker

public void setMarker(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.

Parameters:

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.

getMarker

public String getMarker()

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.

withMarker

public DescribeDBClusterSnapshotsRequest withMarker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIncludeShared

public void setIncludeShared(Boolean includeShared)

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

Parameters:

includeShared - Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

getIncludeShared

public Boolean getIncludeShared()

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services 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 Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

withIncludeShared

public DescribeDBClusterSnapshotsRequest withIncludeShared(Boolean includeShared)

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

Parameters:

includeShared - Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeShared

public Boolean isIncludeShared()

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services 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 Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

setIncludePublic

public void setIncludePublic(Boolean includePublic)

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

Parameters:

includePublic - Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

getIncludePublic

public Boolean getIncludePublic()

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services 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 Amazon Web Services account, and otherwise false. The default is false.

withIncludePublic

public DescribeDBClusterSnapshotsRequest withIncludePublic(Boolean includePublic)

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

Parameters:

includePublic - Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludePublic

public Boolean isIncludePublic()

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services 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 Amazon Web Services account, and otherwise false. The default is false.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeDBClusterSnapshotsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()