com.amazonaws.services.ecs.model.ListServicesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2018-2023 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.ecs.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 ListServicesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*
*/
private String cluster;
/**
*
* The nextToken value returned from a ListServices request indicating that more results
* are available to fulfill the request and further calls will be needed. If maxResults was provided,
* it is possible the number of results to be fewer than maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*/
private String nextToken;
/**
*
* The maximum number of service results that ListServices returned in paginated output. When this
* parameter is used, ListServices only returns maxResults results in a single page along
* with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListServices request with the returned nextToken value. This value can
* be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a
* nextToken value if applicable.
*
*/
private Integer maxResults;
/**
*
* The launch type to use when filtering the ListServices results.
*
*/
private String launchType;
/**
*
* The scheduling strategy to use when filtering the ListServices results.
*
*/
private String schedulingStrategy;
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*/
public void setCluster(String cluster) {
this.cluster = cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*
*
* @return The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*/
public String getCluster() {
return this.cluster;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
* ListServices results. If you do not specify a cluster, the default cluster is assumed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListServicesRequest withCluster(String cluster) {
setCluster(cluster);
return this;
}
/**
*
* The nextToken value returned from a ListServices request indicating that more results
* are available to fulfill the request and further calls will be needed. If maxResults was provided,
* it is possible the number of results to be fewer than maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a ListServices request indicating that more
* results are available to fulfill the request and further calls will be needed. If maxResults
* was provided, it is possible the number of results to be fewer than maxResults.
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a ListServices request indicating that more results
* are available to fulfill the request and further calls will be needed. If maxResults was provided,
* it is possible the number of results to be fewer than maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @return The nextToken value returned from a ListServices request indicating that more
* results are available to fulfill the request and further calls will be needed. If maxResults
* was provided, it is possible the number of results to be fewer than maxResults.
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a ListServices request indicating that more results
* are available to fulfill the request and further calls will be needed. If maxResults was provided,
* it is possible the number of results to be fewer than maxResults.
*
*
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a ListServices request indicating that more
* results are available to fulfill the request and further calls will be needed. If maxResults
* was provided, it is possible the number of results to be fewer than maxResults.
*
* This token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListServicesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of service results that ListServices returned in paginated output. When this
* parameter is used, ListServices only returns maxResults results in a single page along
* with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListServices request with the returned nextToken value. This value can
* be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of service results that ListServices returned in paginated output. When
* this parameter is used, ListServices only returns maxResults results in a single
* page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListServices request with the returned nextToken
* value. This value can be between 1 and 100. If this parameter isn't used, then ListServices
* returns up to 10 results and a nextToken value if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of service results that ListServices returned in paginated output. When this
* parameter is used, ListServices only returns maxResults results in a single page along
* with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListServices request with the returned nextToken value. This value can
* be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a
* nextToken value if applicable.
*
*
* @return The maximum number of service results that ListServices returned in paginated output. When
* this parameter is used, ListServices only returns maxResults results in a
* single page along with a nextToken response element. The remaining results of the initial
* request can be seen by sending another ListServices request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListServices returns up to 10 results and a nextToken value if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of service results that ListServices returned in paginated output. When this
* parameter is used, ListServices only returns maxResults results in a single page along
* with a nextToken response element. The remaining results of the initial request can be seen by
* sending another ListServices request with the returned nextToken value. This value can
* be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a
* nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of service results that ListServices returned in paginated output. When
* this parameter is used, ListServices only returns maxResults results in a single
* page along with a nextToken response element. The remaining results of the initial request
* can be seen by sending another ListServices request with the returned nextToken
* value. This value can be between 1 and 100. If this parameter isn't used, then ListServices
* returns up to 10 results and a nextToken value if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListServicesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The launch type to use when filtering the ListServices results.
*
*
* @param launchType
* The launch type to use when filtering the ListServices results.
* @see LaunchType
*/
public void setLaunchType(String launchType) {
this.launchType = launchType;
}
/**
*
* The launch type to use when filtering the ListServices results.
*
*
* @return The launch type to use when filtering the ListServices results.
* @see LaunchType
*/
public String getLaunchType() {
return this.launchType;
}
/**
*
* The launch type to use when filtering the ListServices results.
*
*
* @param launchType
* The launch type to use when filtering the ListServices results.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public ListServicesRequest withLaunchType(String launchType) {
setLaunchType(launchType);
return this;
}
/**
*
* The launch type to use when filtering the ListServices results.
*
*
* @param launchType
* The launch type to use when filtering the ListServices results.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LaunchType
*/
public ListServicesRequest withLaunchType(LaunchType launchType) {
this.launchType = launchType.toString();
return this;
}
/**
*
* The scheduling strategy to use when filtering the ListServices results.
*
*
* @param schedulingStrategy
* The scheduling strategy to use when filtering the ListServices results.
* @see SchedulingStrategy
*/
public void setSchedulingStrategy(String schedulingStrategy) {
this.schedulingStrategy = schedulingStrategy;
}
/**
*
* The scheduling strategy to use when filtering the ListServices results.
*
*
* @return The scheduling strategy to use when filtering the ListServices results.
* @see SchedulingStrategy
*/
public String getSchedulingStrategy() {
return this.schedulingStrategy;
}
/**
*
* The scheduling strategy to use when filtering the ListServices results.
*
*
* @param schedulingStrategy
* The scheduling strategy to use when filtering the ListServices results.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SchedulingStrategy
*/
public ListServicesRequest withSchedulingStrategy(String schedulingStrategy) {
setSchedulingStrategy(schedulingStrategy);
return this;
}
/**
*
* The scheduling strategy to use when filtering the ListServices results.
*
*
* @param schedulingStrategy
* The scheduling strategy to use when filtering the ListServices results.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SchedulingStrategy
*/
public ListServicesRequest withSchedulingStrategy(SchedulingStrategy schedulingStrategy) {
this.schedulingStrategy = schedulingStrategy.toString();
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 (getCluster() != null)
sb.append("Cluster: ").append(getCluster()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getLaunchType() != null)
sb.append("LaunchType: ").append(getLaunchType()).append(",");
if (getSchedulingStrategy() != null)
sb.append("SchedulingStrategy: ").append(getSchedulingStrategy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListServicesRequest == false)
return false;
ListServicesRequest other = (ListServicesRequest) obj;
if (other.getCluster() == null ^ this.getCluster() == null)
return false;
if (other.getCluster() != null && other.getCluster().equals(this.getCluster()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getLaunchType() == null ^ this.getLaunchType() == null)
return false;
if (other.getLaunchType() != null && other.getLaunchType().equals(this.getLaunchType()) == false)
return false;
if (other.getSchedulingStrategy() == null ^ this.getSchedulingStrategy() == null)
return false;
if (other.getSchedulingStrategy() != null && other.getSchedulingStrategy().equals(this.getSchedulingStrategy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCluster() == null) ? 0 : getCluster().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getLaunchType() == null) ? 0 : getLaunchType().hashCode());
hashCode = prime * hashCode + ((getSchedulingStrategy() == null) ? 0 : getSchedulingStrategy().hashCode());
return hashCode;
}
@Override
public ListServicesRequest clone() {
return (ListServicesRequest) super.clone();
}
}