com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticache.AmazonElastiCache#describeSnapshots(DescribeSnapshotsRequest) DescribeSnapshots operation}.
*
* The DescribeSnapshots operation returns information about cache
* cluster snapshots. By default, DescribeSnapshots lists all of
* your snapshots; it can optionally describe a single snapshot, or just
* the snapshots associated with a particular cache cluster.
*
*
* @see com.amazonaws.services.elasticache.AmazonElastiCache#describeSnapshots(DescribeSnapshotsRequest)
*/
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*/
private String cacheClusterId;
/**
* A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*/
private String snapshotName;
/**
* 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.
*/
private String snapshotSource;
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
private String marker;
/**
* 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.
*/
private Integer maxRecords;
/**
* A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*
* @return A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*/
public String getCacheClusterId() {
return cacheClusterId;
}
/**
* A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*
* @param cacheClusterId A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*/
public void setCacheClusterId(String cacheClusterId) {
this.cacheClusterId = cacheClusterId;
}
/**
* A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param cacheClusterId A user-supplied cluster identifier. If this parameter is specified,
* only snapshots associated with that specific cache cluster will be
* described.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId) {
this.cacheClusterId = cacheClusterId;
return this;
}
/**
* A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*
* @return A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*/
public String getSnapshotName() {
return snapshotName;
}
/**
* A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*
* @param snapshotName A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*/
public void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
/**
* A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotName A user-supplied name of the snapshot. If this parameter is specified,
* only this snapshot will be described.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
return this;
}
/**
* 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.
*
* @return 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.
*/
public String getSnapshotSource() {
return 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.
*
* @param 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.
*/
public void setSnapshotSource(String snapshotSource) {
this.snapshotSource = 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 a reference to this object so that method calls can be chained together.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource) {
this.snapshotSource = snapshotSource;
return this;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @param marker An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. 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.
*
* @param marker An optional marker returned from a prior request. Use this marker for
* pagination of results from this operation. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* 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.
*
* @return 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.
*/
public Integer getMaxRecords() {
return 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.
*
* @param 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.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = 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 a reference to this object so that method calls can be chained together.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCacheClusterId() != null) sb.append("CacheClusterId: " + getCacheClusterId() + ",");
if (getSnapshotName() != null) sb.append("SnapshotName: " + getSnapshotName() + ",");
if (getSnapshotSource() != null) sb.append("SnapshotSource: " + getSnapshotSource() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCacheClusterId() == null) ? 0 : getCacheClusterId().hashCode());
hashCode = prime * hashCode + ((getSnapshotName() == null) ? 0 : getSnapshotName().hashCode());
hashCode = prime * hashCode + ((getSnapshotSource() == null) ? 0 : getSnapshotSource().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeSnapshotsRequest == false) return false;
DescribeSnapshotsRequest other = (DescribeSnapshotsRequest)obj;
if (other.getCacheClusterId() == null ^ this.getCacheClusterId() == null) return false;
if (other.getCacheClusterId() != null && other.getCacheClusterId().equals(this.getCacheClusterId()) == false) return false;
if (other.getSnapshotName() == null ^ this.getSnapshotName() == null) return false;
if (other.getSnapshotName() != null && other.getSnapshotName().equals(this.getSnapshotName()) == false) return false;
if (other.getSnapshotSource() == null ^ this.getSnapshotSource() == null) return false;
if (other.getSnapshotSource() != null && other.getSnapshotSource().equals(this.getSnapshotSource()) == false) return false;
if (other.getMarker() == null ^ this.getMarker() == null) return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null) return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false) return false;
return true;
}
}