Class DescribeSnapshotsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input of a DescribeSnapshotsMessage action.

See Also:
  • Constructor Details

    • DescribeSnapshotsRequest

      public DescribeSnapshotsRequest()
  • Method Details

    • setCacheClusterId

      public void setCacheClusterId(String cacheClusterId)

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

      Parameters:
      cacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
    • getCacheClusterId

      public String getCacheClusterId()

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

      Returns:
      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
    • withCacheClusterId

      public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId)

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

      Parameters:
      cacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSnapshotName

      public void setSnapshotName(String snapshotName)

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

      Parameters:
      snapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
    • getSnapshotName

      public String getSnapshotName()

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

      Returns:
      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
    • withSnapshotName

      public DescribeSnapshotsRequest withSnapshotName(String snapshotName)

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

      Parameters:
      snapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSnapshotSource

      public void setSnapshotSource(String snapshotSource)

      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      Parameters:
      snapshotSource - If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
    • getSnapshotSource

      public String getSnapshotSource()

      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      Returns:
      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
    • withSnapshotSource

      public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource)

      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      Parameters:
      snapshotSource - If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMarker

      public void setMarker(String marker)

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Parameters:
      marker - An optional marker returned from a prior request. Use this marker for pagination of results from this action. 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 marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    • withMarker

      public DescribeSnapshotsRequest withMarker(String marker)

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Parameters:
      marker - An optional marker returned from a prior request. Use this marker for pagination of results from this action. 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.
    • 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 marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

      Parameters:
      maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

    • getMaxRecords

      public Integer getMaxRecords()

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

      Returns:
      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

    • withMaxRecords

      public DescribeSnapshotsRequest withMaxRecords(Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

      Parameters:
      maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

      Returns:
      Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeSnapshotsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: