com.amazonaws.services.ecs.model.DescribeClustersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs 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.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 DescribeClustersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
* cluster, the default cluster is assumed.
*
*/
private com.amazonaws.internal.SdkInternalList clusters;
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*/
private com.amazonaws.internal.SdkInternalList include;
/**
*
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
* cluster, the default cluster is assumed.
*
*
* @return A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not
* specify a cluster, the default cluster is assumed.
*/
public java.util.List getClusters() {
if (clusters == null) {
clusters = new com.amazonaws.internal.SdkInternalList();
}
return clusters;
}
/**
*
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
* cluster, the default cluster is assumed.
*
*
* @param clusters
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not
* specify a cluster, the default cluster is assumed.
*/
public void setClusters(java.util.Collection clusters) {
if (clusters == null) {
this.clusters = null;
return;
}
this.clusters = new com.amazonaws.internal.SdkInternalList(clusters);
}
/**
*
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
* cluster, the default cluster is assumed.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setClusters(java.util.Collection)} or {@link #withClusters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param clusters
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. 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 DescribeClustersRequest withClusters(String... clusters) {
if (this.clusters == null) {
setClusters(new com.amazonaws.internal.SdkInternalList(clusters.length));
}
for (String ele : clusters) {
this.clusters.add(ele);
}
return this;
}
/**
*
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
* cluster, the default cluster is assumed.
*
*
* @param clusters
* A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. 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 DescribeClustersRequest withClusters(java.util.Collection clusters) {
setClusters(clusters);
return this;
}
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*
* @return Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the
* cluster are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch
* type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
* @see ClusterField
*/
public java.util.List getInclude() {
if (include == null) {
include = new com.amazonaws.internal.SdkInternalList();
}
return include;
}
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*
* @param include
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the
* cluster are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
* @see ClusterField
*/
public void setInclude(java.util.Collection include) {
if (include == null) {
this.include = null;
return;
}
this.include = new com.amazonaws.internal.SdkInternalList(include);
}
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInclude(java.util.Collection)} or {@link #withInclude(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param include
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the
* cluster are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterField
*/
public DescribeClustersRequest withInclude(String... include) {
if (this.include == null) {
setInclude(new com.amazonaws.internal.SdkInternalList(include.length));
}
for (String ele : include) {
this.include.add(ele);
}
return this;
}
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*
* @param include
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the
* cluster are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterField
*/
public DescribeClustersRequest withInclude(java.util.Collection include) {
setInclude(include);
return this;
}
/**
*
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
* are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
*
*
* @param include
* Determines whether to include additional information about the clusters in the response. If this field is
* omitted, this information isn't included.
*
* If ATTACHMENTS is specified, the attachments for the container instances or tasks within the
* cluster are included, for example the capacity providers.
*
*
* If SETTINGS is specified, the settings for the cluster are included.
*
*
* If CONFIGURATIONS is specified, the configuration for the cluster is included.
*
*
* If STATISTICS is specified, the task and service count is included, separated by launch type.
*
*
* If TAGS is specified, the metadata tags associated with the cluster are included.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterField
*/
public DescribeClustersRequest withInclude(ClusterField... include) {
com.amazonaws.internal.SdkInternalList includeCopy = new com.amazonaws.internal.SdkInternalList(include.length);
for (ClusterField value : include) {
includeCopy.add(value.toString());
}
if (getInclude() == null) {
setInclude(includeCopy);
} else {
getInclude().addAll(includeCopy);
}
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 (getClusters() != null)
sb.append("Clusters: ").append(getClusters()).append(",");
if (getInclude() != null)
sb.append("Include: ").append(getInclude());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeClustersRequest == false)
return false;
DescribeClustersRequest other = (DescribeClustersRequest) obj;
if (other.getClusters() == null ^ this.getClusters() == null)
return false;
if (other.getClusters() != null && other.getClusters().equals(this.getClusters()) == false)
return false;
if (other.getInclude() == null ^ this.getInclude() == null)
return false;
if (other.getInclude() != null && other.getInclude().equals(this.getInclude()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClusters() == null) ? 0 : getClusters().hashCode());
hashCode = prime * hashCode + ((getInclude() == null) ? 0 : getInclude().hashCode());
return hashCode;
}
@Override
public DescribeClustersRequest clone() {
return (DescribeClustersRequest) super.clone();
}
}