com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2011-2016 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.DescribeVpnGatewaysRequestMarshaller;
/**
*
* Contains the parameters for DescribeVpnGateways.
*
*/
public class DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* One or more virtual private gateway IDs.
*
*
* Default: Describes all your virtual private gateways.
*
*/
private com.amazonaws.internal.SdkInternalList vpnGatewayIds;
/**
*
* One or more filters.
*
*
* -
*
* attachment.state - The current state of the attachment between the gateway and the VPC (
* attaching | attached | detaching | detached).
*
*
* -
*
* attachment.vpc-id - The ID of an attached VPC.
*
*
* -
*
* availability-zone - The Availability Zone for the virtual private gateway (if applicable).
*
*
* -
*
* state - The state of the virtual private gateway (pending | available |
* deleting | deleted).
*
*
* -
*
* 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.
*
*
* -
*
* type - The type of virtual private gateway. Currently the only supported type is
* ipsec.1.
*
*
* -
*
* vpn-gateway-id - The ID of the virtual private gateway.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* One or more virtual private gateway IDs.
*
*
* Default: Describes all your virtual private gateways.
*
*
* @return One or more virtual private gateway IDs.
*
* Default: Describes all your virtual private gateways.
*/
public java.util.List getVpnGatewayIds() {
if (vpnGatewayIds == null) {
vpnGatewayIds = new com.amazonaws.internal.SdkInternalList();
}
return vpnGatewayIds;
}
/**
*
* One or more virtual private gateway IDs.
*
*
* Default: Describes all your virtual private gateways.
*
*
* @param vpnGatewayIds
* One or more virtual private gateway IDs.
*
* Default: Describes all your virtual private gateways.
*/
public void setVpnGatewayIds(java.util.Collection vpnGatewayIds) {
if (vpnGatewayIds == null) {
this.vpnGatewayIds = null;
return;
}
this.vpnGatewayIds = new com.amazonaws.internal.SdkInternalList(vpnGatewayIds);
}
/**
*
* One or more virtual private gateway IDs.
*
*
* Default: Describes all your virtual private gateways.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setVpnGatewayIds(java.util.Collection)} or {@link #withVpnGatewayIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param vpnGatewayIds
* One or more virtual private gateway IDs.
*
* Default: Describes all your virtual private gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVpnGatewaysRequest withVpnGatewayIds(String... vpnGatewayIds) {
if (this.vpnGatewayIds == null) {
setVpnGatewayIds(new com.amazonaws.internal.SdkInternalList(vpnGatewayIds.length));
}
for (String ele : vpnGatewayIds) {
this.vpnGatewayIds.add(ele);
}
return this;
}
/**
*
* One or more virtual private gateway IDs.
*
*
* Default: Describes all your virtual private gateways.
*
*
* @param vpnGatewayIds
* One or more virtual private gateway IDs.
*
* Default: Describes all your virtual private gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVpnGatewaysRequest withVpnGatewayIds(java.util.Collection vpnGatewayIds) {
setVpnGatewayIds(vpnGatewayIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* attachment.state - The current state of the attachment between the gateway and the VPC (
* attaching | attached | detaching | detached).
*
*
* -
*
* attachment.vpc-id - The ID of an attached VPC.
*
*
* -
*
* availability-zone - The Availability Zone for the virtual private gateway (if applicable).
*
*
* -
*
* state - The state of the virtual private gateway (pending | available |
* deleting | deleted).
*
*
* -
*
* 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.
*
*
* -
*
* type - The type of virtual private gateway. Currently the only supported type is
* ipsec.1.
*
*
* -
*
* vpn-gateway-id - The ID of the virtual private gateway.
*
*
*
*
* @return One or more filters.
* -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending| *available|deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
*/
public java.util.List -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending|available| *deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
* -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending| *available|deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
*/
public void setFilters(java.util.Collection -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending|available| *deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
* -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending| *available|deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
* Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVpnGatewaysRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending|available| *deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
* -
*
*
*attachment.state- The current state of the attachment between the gateway and the VPC ( *attaching|attached|detaching|detached). *
* -
*
*
*attachment.vpc-id- The ID of an attached VPC. *
* -
*
*
*availability-zone- The Availability Zone for the virtual private gateway (if applicable). *
* -
*
*
*state- The state of the virtual private gateway (pending| *available|deleting|deleted). *
* -
*
*
*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-valuefilter. 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 thetag:key=value filter. *
* -
*
*
*tag-value- The value of a tag assigned to the resource. This filter is independent of the *tag-keyfilter. *
* -
*
*
*type- The type of virtual private gateway. Currently the only supported type is *ipsec.1. *
* -
*
*
*vpn-gateway-id- The ID of the virtual private gateway. *
* Returns a reference to this object so that method calls can be chained together.
*/
public DescribeVpnGatewaysRequest withFilters(java.util.Collection
* getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
*
*
* @param filters
* One or more filters.
*
* filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* One or more filters.
*
*
*
*
* 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.
*
*
* @param filters
* One or more filters.
*
* (filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
*
*
* @param filters
* One or more filters.
*
* filters) {
setFilters(filters);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
public Request getDryRunRequest() {
Request request = new DescribeVpnGatewaysRequestMarshaller().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()
*/
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVpnGatewayIds() != null)
sb.append("VpnGatewayIds: " + getVpnGatewayIds() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeVpnGatewaysRequest == false)
return false;
DescribeVpnGatewaysRequest other = (DescribeVpnGatewaysRequest) obj;
if (other.getVpnGatewayIds() == null ^ this.getVpnGatewayIds() == null)
return false;
if (other.getVpnGatewayIds() != null && other.getVpnGatewayIds().equals(this.getVpnGatewayIds()) == 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;
}
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVpnGatewayIds() == null) ? 0 : getVpnGatewayIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
public DescribeVpnGatewaysRequest clone() {
return (DescribeVpnGatewaysRequest) super.clone();
}
}