com.amazonaws.services.gamelift.model.DescribeInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2017-2022 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;
/**
*
* Represents the input for a request operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeInstancesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN
* value.
*
*/
private String fleetId;
/**
*
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances
* in the fleet.
*
*/
private String instanceId;
/**
*
* 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 name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code
* such as us-west-2.
*
*/
private String location;
/**
*
* A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN
* value.
*
*
* @param fleetId
* A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or
* ARN value.
*/
public void setFleetId(String fleetId) {
this.fleetId = fleetId;
}
/**
*
* A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN
* value.
*
*
* @return A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID
* or ARN value.
*/
public String getFleetId() {
return this.fleetId;
}
/**
*
* A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN
* value.
*
*
* @param fleetId
* A unique identifier for the fleet to retrieve instance information for. 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 DescribeInstancesRequest withFleetId(String fleetId) {
setFleetId(fleetId);
return this;
}
/**
*
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances
* in the fleet.
*
*
* @param instanceId
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all
* instances in the fleet.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
*
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances
* in the fleet.
*
*
* @return A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all
* instances in the fleet.
*/
public String getInstanceId() {
return this.instanceId;
}
/**
*
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances
* in the fleet.
*
*
* @param instanceId
* A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all
* instances in the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstancesRequest withInstanceId(String instanceId) {
setInstanceId(instanceId);
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 DescribeInstancesRequest 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 DescribeInstancesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code
* such as us-west-2.
*
*
* @param location
* The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region
* code such as us-west-2.
*/
public void setLocation(String location) {
this.location = location;
}
/**
*
* The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code
* such as us-west-2.
*
*
* @return The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region
* code such as us-west-2.
*/
public String getLocation() {
return this.location;
}
/**
*
* The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code
* such as us-west-2.
*
*
* @param location
* The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region
* code such as us-west-2.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeInstancesRequest 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 (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).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 DescribeInstancesRequest == false)
return false;
DescribeInstancesRequest other = (DescribeInstancesRequest) obj;
if (other.getFleetId() == null ^ this.getFleetId() == null)
return false;
if (other.getFleetId() != null && other.getFleetId().equals(this.getFleetId()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == 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 + ((getInstanceId() == null) ? 0 : getInstanceId().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 DescribeInstancesRequest clone() {
return (DescribeInstancesRequest) super.clone();
}
}