Java tutorial
/* * Copyright 2014-2019 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.ec2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeVpcEndpointsRequestMarshaller; /** * <p> * Contains the parameters for DescribeVpcEndpoints. * </p> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVpcEndpointsRequest> { /** * <p> * One or more endpoint IDs. * </p> */ private com.amazonaws.internal.SdkInternalList<String> vpcEndpointIds; /** * <p> * One or more filters. * </p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all resources that have a tag with * the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name * and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned * a tag with a specific key, regardless of the tag value. * </p> * </li> * </ul> */ private com.amazonaws.internal.SdkInternalList<Filter> filters; /** * <p> * The maximum number of items to return for this request. The request returns a token that you can specify in a * subsequent call to get the next set of results. * </p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. * </p> */ private Integer maxResults; /** * <p> * The token for the next set of items to return. (You received this token from a prior call.) * </p> */ private String nextToken; /** * <p> * One or more endpoint IDs. * </p> * * @return One or more endpoint IDs. */ public java.util.List<String> getVpcEndpointIds() { if (vpcEndpointIds == null) { vpcEndpointIds = new com.amazonaws.internal.SdkInternalList<String>(); } return vpcEndpointIds; } /** * <p> * One or more endpoint IDs. * </p> * * @param vpcEndpointIds * One or more endpoint IDs. */ public void setVpcEndpointIds(java.util.Collection<String> vpcEndpointIds) { if (vpcEndpointIds == null) { this.vpcEndpointIds = null; return; } this.vpcEndpointIds = new com.amazonaws.internal.SdkInternalList<String>(vpcEndpointIds); } /** * <p> * One or more endpoint IDs. * </p> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setVpcEndpointIds(java.util.Collection)} or {@link #withVpcEndpointIds(java.util.Collection)} if you want * to override the existing values. * </p> * * @param vpcEndpointIds * One or more endpoint IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withVpcEndpointIds(String... vpcEndpointIds) { if (this.vpcEndpointIds == null) { setVpcEndpointIds(new com.amazonaws.internal.SdkInternalList<String>(vpcEndpointIds.length)); } for (String ele : vpcEndpointIds) { this.vpcEndpointIds.add(ele); } return this; } /** * <p> * One or more endpoint IDs. * </p> * * @param vpcEndpointIds * One or more endpoint IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withVpcEndpointIds(java.util.Collection<String> vpcEndpointIds) { setVpcEndpointIds(vpcEndpointIds); return this; } /** * <p> * One or more filters. * </p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all resources that have a tag with * the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name * and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned * a tag with a specific key, regardless of the tag value. * </p> * </li> * </ul> * * @return One or more filters.</p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag * key in the filter name and the tag value as the filter value. For example, to find all resources that * have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify * <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources * assigned a tag with a specific key, regardless of the tag value. * </p> * </li> */ public java.util.List<Filter> getFilters() { if (filters == null) { filters = new com.amazonaws.internal.SdkInternalList<Filter>(); } return filters; } /** * <p> * One or more filters. * </p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all resources that have a tag with * the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name * and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned * a tag with a specific key, regardless of the tag value. * </p> * </li> * </ul> * * @param filters * One or more filters.</p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag * key in the filter name and the tag value as the filter value. For example, to find all resources that have * a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for * the filter name and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources * assigned a tag with a specific key, regardless of the tag value. * </p> * </li> */ public void setFilters(java.util.Collection<Filter> filters) { if (filters == null) { this.filters = null; return; } this.filters = new com.amazonaws.internal.SdkInternalList<Filter>(filters); } /** * <p> * One or more filters. * </p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all resources that have a tag with * the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name * and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned * a tag with a specific key, regardless of the tag value. * </p> * </li> * </ul> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. * </p> * * @param filters * One or more filters.</p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag * key in the filter name and the tag value as the filter value. For example, to find all resources that have * a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for * the filter name and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources * assigned a tag with a specific key, regardless of the tag value. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withFilters(Filter... filters) { if (this.filters == null) { setFilters(new com.amazonaws.internal.SdkInternalList<Filter>(filters.length)); } for (Filter ele : filters) { this.filters.add(ele); } return this; } /** * <p> * One or more filters. * </p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all resources that have a tag with * the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name * and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned * a tag with a specific key, regardless of the tag value. * </p> * </li> * </ul> * * @param filters * One or more filters.</p> * <ul> * <li> * <p> * <code>service-name</code>: The name of the service. * </p> * </li> * <li> * <p> * <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-id</code>: The ID of the endpoint. * </p> * </li> * <li> * <p> * <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | * <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | * <code>rejected</code> | <code>failed</code>). * </p> * </li> * <li> * <p> * <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag * key in the filter name and the tag value as the filter value. For example, to find all resources that have * a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for * the filter name and <code>TeamA</code> for the filter value. * </p> * </li> * <li> * <p> * <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources * assigned a tag with a specific key, regardless of the tag value. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withFilters(java.util.Collection<Filter> filters) { setFilters(filters); return this; } /** * <p> * The maximum number of items to return for this request. The request returns a token that you can specify in a * subsequent call to get the next set of results. * </p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. * </p> * * @param maxResults * The maximum number of items to return for this request. The request returns a token that you can specify * in a subsequent call to get the next set of results.</p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** * <p> * The maximum number of items to return for this request. The request returns a token that you can specify in a * subsequent call to get the next set of results. * </p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. * </p> * * @return The maximum number of items to return for this request. The request returns a token that you can specify * in a subsequent call to get the next set of results.</p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. */ public Integer getMaxResults() { return this.maxResults; } /** * <p> * The maximum number of items to return for this request. The request returns a token that you can specify in a * subsequent call to get the next set of results. * </p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. * </p> * * @param maxResults * The maximum number of items to return for this request. The request returns a token that you can specify * in a subsequent call to get the next set of results.</p> * <p> * Constraint: If the value is greater than 1000, we return only 1000 items. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** * <p> * The token for the next set of items to return. (You received this token from a prior call.) * </p> * * @param nextToken * The token for the next set of items to return. (You received this token from a prior call.) */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** * <p> * The token for the next set of items to return. (You received this token from a prior call.) * </p> * * @return The token for the next set of items to return. (You received this token from a prior call.) */ public String getNextToken() { return this.nextToken; } /** * <p> * The token for the next set of items to return. (You received this token from a prior call.) * </p> * * @param nextToken * The token for the next set of items to return. (You received this token from a prior call.) * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcEndpointsRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request<DescribeVpcEndpointsRequest> getDryRunRequest() { Request<DescribeVpcEndpointsRequest> request = new DescribeVpcEndpointsRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * 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 (getVpcEndpointIds() != null) sb.append("VpcEndpointIds: ").append(getVpcEndpointIds()).append(","); if (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).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 DescribeVpcEndpointsRequest == false) return false; DescribeVpcEndpointsRequest other = (DescribeVpcEndpointsRequest) obj; if (other.getVpcEndpointIds() == null ^ this.getVpcEndpointIds() == null) return false; if (other.getVpcEndpointIds() != null && other.getVpcEndpointIds().equals(this.getVpcEndpointIds()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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.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 + ((getVpcEndpointIds() == null) ? 0 : getVpcEndpointIds().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public DescribeVpcEndpointsRequest clone() { return (DescribeVpcEndpointsRequest) super.clone(); } }