com.amazonaws.services.redshift.model.DescribeClustersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk 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.redshift.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.redshift.AmazonRedshift#describeClusters(DescribeClustersRequest) DescribeClusters operation}.
*
* Returns properties of provisioned clusters including general cluster
* properties, cluster database properties, maintenance and backup
* properties, and security and access properties. This operation
* supports pagination. For more information about managing clusters, go
* to
* Amazon Redshift Clusters
* in the Amazon Redshift Management Guide .
*
*
*
* @see com.amazonaws.services.redshift.AmazonRedshift#describeClusters(DescribeClustersRequest)
*/
public class DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive. The default is that
* all clusters defined for an account are returned.
*/
private String clusterIdentifier;
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
private Integer maxRecords;
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*/
private String marker;
/**
* The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*
* @return The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*/
public String getClusterIdentifier() {
return clusterIdentifier;
}
/**
* The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*
* @param clusterIdentifier The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*/
public void setClusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
}
/**
* The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param clusterIdentifier The unique identifier of a cluster whose properties you are
* requesting. This parameter is case sensitive.
The default is that
* all clusters defined for an account are returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClustersRequest withClusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
return this;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @return The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @param maxRecords The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
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 response records to return in each call. If the
* number of remaining response records exceeds the specified
* MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next
* set of records by retrying the command with the returned marker value.
*
Default: 100
Constraints: minimum 20, maximum 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClustersRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*
* @return An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*/
public String getMarker() {
return marker;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*
* @param marker An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker An optional parameter that specifies the starting point to return a
* set of response records. When the results of a DescribeClusters
* request exceed the value specified in MaxRecords, AWS
* returns a value in the Marker field of the response. You
* can retrieve the next set of response records by providing the
* returned marker value in the Marker parameter and
* retrying the request.
Constraints: You can specify either the
* ClusterIdentifier parameter or the Marker parameter, but
* not both.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeClustersRequest 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 (getClusterIdentifier() != null) sb.append("ClusterIdentifier: " + getClusterIdentifier() + ",");
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 + ((getClusterIdentifier() == null) ? 0 : getClusterIdentifier().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 DescribeClustersRequest == false) return false;
DescribeClustersRequest other = (DescribeClustersRequest)obj;
if (other.getClusterIdentifier() == null ^ this.getClusterIdentifier() == null) return false;
if (other.getClusterIdentifier() != null && other.getClusterIdentifier().equals(this.getClusterIdentifier()) == 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;
}
}