com.amazonaws.services.autoscaling.model.DescribePoliciesRequest 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.autoscaling.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.autoscaling.AmazonAutoScaling#describePolicies(DescribePoliciesRequest) DescribePolicies operation}.
*
* Returns descriptions of what each policy does. This action supports
* pagination. If the response includes a token, there are more records
* available. To get the additional records, repeat the request with the
* response token as the NextToken parameter.
*
*
* @see com.amazonaws.services.autoscaling.AmazonAutoScaling#describePolicies(DescribePoliciesRequest)
*/
public class DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String autoScalingGroupName;
/**
* A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag policyNames;
/**
* A string that is used to mark the start of the next batch of returned
* results for pagination.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String nextToken;
/**
* The maximum number of policies that will be described with each call.
*
* Constraints:
* Range: 1 - 50
*/
private Integer maxRecords;
/**
* The name of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The name of the Auto Scaling group.
*/
public String getAutoScalingGroupName() {
return autoScalingGroupName;
}
/**
* The name of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param autoScalingGroupName The name of the Auto Scaling group.
*/
public void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
/**
* The name of the Auto Scaling group.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param autoScalingGroupName The name of the Auto Scaling group.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribePoliciesRequest withAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
return this;
}
/**
* A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* @return A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*/
public java.util.List getPolicyNames() {
if (policyNames == null) {
policyNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
policyNames.setAutoConstruct(true);
}
return policyNames;
}
/**
* A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* @param policyNames A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*/
public void setPolicyNames(java.util.Collection policyNames) {
if (policyNames == null) {
this.policyNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag policyNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(policyNames.size());
policyNamesCopy.addAll(policyNames);
this.policyNames = policyNamesCopy;
}
/**
* A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param policyNames A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribePoliciesRequest withPolicyNames(String... policyNames) {
if (getPolicyNames() == null) setPolicyNames(new java.util.ArrayList(policyNames.length));
for (String value : policyNames) {
getPolicyNames().add(value);
}
return this;
}
/**
* A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param policyNames A list of policy names or policy ARNs to be described. If this list is
* omitted, all policy names are described. If an auto scaling group name
* is provided, the results are limited to that group. The list of
* requested policy names cannot contain more than 50 items. If unknown
* policy names are requested, they are ignored with no error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribePoliciesRequest withPolicyNames(java.util.Collection policyNames) {
if (policyNames == null) {
this.policyNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag policyNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(policyNames.size());
policyNamesCopy.addAll(policyNames);
this.policyNames = policyNamesCopy;
}
return this;
}
/**
* A string that is used to mark the start of the next batch of returned
* results for pagination.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return A string that is used to mark the start of the next batch of returned
* results for pagination.
*/
public String getNextToken() {
return nextToken;
}
/**
* A string that is used to mark the start of the next batch of returned
* results for pagination.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param nextToken A string that is used to mark the start of the next batch of returned
* results for pagination.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* A string that is used to mark the start of the next batch of returned
* results for pagination.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param nextToken A string that is used to mark the start of the next batch of returned
* results for pagination.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribePoliciesRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* The maximum number of policies that will be described with each call.
*
* Constraints:
* Range: 1 - 50
*
* @return The maximum number of policies that will be described with each call.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of policies that will be described with each call.
*
* Constraints:
* Range: 1 - 50
*
* @param maxRecords The maximum number of policies that will be described with each call.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of policies that will be described with each call.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 50
*
* @param maxRecords The maximum number of policies that will be described with each call.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribePoliciesRequest 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 (getAutoScalingGroupName() != null) sb.append("AutoScalingGroupName: " + getAutoScalingGroupName() + ",");
if (getPolicyNames() != null) sb.append("PolicyNames: " + getPolicyNames() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
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 + ((getAutoScalingGroupName() == null) ? 0 : getAutoScalingGroupName().hashCode());
hashCode = prime * hashCode + ((getPolicyNames() == null) ? 0 : getPolicyNames().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().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 DescribePoliciesRequest == false) return false;
DescribePoliciesRequest other = (DescribePoliciesRequest)obj;
if (other.getAutoScalingGroupName() == null ^ this.getAutoScalingGroupName() == null) return false;
if (other.getAutoScalingGroupName() != null && other.getAutoScalingGroupName().equals(this.getAutoScalingGroupName()) == false) return false;
if (other.getPolicyNames() == null ^ this.getPolicyNames() == null) return false;
if (other.getPolicyNames() != null && other.getPolicyNames().equals(this.getPolicyNames()) == false) return false;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == 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;
}
}