com.amazonaws.services.gamelift.model.DescribeScalingPoliciesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift 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.gamelift.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeScalingPoliciesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN
* value.
*
*/
private String fleetId;
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*/
private String statusFilter;
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages.
*
*/
private Integer limit;
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning of the result set, do not specify a value.
*
*/
private String nextToken;
/**
*
* The fleet location. If you don't specify this value, the response contains the scaling policies of every location
* in the fleet.
*
*/
private String location;
/**
*
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN
* value.
*
*
* @param fleetId
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID
* or ARN value.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN
* value.
*
*
* @return A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID
* or ARN value.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN
* value.
*
*
* @param fleetId
* A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID
* or ARN value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScalingPoliciesRequest withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*
* @param statusFilter
* Scaling policy status to filter results on. A scaling policy is only in force when in an
* ACTIVE status.
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
* @see ScalingStatusType
*/
public void setStatusFilter(String statusFilter) {
this.statusFilter = statusFilter;
}
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*
* @return Scaling policy status to filter results on. A scaling policy is only in force when in an
* ACTIVE status.
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
* @see ScalingStatusType
*/
public String getStatusFilter() {
return this.statusFilter;
}
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*
* @param statusFilter
* Scaling policy status to filter results on. A scaling policy is only in force when in an
* ACTIVE status.
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingStatusType
*/
public DescribeScalingPoliciesRequest withStatusFilter(String statusFilter) {
setStatusFilter(statusFilter);
return this;
}
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*
* @param statusFilter
* Scaling policy status to filter results on. A scaling policy is only in force when in an
* ACTIVE status.
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
* @see ScalingStatusType
*/
public void setStatusFilter(ScalingStatusType statusFilter) {
withStatusFilter(statusFilter);
}
/**
*
* Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
* status.
*
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
*
*
* @param statusFilter
* Scaling policy status to filter results on. A scaling policy is only in force when in an
* ACTIVE status.
*
* -
*
* ACTIVE -- The scaling policy is currently in force.
*
*
* -
*
* UPDATEREQUESTED -- A request to update the scaling policy has been received.
*
*
* -
*
* UPDATING -- A change is being made to the scaling policy.
*
*
* -
*
* DELETEREQUESTED -- A request to delete the scaling policy has been received.
*
*
* -
*
* DELETING -- The scaling policy is being deleted.
*
*
* -
*
* DELETED -- The scaling policy has been deleted.
*
*
* -
*
* ERROR -- An error occurred in creating the policy. It should be removed and recreated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingStatusType
*/
public DescribeScalingPoliciesRequest withStatusFilter(ScalingStatusType statusFilter) {
this.statusFilter = statusFilter.toString();
return this;
}
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages.
*
*
* @param limit
* The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages.
*
*
* @return The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages.
*
*
* @param limit
* The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScalingPoliciesRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning of the result set, do not specify a value.
*
*
* @param nextToken
* A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning of the result set, do not specify a
* value.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning of the result set, do not specify a value.
*
*
* @return A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning of the result set, do not specify a
* value.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token that indicates the start of the next sequential page of results. Use the token that is returned with a
* previous call to this operation. To start at the beginning of the result set, do not specify a value.
*
*
* @param nextToken
* A token that indicates the start of the next sequential page of results. Use the token that is returned
* with a previous call to this operation. To start at the beginning of the result set, do not specify a
* value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScalingPoliciesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The fleet location. If you don't specify this value, the response contains the scaling policies of every location
* in the fleet.
*
*
* @param location
* The fleet location. If you don't specify this value, the response contains the scaling policies of every
* location in the fleet.
*/
public void setLocation(String location) {
this.location = location;
}
/**
*
* The fleet location. If you don't specify this value, the response contains the scaling policies of every location
* in the fleet.
*
*
* @return The fleet location. If you don't specify this value, the response contains the scaling policies of every
* location in the fleet.
*/
public String getLocation() {
return this.location;
}
/**
*
* The fleet location. If you don't specify this value, the response contains the scaling policies of every location
* in the fleet.
*
*
* @param location
* The fleet location. If you don't specify this value, the response contains the scaling policies of every
* location in the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScalingPoliciesRequest withLocation(String location) {
setLocation(location);
return this;
}
/**
* 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 (getFleetId() != null)
sb.append("FleetId: ").append(getFleetId()).append(",");
if (getStatusFilter() != null)
sb.append("StatusFilter: ").append(getStatusFilter()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getLocation() != null)
sb.append("Location: ").append(getLocation());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeScalingPoliciesRequest == false)
return false;
DescribeScalingPoliciesRequest other = (DescribeScalingPoliciesRequest) obj;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null && other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getStatusFilter() == null ^ this.getStatusFilter() == null)
return false;
if (other.getStatusFilter() != null && other.getStatusFilter().equals(this.getStatusFilter()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == 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.getLocation() == null ^ this.getLocation() == null)
return false;
if (other.getLocation() != null && other.getLocation().equals(this.getLocation()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFleetId() == null) ? 0 : getFleetId().hashCode());
hashCode = prime * hashCode + ((getStatusFilter() == null) ? 0 : getStatusFilter().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getLocation() == null) ? 0 : getLocation().hashCode());
return hashCode;
}
@Override
public DescribeScalingPoliciesRequest clone() {
return (DescribeScalingPoliciesRequest) super.clone();
}
}