software.amazon.awssdk.services.directconnect.model.NewPublicVirtualInterfaceAllocation Maven / Gradle / Ivy
Show all versions of directconnect Show documentation
/*
* 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.directconnect.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
/**
*
* Information about a public virtual interface to be provisioned on a connection.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class NewPublicVirtualInterfaceAllocation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VIRTUAL_INTERFACE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("virtualInterfaceName").getter(getter(NewPublicVirtualInterfaceAllocation::virtualInterfaceName))
.setter(setter(Builder::virtualInterfaceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("virtualInterfaceName").build())
.build();
private static final SdkField VLAN_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("vlan")
.getter(getter(NewPublicVirtualInterfaceAllocation::vlan)).setter(setter(Builder::vlan))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("vlan").build()).build();
private static final SdkField ASN_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("asn")
.getter(getter(NewPublicVirtualInterfaceAllocation::asn)).setter(setter(Builder::asn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("asn").build()).build();
private static final SdkField AUTH_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("authKey").getter(getter(NewPublicVirtualInterfaceAllocation::authKey)).setter(setter(Builder::authKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("authKey").build()).build();
private static final SdkField AMAZON_ADDRESS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("amazonAddress").getter(getter(NewPublicVirtualInterfaceAllocation::amazonAddress))
.setter(setter(Builder::amazonAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("amazonAddress").build()).build();
private static final SdkField CUSTOMER_ADDRESS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("customerAddress").getter(getter(NewPublicVirtualInterfaceAllocation::customerAddress))
.setter(setter(Builder::customerAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("customerAddress").build()).build();
private static final SdkField ADDRESS_FAMILY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("addressFamily").getter(getter(NewPublicVirtualInterfaceAllocation::addressFamilyAsString))
.setter(setter(Builder::addressFamily))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("addressFamily").build()).build();
private static final SdkField> ROUTE_FILTER_PREFIXES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("routeFilterPrefixes")
.getter(getter(NewPublicVirtualInterfaceAllocation::routeFilterPrefixes))
.setter(setter(Builder::routeFilterPrefixes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("routeFilterPrefixes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RouteFilterPrefix::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(NewPublicVirtualInterfaceAllocation::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VIRTUAL_INTERFACE_NAME_FIELD,
VLAN_FIELD, ASN_FIELD, AUTH_KEY_FIELD, AMAZON_ADDRESS_FIELD, CUSTOMER_ADDRESS_FIELD, ADDRESS_FAMILY_FIELD,
ROUTE_FILTER_PREFIXES_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String virtualInterfaceName;
private final Integer vlan;
private final Integer asn;
private final String authKey;
private final String amazonAddress;
private final String customerAddress;
private final String addressFamily;
private final List routeFilterPrefixes;
private final List tags;
private NewPublicVirtualInterfaceAllocation(BuilderImpl builder) {
this.virtualInterfaceName = builder.virtualInterfaceName;
this.vlan = builder.vlan;
this.asn = builder.asn;
this.authKey = builder.authKey;
this.amazonAddress = builder.amazonAddress;
this.customerAddress = builder.customerAddress;
this.addressFamily = builder.addressFamily;
this.routeFilterPrefixes = builder.routeFilterPrefixes;
this.tags = builder.tags;
}
/**
*
* The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The
* following are valid characters: a-z, 0-9 and a hyphen (-).
*
*
* @return The name of the virtual interface assigned by the customer network. The name has a maximum of 100
* characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
*/
public final String virtualInterfaceName() {
return virtualInterfaceName;
}
/**
*
* The ID of the VLAN.
*
*
* @return The ID of the VLAN.
*/
public final Integer vlan() {
return vlan;
}
/**
*
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
*
* The valid values are 1-2147483647.
*
*
* @return The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
* The valid values are 1-2147483647.
*/
public final Integer asn() {
return asn;
}
/**
*
* The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
* lenth of 80 characters.
*
*
* @return The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a
* maximun lenth of 80 characters.
*/
public final String authKey() {
return authKey;
}
/**
*
* The IP address assigned to the Amazon interface.
*
*
* @return The IP address assigned to the Amazon interface.
*/
public final String amazonAddress() {
return amazonAddress;
}
/**
*
* The IP address assigned to the customer interface.
*
*
* @return The IP address assigned to the customer interface.
*/
public final String customerAddress() {
return customerAddress;
}
/**
*
* The address family for the BGP peer.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #addressFamily}
* will return {@link AddressFamily#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #addressFamilyAsString}.
*
*
* @return The address family for the BGP peer.
* @see AddressFamily
*/
public final AddressFamily addressFamily() {
return AddressFamily.fromValue(addressFamily);
}
/**
*
* The address family for the BGP peer.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #addressFamily}
* will return {@link AddressFamily#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #addressFamilyAsString}.
*
*
* @return The address family for the BGP peer.
* @see AddressFamily
*/
public final String addressFamilyAsString() {
return addressFamily;
}
/**
* For responses, this returns true if the service returned a value for the RouteFilterPrefixes property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasRouteFilterPrefixes() {
return routeFilterPrefixes != null && !(routeFilterPrefixes instanceof SdkAutoConstructList);
}
/**
*
* The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual
* interfaces.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasRouteFilterPrefixes} method.
*
*
* @return The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual
* interfaces.
*/
public final List routeFilterPrefixes() {
return routeFilterPrefixes;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* The tags associated with the public virtual interface.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return The tags associated with the public virtual interface.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(virtualInterfaceName());
hashCode = 31 * hashCode + Objects.hashCode(vlan());
hashCode = 31 * hashCode + Objects.hashCode(asn());
hashCode = 31 * hashCode + Objects.hashCode(authKey());
hashCode = 31 * hashCode + Objects.hashCode(amazonAddress());
hashCode = 31 * hashCode + Objects.hashCode(customerAddress());
hashCode = 31 * hashCode + Objects.hashCode(addressFamilyAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasRouteFilterPrefixes() ? routeFilterPrefixes() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof NewPublicVirtualInterfaceAllocation)) {
return false;
}
NewPublicVirtualInterfaceAllocation other = (NewPublicVirtualInterfaceAllocation) obj;
return Objects.equals(virtualInterfaceName(), other.virtualInterfaceName()) && Objects.equals(vlan(), other.vlan())
&& Objects.equals(asn(), other.asn()) && Objects.equals(authKey(), other.authKey())
&& Objects.equals(amazonAddress(), other.amazonAddress())
&& Objects.equals(customerAddress(), other.customerAddress())
&& Objects.equals(addressFamilyAsString(), other.addressFamilyAsString())
&& hasRouteFilterPrefixes() == other.hasRouteFilterPrefixes()
&& Objects.equals(routeFilterPrefixes(), other.routeFilterPrefixes()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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 final String toString() {
return ToString.builder("NewPublicVirtualInterfaceAllocation").add("VirtualInterfaceName", virtualInterfaceName())
.add("Vlan", vlan()).add("Asn", asn()).add("AuthKey", authKey()).add("AmazonAddress", amazonAddress())
.add("CustomerAddress", customerAddress()).add("AddressFamily", addressFamilyAsString())
.add("RouteFilterPrefixes", hasRouteFilterPrefixes() ? routeFilterPrefixes() : null)
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "virtualInterfaceName":
return Optional.ofNullable(clazz.cast(virtualInterfaceName()));
case "vlan":
return Optional.ofNullable(clazz.cast(vlan()));
case "asn":
return Optional.ofNullable(clazz.cast(asn()));
case "authKey":
return Optional.ofNullable(clazz.cast(authKey()));
case "amazonAddress":
return Optional.ofNullable(clazz.cast(amazonAddress()));
case "customerAddress":
return Optional.ofNullable(clazz.cast(customerAddress()));
case "addressFamily":
return Optional.ofNullable(clazz.cast(addressFamilyAsString()));
case "routeFilterPrefixes":
return Optional.ofNullable(clazz.cast(routeFilterPrefixes()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("virtualInterfaceName", VIRTUAL_INTERFACE_NAME_FIELD);
map.put("vlan", VLAN_FIELD);
map.put("asn", ASN_FIELD);
map.put("authKey", AUTH_KEY_FIELD);
map.put("amazonAddress", AMAZON_ADDRESS_FIELD);
map.put("customerAddress", CUSTOMER_ADDRESS_FIELD);
map.put("addressFamily", ADDRESS_FAMILY_FIELD);
map.put("routeFilterPrefixes", ROUTE_FILTER_PREFIXES_FIELD);
map.put("tags", TAGS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function