DescribeDBSnapshotsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeDBSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeDBSnapshots operation.
Returns information about DBSnapshots. This API supports pagination.

See Also:
AmazonRDS.describeDBSnapshots(DescribeDBSnapshotsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeDBSnapshotsRequest()
Default constructor for a new DescribeDBSnapshotsRequest object.

Constructors
Constructor and Description
`DescribeDBSnapshotsRequest()` Default constructor for a new DescribeDBSnapshotsRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDBInstanceIdentifier()` A DB Instance Identifier to retrieve the list of DB Snapshots for.
`String`	`getDBSnapshotIdentifier()` A specific DB Snapshot Identifier to describe.
`String`	`getMarker()` An optional pagination token provided by a previous DescribeDBSnapshots request.
`Integer`	`getMaxRecords()` The maximum number of records to include in the response.
`String`	`getSnapshotType()` An optional snapshot type for which snapshots will be returned.
`int`	`hashCode()`
`void`	`setDBInstanceIdentifier(String dBInstanceIdentifier)` A DB Instance Identifier to retrieve the list of DB Snapshots for.
`void`	`setDBSnapshotIdentifier(String dBSnapshotIdentifier)` A specific DB Snapshot Identifier to describe.
`void`	`setMarker(String marker)` An optional pagination token provided by a previous DescribeDBSnapshots request.
`void`	`setMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.
`void`	`setSnapshotType(String snapshotType)` An optional snapshot type for which snapshots will be returned.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeDBSnapshotsRequest`	`withDBInstanceIdentifier(String dBInstanceIdentifier)` A DB Instance Identifier to retrieve the list of DB Snapshots for.
`DescribeDBSnapshotsRequest`	`withDBSnapshotIdentifier(String dBSnapshotIdentifier)` A specific DB Snapshot Identifier to describe.
`DescribeDBSnapshotsRequest`	`withMarker(String marker)` An optional pagination token provided by a previous DescribeDBSnapshots request.
`DescribeDBSnapshotsRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.
`DescribeDBSnapshotsRequest`	`withSnapshotType(String snapshotType)` An optional snapshot type for which snapshots will be returned.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

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

- Constructor Detail
  - DescribeDBSnapshotsRequest
```
public DescribeDBSnapshotsRequest()
```
    Default constructor for a new DescribeDBSnapshotsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
- Method Detail
  - getDBInstanceIdentifier
```
public String getDBInstanceIdentifier()
```
    A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - setDBInstanceIdentifier
```
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
```
    A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    dBInstanceIdentifier - A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - withDBInstanceIdentifier
```
public DescribeDBSnapshotsRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
```
    A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    dBInstanceIdentifier - A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDBSnapshotIdentifier
```
public String getDBSnapshotIdentifier()
```
    A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
    Returns:
    A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    
    If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
  - setDBSnapshotIdentifier
```
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier)
```
    A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
    Parameters:
    dBSnapshotIdentifier - A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    
    If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
  - withDBSnapshotIdentifier
```
public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier)
```
    A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    dBSnapshotIdentifier - A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
    Constraints:
    
    Must be 1 to 255 alphanumeric characters
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
    
    If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotType
```
public String getSnapshotType()
```
    An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
    
    Returns:
    An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
  - setSnapshotType
```
public void setSnapshotType(String snapshotType)
```
    An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
    
    Parameters:
    snapshotType - An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
  - withSnapshotType
```
public DescribeDBSnapshotsRequest withSnapshotType(String snapshotType)
```
    An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotType - An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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 called a marker is included in the response so that the remaining results may 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 may be retrieved.
    Default: 100
    Constraints: minimum 20, maximum 100
  - 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 called a marker is included in the response so that the remaining results may 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 called a marker is included in the response so that the remaining results may be retrieved.
    Default: 100
    Constraints: minimum 20, maximum 100
  - withMaxRecords
```
public DescribeDBSnapshotsRequest 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 called a marker is included in the response so that the remaining results may be retrieved.
    Default: 100
    Constraints: minimum 20, maximum 100
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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 may be retrieved.
    Default: 100
    Constraints: minimum 20, maximum 100
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMarker
```
public String getMarker()
```
    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.
  - setMarker
```
public void setMarker(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.
    
    Parameters:
    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.
  - withMarker
```
public DescribeDBSnapshotsRequest withMarker(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    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:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeDBSnapshotsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDBSnapshotsRequest

Method Detail

getDBInstanceIdentifier

setDBInstanceIdentifier

withDBInstanceIdentifier

getDBSnapshotIdentifier

setDBSnapshotIdentifier

withDBSnapshotIdentifier

getSnapshotType

setSnapshotType

withSnapshotType

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

toString

hashCode

equals