software.amazon.awssdk.services.directconnect.model.NewPrivateVirtualInterfaceAllocation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of directconnect Show documentation
Show all versions of directconnect Show documentation
The AWS Java SDK for AWS Direct Connect module holds the client classes that are used for communicating
with AWS Direct
Connect Service
/*
* 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.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.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 private virtual interface to be provisioned on a connection.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class NewPrivateVirtualInterfaceAllocation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VIRTUAL_INTERFACE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("virtualInterfaceName").getter(getter(NewPrivateVirtualInterfaceAllocation::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(NewPrivateVirtualInterfaceAllocation::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(NewPrivateVirtualInterfaceAllocation::asn)).setter(setter(Builder::asn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("asn").build()).build();
private static final SdkField MTU_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("mtu")
.getter(getter(NewPrivateVirtualInterfaceAllocation::mtu)).setter(setter(Builder::mtu))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("mtu").build()).build();
private static final SdkField AUTH_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("authKey").getter(getter(NewPrivateVirtualInterfaceAllocation::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(NewPrivateVirtualInterfaceAllocation::amazonAddress))
.setter(setter(Builder::amazonAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("amazonAddress").build()).build();
private static final SdkField ADDRESS_FAMILY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("addressFamily").getter(getter(NewPrivateVirtualInterfaceAllocation::addressFamilyAsString))
.setter(setter(Builder::addressFamily))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("addressFamily").build()).build();
private static final SdkField CUSTOMER_ADDRESS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("customerAddress").getter(getter(NewPrivateVirtualInterfaceAllocation::customerAddress))
.setter(setter(Builder::customerAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("customerAddress").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(NewPrivateVirtualInterfaceAllocation::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, MTU_FIELD, AUTH_KEY_FIELD, AMAZON_ADDRESS_FIELD, ADDRESS_FAMILY_FIELD, CUSTOMER_ADDRESS_FIELD,
TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String virtualInterfaceName;
private final Integer vlan;
private final Integer asn;
private final Integer mtu;
private final String authKey;
private final String amazonAddress;
private final String addressFamily;
private final String customerAddress;
private final List tags;
private NewPrivateVirtualInterfaceAllocation(BuilderImpl builder) {
this.virtualInterfaceName = builder.virtualInterfaceName;
this.vlan = builder.vlan;
this.asn = builder.asn;
this.mtu = builder.mtu;
this.authKey = builder.authKey;
this.amazonAddress = builder.amazonAddress;
this.addressFamily = builder.addressFamily;
this.customerAddress = builder.customerAddress;
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 maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
*
*
* @return The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value
* is 1500.
*/
public final Integer mtu() {
return mtu;
}
/**
*
* 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 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;
}
/**
*
* The IP address assigned to the customer interface.
*
*
* @return The IP address assigned to the customer interface.
*/
public final String customerAddress() {
return customerAddress;
}
/**
* 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 private 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 private 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 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(mtu());
hashCode = 31 * hashCode + Objects.hashCode(authKey());
hashCode = 31 * hashCode + Objects.hashCode(amazonAddress());
hashCode = 31 * hashCode + Objects.hashCode(addressFamilyAsString());
hashCode = 31 * hashCode + Objects.hashCode(customerAddress());
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 NewPrivateVirtualInterfaceAllocation)) {
return false;
}
NewPrivateVirtualInterfaceAllocation other = (NewPrivateVirtualInterfaceAllocation) obj;
return Objects.equals(virtualInterfaceName(), other.virtualInterfaceName()) && Objects.equals(vlan(), other.vlan())
&& Objects.equals(asn(), other.asn()) && Objects.equals(mtu(), other.mtu())
&& Objects.equals(authKey(), other.authKey()) && Objects.equals(amazonAddress(), other.amazonAddress())
&& Objects.equals(addressFamilyAsString(), other.addressFamilyAsString())
&& Objects.equals(customerAddress(), other.customerAddress()) && 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("NewPrivateVirtualInterfaceAllocation").add("VirtualInterfaceName", virtualInterfaceName())
.add("Vlan", vlan()).add("Asn", asn()).add("Mtu", mtu()).add("AuthKey", authKey())
.add("AmazonAddress", amazonAddress()).add("AddressFamily", addressFamilyAsString())
.add("CustomerAddress", customerAddress()).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 "mtu":
return Optional.ofNullable(clazz.cast(mtu()));
case "authKey":
return Optional.ofNullable(clazz.cast(authKey()));
case "amazonAddress":
return Optional.ofNullable(clazz.cast(amazonAddress()));
case "addressFamily":
return Optional.ofNullable(clazz.cast(addressFamilyAsString()));
case "customerAddress":
return Optional.ofNullable(clazz.cast(customerAddress()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((NewPrivateVirtualInterfaceAllocation) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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 (-).
*
*
* @param virtualInterfaceName
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder virtualInterfaceName(String virtualInterfaceName);
/**
*
* The ID of the VLAN.
*
*
* @param vlan
* The ID of the VLAN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vlan(Integer vlan);
/**
*
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
*
* The valid values are 1-2147483647.
*
*
* @param asn
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
* The valid values are 1-2147483647.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder asn(Integer asn);
/**
*
* The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is
* 1500.
*
*
* @param mtu
* The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default
* value is 1500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mtu(Integer mtu);
/**
*
* The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a
* maximun lenth of 80 characters.
*
*
* @param authKey
* The authentication key for BGP configuration. This string has a minimum length of 6 characters and and
* a maximun lenth of 80 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authKey(String authKey);
/**
*
* The IP address assigned to the Amazon interface.
*
*
* @param amazonAddress
* The IP address assigned to the Amazon interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder amazonAddress(String amazonAddress);
/**
*
* The address family for the BGP peer.
*
*
* @param addressFamily
* The address family for the BGP peer.
* @see AddressFamily
* @return Returns a reference to this object so that method calls can be chained together.
* @see AddressFamily
*/
Builder addressFamily(String addressFamily);
/**
*
* The address family for the BGP peer.
*
*
* @param addressFamily
* The address family for the BGP peer.
* @see AddressFamily
* @return Returns a reference to this object so that method calls can be chained together.
* @see AddressFamily
*/
Builder addressFamily(AddressFamily addressFamily);
/**
*
* The IP address assigned to the customer interface.
*
*
* @param customerAddress
* The IP address assigned to the customer interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customerAddress(String customerAddress);
/**
*
* The tags associated with the private virtual interface.
*
*
* @param tags
* The tags associated with the private virtual interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The tags associated with the private virtual interface.
*
*
* @param tags
* The tags associated with the private virtual interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The tags associated with the private virtual interface.
*
* This is a convenience method 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 #tags(List)}.
*
* @param tags
* 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 #tags(List)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private String virtualInterfaceName;
private Integer vlan;
private Integer asn;
private Integer mtu;
private String authKey;
private String amazonAddress;
private String addressFamily;
private String customerAddress;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(NewPrivateVirtualInterfaceAllocation model) {
virtualInterfaceName(model.virtualInterfaceName);
vlan(model.vlan);
asn(model.asn);
mtu(model.mtu);
authKey(model.authKey);
amazonAddress(model.amazonAddress);
addressFamily(model.addressFamily);
customerAddress(model.customerAddress);
tags(model.tags);
}
public final String getVirtualInterfaceName() {
return virtualInterfaceName;
}
public final void setVirtualInterfaceName(String virtualInterfaceName) {
this.virtualInterfaceName = virtualInterfaceName;
}
@Override
public final Builder virtualInterfaceName(String virtualInterfaceName) {
this.virtualInterfaceName = virtualInterfaceName;
return this;
}
public final Integer getVlan() {
return vlan;
}
public final void setVlan(Integer vlan) {
this.vlan = vlan;
}
@Override
public final Builder vlan(Integer vlan) {
this.vlan = vlan;
return this;
}
public final Integer getAsn() {
return asn;
}
public final void setAsn(Integer asn) {
this.asn = asn;
}
@Override
public final Builder asn(Integer asn) {
this.asn = asn;
return this;
}
public final Integer getMtu() {
return mtu;
}
public final void setMtu(Integer mtu) {
this.mtu = mtu;
}
@Override
public final Builder mtu(Integer mtu) {
this.mtu = mtu;
return this;
}
public final String getAuthKey() {
return authKey;
}
public final void setAuthKey(String authKey) {
this.authKey = authKey;
}
@Override
public final Builder authKey(String authKey) {
this.authKey = authKey;
return this;
}
public final String getAmazonAddress() {
return amazonAddress;
}
public final void setAmazonAddress(String amazonAddress) {
this.amazonAddress = amazonAddress;
}
@Override
public final Builder amazonAddress(String amazonAddress) {
this.amazonAddress = amazonAddress;
return this;
}
public final String getAddressFamily() {
return addressFamily;
}
public final void setAddressFamily(String addressFamily) {
this.addressFamily = addressFamily;
}
@Override
public final Builder addressFamily(String addressFamily) {
this.addressFamily = addressFamily;
return this;
}
@Override
public final Builder addressFamily(AddressFamily addressFamily) {
this.addressFamily(addressFamily == null ? null : addressFamily.toString());
return this;
}
public final String getCustomerAddress() {
return customerAddress;
}
public final void setCustomerAddress(String customerAddress) {
this.customerAddress = customerAddress;
}
@Override
public final Builder customerAddress(String customerAddress) {
this.customerAddress = customerAddress;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public NewPrivateVirtualInterfaceAllocation build() {
return new NewPrivateVirtualInterfaceAllocation(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy