com.amazonaws.services.gamelift.model.DescribeMatchmakingConfigurationsRequest 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 DescribeMatchmakingConfigurationsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name
* or ARN value. To request all existing configurations, leave this parameter empty.
*
*/
private java.util.List names;
/**
*
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this
* parameter to retrieve all matchmaking configurations that use this rule set.
*
*/
private String ruleSetName;
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages. This parameter is limited to 10.
*
*/
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 matchmaking configuration(s) to retrieve. You can use either the configuration name
* or ARN value. To request all existing configurations, leave this parameter empty.
*
*
* @return A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the
* configuration name or ARN value. To request all existing configurations, leave this parameter empty.
*/
public java.util.List getNames() {
return names;
}
/**
*
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name
* or ARN value. To request all existing configurations, leave this parameter empty.
*
*
* @param names
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration
* name or ARN value. To request all existing configurations, leave this parameter empty.
*/
public void setNames(java.util.Collection names) {
if (names == null) {
this.names = null;
return;
}
this.names = new java.util.ArrayList(names);
}
/**
*
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name
* or ARN value. To request all existing configurations, leave this parameter empty.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNames(java.util.Collection)} or {@link #withNames(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param names
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration
* name or ARN value. To request all existing configurations, leave this parameter empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeMatchmakingConfigurationsRequest withNames(String... names) {
if (this.names == null) {
setNames(new java.util.ArrayList(names.length));
}
for (String ele : names) {
this.names.add(ele);
}
return this;
}
/**
*
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name
* or ARN value. To request all existing configurations, leave this parameter empty.
*
*
* @param names
* A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration
* name or ARN value. To request all existing configurations, leave this parameter empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeMatchmakingConfigurationsRequest withNames(java.util.Collection names) {
setNames(names);
return this;
}
/**
*
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this
* parameter to retrieve all matchmaking configurations that use this rule set.
*
*
* @param ruleSetName
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use
* this parameter to retrieve all matchmaking configurations that use this rule set.
*/
public void setRuleSetName(String ruleSetName) {
this.ruleSetName = ruleSetName;
}
/**
*
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this
* parameter to retrieve all matchmaking configurations that use this rule set.
*
*
* @return A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use
* this parameter to retrieve all matchmaking configurations that use this rule set.
*/
public String getRuleSetName() {
return this.ruleSetName;
}
/**
*
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this
* parameter to retrieve all matchmaking configurations that use this rule set.
*
*
* @param ruleSetName
* A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use
* this parameter to retrieve all matchmaking configurations that use this rule set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeMatchmakingConfigurationsRequest withRuleSetName(String ruleSetName) {
setRuleSetName(ruleSetName);
return this;
}
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages. This parameter is limited to 10.
*
*
* @param limit
* The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages. This parameter is limited to 10.
*/
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. This parameter is limited to 10.
*
*
* @return The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages. This parameter is limited to 10.
*/
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. This parameter is limited to 10.
*
*
* @param limit
* The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages. This parameter is limited to 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeMatchmakingConfigurationsRequest 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 DescribeMatchmakingConfigurationsRequest 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 (getNames() != null)
sb.append("Names: ").append(getNames()).append(",");
if (getRuleSetName() != null)
sb.append("RuleSetName: ").append(getRuleSetName()).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 DescribeMatchmakingConfigurationsRequest == false)
return false;
DescribeMatchmakingConfigurationsRequest other = (DescribeMatchmakingConfigurationsRequest) obj;
if (other.getNames() == null ^ this.getNames() == null)
return false;
if (other.getNames() != null && other.getNames().equals(this.getNames()) == false)
return false;
if (other.getRuleSetName() == null ^ this.getRuleSetName() == null)
return false;
if (other.getRuleSetName() != null && other.getRuleSetName().equals(this.getRuleSetName()) == 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 + ((getNames() == null) ? 0 : getNames().hashCode());
hashCode = prime * hashCode + ((getRuleSetName() == null) ? 0 : getRuleSetName().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeMatchmakingConfigurationsRequest clone() {
return (DescribeMatchmakingConfigurationsRequest) super.clone();
}
}