com.amazonaws.services.elasticache.model.DescribeReplicationGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2010-2015 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#describeReplicationGroups(DescribeReplicationGroupsRequest) DescribeReplicationGroups operation}.
*
* The DescribeReplicationGroups operation returns information
* about a particular replication group. If no identifier is specified,
* DescribeReplicationGroups returns information about all
* replication groups.
*
*
* @see com.amazonaws.services.elasticache.AmazonElastiCache#describeReplicationGroups(DescribeReplicationGroupsRequest)
*/
public class DescribeReplicationGroupsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The identifier for the replication group to be described. This
* parameter is not case sensitive. If you do not specify this
* parameter, information about all replication groups is returned.
*/
private String replicationGroupId;
/**
* 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: 100
Constraints: minimum 20; maximum 100.
*/
private Integer maxRecords;
/**
* 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 identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*
* @return The identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*/
public String getReplicationGroupId() {
return replicationGroupId;
}
/**
* The identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*
* @param replicationGroupId The identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*/
public void setReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = replicationGroupId;
}
/**
* The identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param replicationGroupId The identifier for the replication group to be described. This
* parameter is not case sensitive.
If you do not specify this
* parameter, information about all replication groups is returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReplicationGroupsRequest withReplicationGroupId(String replicationGroupId) {
this.replicationGroupId = replicationGroupId;
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: 100
Constraints: minimum 20; maximum 100.
*
* @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: 100
Constraints: minimum 20; maximum 100.
*/
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: 100
Constraints: minimum 20; maximum 100.
*
* @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: 100
Constraints: minimum 20; maximum 100.
*/
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: 100
Constraints: minimum 20; maximum 100.
*
* 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: 100
Constraints: minimum 20; maximum 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeReplicationGroupsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
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 DescribeReplicationGroupsRequest withMarker(String marker) {
this.marker = marker;
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 (getReplicationGroupId() != null) sb.append("ReplicationGroupId: " + getReplicationGroupId() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReplicationGroupId() == null) ? 0 : getReplicationGroupId().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeReplicationGroupsRequest == false) return false;
DescribeReplicationGroupsRequest other = (DescribeReplicationGroupsRequest)obj;
if (other.getReplicationGroupId() == null ^ this.getReplicationGroupId() == null) return false;
if (other.getReplicationGroupId() != null && other.getReplicationGroupId().equals(this.getReplicationGroupId()) == 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.getMarker() == null ^ this.getMarker() == null) return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false;
return true;
}
}