All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesRequest Maven / Gradle / Ivy

/*
 * Copyright 2015-2020 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 ListTaskDefinitionFamiliesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

* The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family * names that begin with the familyPrefix string are returned. *

*/ private String familyPrefix; /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

*/ private String status; /** *

* The nextToken value returned from a ListTaskDefinitionFamilies 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 task definition family results returned by ListTaskDefinitionFamilies in * paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies * request with the returned nextToken value. This value can be between 1 and 100. If this parameter is * not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken * value if applicable. *

*/ private Integer maxResults; /** *

* The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family * names that begin with the familyPrefix string are returned. *

* * @param familyPrefix * The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition * family names that begin with the familyPrefix string are returned. */ public void setFamilyPrefix(String familyPrefix) { this.familyPrefix = familyPrefix; } /** *

* The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family * names that begin with the familyPrefix string are returned. *

* * @return The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition * family names that begin with the familyPrefix string are returned. */ public String getFamilyPrefix() { return this.familyPrefix; } /** *

* The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family * names that begin with the familyPrefix string are returned. *

* * @param familyPrefix * The familyPrefix is a string that is used to filter the results of * ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition * family names that begin with the familyPrefix string are returned. * @return Returns a reference to this object so that method calls can be chained together. */ public ListTaskDefinitionFamiliesRequest withFamilyPrefix(String familyPrefix) { setFamilyPrefix(familyPrefix); return this; } /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

* * @param status * The task definition family status with which to filter the ListTaskDefinitionFamilies * results. By default, both ACTIVE and INACTIVE task definition families are * listed. If this parameter is set to ACTIVE, only task definition families that have an * ACTIVE task definition revision are returned. If this parameter is set to * INACTIVE, only task definition families that do not have any ACTIVE task * definition revisions are returned. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request. * @see TaskDefinitionFamilyStatus */ public void setStatus(String status) { this.status = status; } /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

* * @return The task definition family status with which to filter the ListTaskDefinitionFamilies * results. By default, both ACTIVE and INACTIVE task definition families are * listed. If this parameter is set to ACTIVE, only task definition families that have an * ACTIVE task definition revision are returned. If this parameter is set to * INACTIVE, only task definition families that do not have any ACTIVE task * definition revisions are returned. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request. * @see TaskDefinitionFamilyStatus */ public String getStatus() { return this.status; } /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

* * @param status * The task definition family status with which to filter the ListTaskDefinitionFamilies * results. By default, both ACTIVE and INACTIVE task definition families are * listed. If this parameter is set to ACTIVE, only task definition families that have an * ACTIVE task definition revision are returned. If this parameter is set to * INACTIVE, only task definition families that do not have any ACTIVE task * definition revisions are returned. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request. * @return Returns a reference to this object so that method calls can be chained together. * @see TaskDefinitionFamilyStatus */ public ListTaskDefinitionFamiliesRequest withStatus(String status) { setStatus(status); return this; } /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

* * @param status * The task definition family status with which to filter the ListTaskDefinitionFamilies * results. By default, both ACTIVE and INACTIVE task definition families are * listed. If this parameter is set to ACTIVE, only task definition families that have an * ACTIVE task definition revision are returned. If this parameter is set to * INACTIVE, only task definition families that do not have any ACTIVE task * definition revisions are returned. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request. * @see TaskDefinitionFamilyStatus */ public void setStatus(TaskDefinitionFamilyStatus status) { withStatus(status); } /** *

* The task definition family status with which to filter the ListTaskDefinitionFamilies results. By * default, both ACTIVE and INACTIVE task definition families are listed. If this * parameter is set to ACTIVE, only task definition families that have an ACTIVE task * definition revision are returned. If this parameter is set to INACTIVE, only task definition * families that do not have any ACTIVE task definition revisions are returned. If you paginate the * resulting output, be sure to keep the status value constant in each subsequent request. *

* * @param status * The task definition family status with which to filter the ListTaskDefinitionFamilies * results. By default, both ACTIVE and INACTIVE task definition families are * listed. If this parameter is set to ACTIVE, only task definition families that have an * ACTIVE task definition revision are returned. If this parameter is set to * INACTIVE, only task definition families that do not have any ACTIVE task * definition revisions are returned. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request. * @return Returns a reference to this object so that method calls can be chained together. * @see TaskDefinitionFamilyStatus */ public ListTaskDefinitionFamiliesRequest withStatus(TaskDefinitionFamilyStatus status) { this.status = status.toString(); return this; } /** *

* The nextToken value returned from a ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies 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 ListTaskDefinitionFamiliesRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

* The maximum number of task definition family results returned by ListTaskDefinitionFamilies in * paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies * request with the returned nextToken value. This value can be between 1 and 100. If this parameter is * not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken * value if applicable. *

* * @param maxResults * The maximum number of task definition family results returned by ListTaskDefinitionFamilies * in paginated output. When this parameter is used, ListTaskDefinitions 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 * ListTaskDefinitionFamilies request with the returned nextToken value. This value * can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies * returns up to 100 results and a nextToken value if applicable. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of task definition family results returned by ListTaskDefinitionFamilies in * paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies * request with the returned nextToken value. This value can be between 1 and 100. If this parameter is * not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken * value if applicable. *

* * @return The maximum number of task definition family results returned by ListTaskDefinitionFamilies * in paginated output. When this parameter is used, ListTaskDefinitions 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 * ListTaskDefinitionFamilies request with the returned nextToken value. This * value can be between 1 and 100. If this parameter is not used, then * ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if * applicable. */ public Integer getMaxResults() { return this.maxResults; } /** *

* The maximum number of task definition family results returned by ListTaskDefinitionFamilies in * paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitionFamilies * request with the returned nextToken value. This value can be between 1 and 100. If this parameter is * not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken * value if applicable. *

* * @param maxResults * The maximum number of task definition family results returned by ListTaskDefinitionFamilies * in paginated output. When this parameter is used, ListTaskDefinitions 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 * ListTaskDefinitionFamilies request with the returned nextToken value. This value * can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies * returns up to 100 results and a nextToken value if applicable. * @return Returns a reference to this object so that method calls can be chained together. */ public ListTaskDefinitionFamiliesRequest 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 (getFamilyPrefix() != null) sb.append("FamilyPrefix: ").append(getFamilyPrefix()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).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 ListTaskDefinitionFamiliesRequest == false) return false; ListTaskDefinitionFamiliesRequest other = (ListTaskDefinitionFamiliesRequest) obj; if (other.getFamilyPrefix() == null ^ this.getFamilyPrefix() == null) return false; if (other.getFamilyPrefix() != null && other.getFamilyPrefix().equals(this.getFamilyPrefix()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == 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 + ((getFamilyPrefix() == null) ? 0 : getFamilyPrefix().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); return hashCode; } @Override public ListTaskDefinitionFamiliesRequest clone() { return (ListTaskDefinitionFamiliesRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy