com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2015 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeCustomerGatewaysRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeCustomerGateways(DescribeCustomerGatewaysRequest) DescribeCustomerGateways operation}.
*
* Describes one or more of your VPN customer gateways.
*
*
* For more information about VPN customer gateways, see
* Adding a Hardware Virtual Private Gateway to Your VPC
* in the Amazon Virtual Private Cloud User Guide .
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeCustomerGateways(DescribeCustomerGatewaysRequest)
*/
public class DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
* One or more customer gateway IDs. Default: Describes all your
* customer gateways.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag customerGatewayIds;
/**
* One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* One or more customer gateway IDs. Default: Describes all your
* customer gateways.
*
* @return One or more customer gateway IDs.
Default: Describes all your
* customer gateways.
*/
public java.util.List getCustomerGatewayIds() {
if (customerGatewayIds == null) {
customerGatewayIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
customerGatewayIds.setAutoConstruct(true);
}
return customerGatewayIds;
}
/**
* One or more customer gateway IDs. Default: Describes all your
* customer gateways.
*
* @param customerGatewayIds One or more customer gateway IDs.
Default: Describes all your
* customer gateways.
*/
public void setCustomerGatewayIds(java.util.Collection customerGatewayIds) {
if (customerGatewayIds == null) {
this.customerGatewayIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag customerGatewayIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(customerGatewayIds.size());
customerGatewayIdsCopy.addAll(customerGatewayIds);
this.customerGatewayIds = customerGatewayIdsCopy;
}
/**
* One or more customer gateway IDs. Default: Describes all your
* customer gateways.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setCustomerGatewayIds(java.util.Collection)} or
* {@link #withCustomerGatewayIds(java.util.Collection)} if you want to
* override the existing values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param customerGatewayIds One or more customer gateway IDs.
Default: Describes all your
* customer gateways.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCustomerGatewaysRequest withCustomerGatewayIds(String... customerGatewayIds) {
if (getCustomerGatewayIds() == null) setCustomerGatewayIds(new java.util.ArrayList(customerGatewayIds.length));
for (String value : customerGatewayIds) {
getCustomerGatewayIds().add(value);
}
return this;
}
/**
* One or more customer gateway IDs. Default: Describes all your
* customer gateways.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param customerGatewayIds One or more customer gateway IDs.
Default: Describes all your
* customer gateways.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCustomerGatewaysRequest withCustomerGatewayIds(java.util.Collection customerGatewayIds) {
if (customerGatewayIds == null) {
this.customerGatewayIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag customerGatewayIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(customerGatewayIds.size());
customerGatewayIdsCopy.addAll(customerGatewayIds);
this.customerGatewayIds = customerGatewayIdsCopy;
}
return this;
}
/**
* One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* @return One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* @param filters One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* NOTE: 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCustomerGatewaysRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* One or more filters. -
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
bgp-asn - The customer
* gateway's Border Gateway Protocol (BGP) Autonomous System Number
* (ASN).
-
customer-gateway-id - The ID of the
* customer gateway.
-
ip-address - The IP
* address of the customer gateway's Internet-routable external
* interface.
-
state - The state of the
* customer gateway (pending | available |
* deleting | deleted).
-
*
type - The type of customer gateway. Currently, the
* only supported type is ipsec.1.
-
*
tag:key=value - The key/value
* combination of a tag assigned to the resource.
-
*
tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter. For
* example, if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X
* (regardless of what the tag's key is). If you want to list only
* resources where Purpose is X, see the
* tag:key=value filter.
-
*
tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeCustomerGatewaysRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
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 getDryRunRequest() {
Request request = new DescribeCustomerGatewaysRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCustomerGatewayIds() != null) sb.append("CustomerGatewayIds: " + getCustomerGatewayIds() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCustomerGatewayIds() == null) ? 0 : getCustomerGatewayIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeCustomerGatewaysRequest == false) return false;
DescribeCustomerGatewaysRequest other = (DescribeCustomerGatewaysRequest)obj;
if (other.getCustomerGatewayIds() == null ^ this.getCustomerGatewayIds() == null) return false;
if (other.getCustomerGatewayIds() != null && other.getCustomerGatewayIds().equals(this.getCustomerGatewayIds()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
return true;
}
@Override
public DescribeCustomerGatewaysRequest clone() {
return (DescribeCustomerGatewaysRequest) super.clone();
}
}