com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a DescribeSnapshotsMessage operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSnapshotsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that
* specific replication group are described.
*
*/
private String replicationGroupId;
/**
*
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific
* cluster are described.
*
*/
private String cacheClusterId;
/**
*
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are 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 Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*
*/
private Boolean showNodeGroupConfig;
/**
*
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that
* specific replication group are described.
*
*
* @param replicationGroupId
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated
* with that specific replication group are described.
*/
public void setReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = replicationGroupId;
}
/**
*
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that
* specific replication group are described.
*
*
* @return A user-supplied replication group identifier. If this parameter is specified, only snapshots associated
* with that specific replication group are described.
*/
public String getReplicationGroupId() {
return this.replicationGroupId;
}
/**
*
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that
* specific replication group are described.
*
*
* @param replicationGroupId
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated
* with that specific replication group are described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withReplicationGroupId(String replicationGroupId) {
setReplicationGroupId(replicationGroupId);
return this;
}
/**
*
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific
* cluster are described.
*
*
* @param cacheClusterId
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that
* specific cluster are 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
* cluster are described.
*
*
* @return A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that
* specific cluster are described.
*/
public String getCacheClusterId() {
return this.cacheClusterId;
}
/**
*
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific
* cluster are described.
*
*
* @param cacheClusterId
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that
* specific cluster are described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withCacheClusterId(String cacheClusterId) {
setCacheClusterId(cacheClusterId);
return this;
}
/**
*
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*
*
* @param snapshotName
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*/
public void setSnapshotName(String snapshotName) {
this.snapshotName = snapshotName;
}
/**
*
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*
*
* @return A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*/
public String getSnapshotName() {
return this.snapshotName;
}
/**
*
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*
*
* @param snapshotName
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withSnapshotName(String snapshotName) {
setSnapshotName(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.
*
*
* @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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withSnapshotSource(String snapshotSource) {
setSnapshotSource(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.
*
*
* @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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withMarker(String marker) {
setMarker(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.
*
*
* @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.
*
*
* @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 this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*
*
* @param showNodeGroupConfig
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot
* description.
*/
public void setShowNodeGroupConfig(Boolean showNodeGroupConfig) {
this.showNodeGroupConfig = showNodeGroupConfig;
}
/**
*
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*
*
* @return A Boolean value which if true, the node group (shard) configuration is included in the snapshot
* description.
*/
public Boolean getShowNodeGroupConfig() {
return this.showNodeGroupConfig;
}
/**
*
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*
*
* @param showNodeGroupConfig
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot
* description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSnapshotsRequest withShowNodeGroupConfig(Boolean showNodeGroupConfig) {
setShowNodeGroupConfig(showNodeGroupConfig);
return this;
}
/**
*
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*
*
* @return A Boolean value which if true, the node group (shard) configuration is included in the snapshot
* description.
*/
public Boolean isShowNodeGroupConfig() {
return this.showNodeGroupConfig;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getReplicationGroupId() != null)
sb.append("ReplicationGroupId: ").append(getReplicationGroupId()).append(",");
if (getCacheClusterId() != null)
sb.append("CacheClusterId: ").append(getCacheClusterId()).append(",");
if (getSnapshotName() != null)
sb.append("SnapshotName: ").append(getSnapshotName()).append(",");
if (getSnapshotSource() != null)
sb.append("SnapshotSource: ").append(getSnapshotSource()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getShowNodeGroupConfig() != null)
sb.append("ShowNodeGroupConfig: ").append(getShowNodeGroupConfig());
sb.append("}");
return sb.toString();
}
@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.getReplicationGroupId() == null ^ this.getReplicationGroupId() == null)
return false;
if (other.getReplicationGroupId() != null && other.getReplicationGroupId().equals(this.getReplicationGroupId()) == false)
return false;
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;
if (other.getShowNodeGroupConfig() == null ^ this.getShowNodeGroupConfig() == null)
return false;
if (other.getShowNodeGroupConfig() != null && other.getShowNodeGroupConfig().equals(this.getShowNodeGroupConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReplicationGroupId() == null) ? 0 : getReplicationGroupId().hashCode());
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());
hashCode = prime * hashCode + ((getShowNodeGroupConfig() == null) ? 0 : getShowNodeGroupConfig().hashCode());
return hashCode;
}
@Override
public DescribeSnapshotsRequest clone() {
return (DescribeSnapshotsRequest) super.clone();
}
}