com.amazonaws.services.ecs.model.ListServicesByNamespaceRequest 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 ListServicesByNamespaceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
*
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to
* services across all of the clusters in the namespace. Tasks connect through a managed proxy container that
* collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported
* with Service Connect. For more information, see Service Connect in
* the Amazon Elastic Container Service Developer Guide.
*
*/
private String namespace;
/**
*
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than maxResults.
*
*/
private String nextToken;
/**
*
* The maximum number of service results that ListServicesByNamespace returns in paginated output. When
* this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.
*
*/
private Integer maxResults;
/**
*
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
*
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to
* services across all of the clusters in the namespace. Tasks connect through a managed proxy container that
* collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported
* with Service Connect. For more information, see Service Connect in
* the Amazon Elastic Container Service Developer Guide.
*
*
* @param namespace
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services
* in.
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can
* connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy
* container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services
* create are supported with Service Connect. For more information, see Service
* Connect in the Amazon Elastic Container Service Developer Guide.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
*
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to
* services across all of the clusters in the namespace. Tasks connect through a managed proxy container that
* collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported
* with Service Connect. For more information, see Service Connect in
* the Amazon Elastic Container Service Developer Guide.
*
*
* @return The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services
* in.
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can
* connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy
* container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS
* services create are supported with Service Connect. For more information, see Service
* Connect in the Amazon Elastic Container Service Developer Guide.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
*
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to
* services across all of the clusters in the namespace. Tasks connect through a managed proxy container that
* collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported
* with Service Connect. For more information, see Service Connect in
* the Amazon Elastic Container Service Developer Guide.
*
*
* @param namespace
* The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services
* in.
*
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can
* connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy
* container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services
* create are supported with Service Connect. For more information, see Service
* Connect in the Amazon Elastic Container Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListServicesByNamespaceRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than maxResults.
*
*
* @param nextToken
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than
* maxResults.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than maxResults.
*
*
* @return The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than
* maxResults.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than maxResults.
*
*
* @param nextToken
* The nextToken value that's returned from a ListServicesByNamespace request. It
* indicates that more results are available to fulfill the request and further calls are needed. If
* maxResults is returned, it is possible the number of results is less than
* maxResults.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListServicesByNamespaceRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of service results that ListServicesByNamespace returns in paginated output. When
* this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of service results that ListServicesByNamespace returns in paginated
* output. When this parameter is used, ListServicesByNamespace 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
* ListServicesByNamespace request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace 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 ListServicesByNamespace returns in paginated output. When
* this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.
*
*
* @return The maximum number of service results that ListServicesByNamespace returns in paginated
* output. When this parameter is used, ListServicesByNamespace 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
* ListServicesByNamespace request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns
* up to 10 results and a nextToken value if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of service results that ListServicesByNamespace returns in paginated output. When
* this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned
* nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
* ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.
*
*
* @param maxResults
* The maximum number of service results that ListServicesByNamespace returns in paginated
* output. When this parameter is used, ListServicesByNamespace 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
* ListServicesByNamespace request with the returned nextToken value. This value
* can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace 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 ListServicesByNamespaceRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListServicesByNamespaceRequest == false)
return false;
ListServicesByNamespaceRequest other = (ListServicesByNamespaceRequest) obj;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ListServicesByNamespaceRequest clone() {
return (ListServicesByNamespaceRequest) super.clone();
}
}