com.amazonaws.services.gamelift.model.ListFleetsRequest 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 ListFleetsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*
*/
private String buildId;
/**
*
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using
* a specified script. Use either the script ID or ARN value.
*
*/
private String scriptId;
/**
*
* The container group definition name to request fleets for. Use this parameter to return only fleets that are
* deployed with the specified container group definition.
*
*/
private String containerGroupDefinitionName;
/**
*
* 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;
/**
*
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*
*
* @param buildId
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*/
public void setBuildId(String buildId) {
this.buildId = buildId;
}
/**
*
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*
*
* @return A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*/
public String getBuildId() {
return this.buildId;
}
/**
*
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
*
*
* @param buildId
* A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
* specified build. Use either the build ID or ARN value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFleetsRequest withBuildId(String buildId) {
setBuildId(buildId);
return this;
}
/**
*
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using
* a specified script. Use either the script ID or ARN value.
*
*
* @param scriptId
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only
* fleets using a specified script. Use either the script ID or ARN value.
*/
public void setScriptId(String scriptId) {
this.scriptId = scriptId;
}
/**
*
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using
* a specified script. Use either the script ID or ARN value.
*
*
* @return A unique identifier for the Realtime script to request fleets for. Use this parameter to return only
* fleets using a specified script. Use either the script ID or ARN value.
*/
public String getScriptId() {
return this.scriptId;
}
/**
*
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using
* a specified script. Use either the script ID or ARN value.
*
*
* @param scriptId
* A unique identifier for the Realtime script to request fleets for. Use this parameter to return only
* fleets using a specified script. Use either the script ID or ARN value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFleetsRequest withScriptId(String scriptId) {
setScriptId(scriptId);
return this;
}
/**
*
* The container group definition name to request fleets for. Use this parameter to return only fleets that are
* deployed with the specified container group definition.
*
*
* @param containerGroupDefinitionName
* The container group definition name to request fleets for. Use this parameter to return only fleets that
* are deployed with the specified container group definition.
*/
public void setContainerGroupDefinitionName(String containerGroupDefinitionName) {
this.containerGroupDefinitionName = containerGroupDefinitionName;
}
/**
*
* The container group definition name to request fleets for. Use this parameter to return only fleets that are
* deployed with the specified container group definition.
*
*
* @return The container group definition name to request fleets for. Use this parameter to return only fleets that
* are deployed with the specified container group definition.
*/
public String getContainerGroupDefinitionName() {
return this.containerGroupDefinitionName;
}
/**
*
* The container group definition name to request fleets for. Use this parameter to return only fleets that are
* deployed with the specified container group definition.
*
*
* @param containerGroupDefinitionName
* The container group definition name to request fleets for. Use this parameter to return only fleets that
* are deployed with the specified container group definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFleetsRequest withContainerGroupDefinitionName(String containerGroupDefinitionName) {
setContainerGroupDefinitionName(containerGroupDefinitionName);
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 ListFleetsRequest 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 ListFleetsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getBuildId() != null)
sb.append("BuildId: ").append(getBuildId()).append(",");
if (getScriptId() != null)
sb.append("ScriptId: ").append(getScriptId()).append(",");
if (getContainerGroupDefinitionName() != null)
sb.append("ContainerGroupDefinitionName: ").append(getContainerGroupDefinitionName()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListFleetsRequest == false)
return false;
ListFleetsRequest other = (ListFleetsRequest) obj;
if (other.getBuildId() == null ^ this.getBuildId() == null)
return false;
if (other.getBuildId() != null && other.getBuildId().equals(this.getBuildId()) == false)
return false;
if (other.getScriptId() == null ^ this.getScriptId() == null)
return false;
if (other.getScriptId() != null && other.getScriptId().equals(this.getScriptId()) == false)
return false;
if (other.getContainerGroupDefinitionName() == null ^ this.getContainerGroupDefinitionName() == null)
return false;
if (other.getContainerGroupDefinitionName() != null && other.getContainerGroupDefinitionName().equals(this.getContainerGroupDefinitionName()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBuildId() == null) ? 0 : getBuildId().hashCode());
hashCode = prime * hashCode + ((getScriptId() == null) ? 0 : getScriptId().hashCode());
hashCode = prime * hashCode + ((getContainerGroupDefinitionName() == null) ? 0 : getContainerGroupDefinitionName().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListFleetsRequest clone() {
return (ListFleetsRequest) super.clone();
}
}