software.amazon.awssdk.services.ec2.model.DescribeVpnConnectionsRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the parameters for DescribeVpnConnections.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeVpnConnectionsRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeVpnConnectionsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").unmarshallLocationName("Filter").build()).build())
.build()).build();
private static final SdkField> VPN_CONNECTION_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VpnConnectionIds")
.getter(getter(DescribeVpnConnectionsRequest::vpnConnectionIds))
.setter(setter(Builder::vpnConnectionIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpnConnectionId")
.unmarshallLocationName("VpnConnectionId").build(),
ListTrait
.builder()
.memberLocationName("VpnConnectionId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("VpnConnectionId").unmarshallLocationName("VpnConnectionId")
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTERS_FIELD,
VPN_CONNECTION_IDS_FIELD));
private final List filters;
private final List vpnConnectionIds;
private DescribeVpnConnectionsRequest(BuilderImpl builder) {
super(builder);
this.filters = builder.filters;
this.vpnConnectionIds = builder.vpnConnectionIds;
}
/**
* Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* One or more filters.
*
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used for
* devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a
* customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFilters()} to see if a value was sent in this field.
*
*
* @return One or more filters.
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used
* for devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet
* used in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is ipsec.1
* .
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
*/
public List filters() {
return filters;
}
/**
* Returns true if the VpnConnectionIds property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public boolean hasVpnConnectionIds() {
return vpnConnectionIds != null && !(vpnConnectionIds instanceof SdkAutoConstructList);
}
/**
*
* One or more VPN connection IDs.
*
*
* Default: Describes your VPN connections.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasVpnConnectionIds()} to see if a value was sent in this field.
*
*
* @return One or more VPN connection IDs.
*
* Default: Describes your VPN connections.
*/
public List vpnConnectionIds() {
return vpnConnectionIds;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(filters());
hashCode = 31 * hashCode + Objects.hashCode(vpnConnectionIds());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeVpnConnectionsRequest)) {
return false;
}
DescribeVpnConnectionsRequest other = (DescribeVpnConnectionsRequest) obj;
return Objects.equals(filters(), other.filters()) && Objects.equals(vpnConnectionIds(), other.vpnConnectionIds());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("DescribeVpnConnectionsRequest").add("Filters", filters())
.add("VpnConnectionIds", vpnConnectionIds()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "VpnConnectionIds":
return Optional.ofNullable(clazz.cast(vpnConnectionIds()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeVpnConnectionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* One or more filters.
*
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used for
* devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used
* in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used
* for devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet
* used in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is
* ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* One or more filters.
*
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used for
* devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used
* in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used
* for devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet
* used in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is
* ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* One or more filters.
*
*
* -
*
* customer-gateway-configuration - The configuration information for the customer gateway.
*
*
* -
*
* customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
*
*
* -
*
* state - The state of the VPN connection (pending | available |
* deleting | deleted).
*
*
* -
*
* option.static-routes-only - Indicates whether the connection has static routes only. Used for
* devices that do not support Border Gateway Protocol (BGP).
*
*
* -
*
* route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used
* in a customer data center.
*
*
* -
*
* bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
*
*
* -
*
* tag:<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 Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - 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.
*
*
* -
*
* type - The type of VPN connection. Currently the only supported type is ipsec.1.
*
*
* -
*
* vpn-connection-id - The ID of the VPN connection.
*
*
* -
*
* vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
*
*
* -
*
* transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
*
*
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(List)
*/
Builder filters(Consumer... filters);
/**
*
* One or more VPN connection IDs.
*
*
* Default: Describes your VPN connections.
*
*
* @param vpnConnectionIds
* One or more VPN connection IDs.
*
* Default: Describes your VPN connections.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpnConnectionIds(Collection vpnConnectionIds);
/**
*
* One or more VPN connection IDs.
*
*
* Default: Describes your VPN connections.
*
*
* @param vpnConnectionIds
* One or more VPN connection IDs.
*
* Default: Describes your VPN connections.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpnConnectionIds(String... vpnConnectionIds);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Ec2Request.BuilderImpl implements Builder {
private List filters = DefaultSdkAutoConstructList.getInstance();
private List vpnConnectionIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeVpnConnectionsRequest model) {
super(model);
filters(model.filters);
vpnConnectionIds(model.vpnConnectionIds);
}
public final Collection getFilters() {
return filters != null ? filters.stream().map(Filter::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
public final Collection getVpnConnectionIds() {
return vpnConnectionIds;
}
@Override
public final Builder vpnConnectionIds(Collection vpnConnectionIds) {
this.vpnConnectionIds = VpnConnectionIdStringListCopier.copy(vpnConnectionIds);
return this;
}
@Override
@SafeVarargs
public final Builder vpnConnectionIds(String... vpnConnectionIds) {
vpnConnectionIds(Arrays.asList(vpnConnectionIds));
return this;
}
public final void setVpnConnectionIds(Collection vpnConnectionIds) {
this.vpnConnectionIds = VpnConnectionIdStringListCopier.copy(vpnConnectionIds);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeVpnConnectionsRequest build() {
return new DescribeVpnConnectionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}