software.amazon.awssdk.services.ec2.model.AllocateAddressRequest Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.model;
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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class AllocateAddressRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Domain")
.getter(getter(AllocateAddressRequest::domainAsString))
.setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain")
.unmarshallLocationName("Domain").build()).build();
private static final SdkField ADDRESS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Address")
.getter(getter(AllocateAddressRequest::address))
.setter(setter(Builder::address))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Address")
.unmarshallLocationName("Address").build()).build();
private static final SdkField PUBLIC_IPV4_POOL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PublicIpv4Pool")
.getter(getter(AllocateAddressRequest::publicIpv4Pool))
.setter(setter(Builder::publicIpv4Pool))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublicIpv4Pool")
.unmarshallLocationName("PublicIpv4Pool").build()).build();
private static final SdkField NETWORK_BORDER_GROUP_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NetworkBorderGroup")
.getter(getter(AllocateAddressRequest::networkBorderGroup))
.setter(setter(Builder::networkBorderGroup))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkBorderGroup")
.unmarshallLocationName("NetworkBorderGroup").build()).build();
private static final SdkField CUSTOMER_OWNED_IPV4_POOL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CustomerOwnedIpv4Pool")
.getter(getter(AllocateAddressRequest::customerOwnedIpv4Pool))
.setter(setter(Builder::customerOwnedIpv4Pool))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomerOwnedIpv4Pool")
.unmarshallLocationName("CustomerOwnedIpv4Pool").build()).build();
private static final SdkField> TAG_SPECIFICATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagSpecifications")
.getter(getter(AllocateAddressRequest::tagSpecifications))
.setter(setter(Builder::tagSpecifications))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagSpecification")
.unmarshallLocationName("TagSpecification").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TagSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField IPAM_POOL_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("IpamPoolId")
.getter(getter(AllocateAddressRequest::ipamPoolId))
.setter(setter(Builder::ipamPoolId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IpamPoolId")
.unmarshallLocationName("IpamPoolId").build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(AllocateAddressRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("dryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_FIELD, ADDRESS_FIELD,
PUBLIC_IPV4_POOL_FIELD, NETWORK_BORDER_GROUP_FIELD, CUSTOMER_OWNED_IPV4_POOL_FIELD, TAG_SPECIFICATIONS_FIELD,
IPAM_POOL_ID_FIELD, DRY_RUN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Domain", DOMAIN_FIELD);
put("Address", ADDRESS_FIELD);
put("PublicIpv4Pool", PUBLIC_IPV4_POOL_FIELD);
put("NetworkBorderGroup", NETWORK_BORDER_GROUP_FIELD);
put("CustomerOwnedIpv4Pool", CUSTOMER_OWNED_IPV4_POOL_FIELD);
put("TagSpecification", TAG_SPECIFICATIONS_FIELD);
put("IpamPoolId", IPAM_POOL_ID_FIELD);
put("DryRun", DRY_RUN_FIELD);
}
});
private final String domain;
private final String address;
private final String publicIpv4Pool;
private final String networkBorderGroup;
private final String customerOwnedIpv4Pool;
private final List tagSpecifications;
private final String ipamPoolId;
private final Boolean dryRun;
private AllocateAddressRequest(BuilderImpl builder) {
super(builder);
this.domain = builder.domain;
this.address = builder.address;
this.publicIpv4Pool = builder.publicIpv4Pool;
this.networkBorderGroup = builder.networkBorderGroup;
this.customerOwnedIpv4Pool = builder.customerOwnedIpv4Pool;
this.tagSpecifications = builder.tagSpecifications;
this.ipamPoolId = builder.ipamPoolId;
this.dryRun = builder.dryRun;
}
/**
*
* The network (vpc
).
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link DomainType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The network (vpc
).
* @see DomainType
*/
public final DomainType domain() {
return DomainType.fromValue(domain);
}
/**
*
* The network (vpc
).
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link DomainType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The network (vpc
).
* @see DomainType
*/
public final String domainAsString() {
return domain;
}
/**
*
* The Elastic IP address to recover or an IPv4 address from an address pool.
*
*
* @return The Elastic IP address to recover or an IPv4 address from an address pool.
*/
public final String address() {
return address;
}
/**
*
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
* pool. To specify a specific address from the address pool, use the Address
parameter instead.
*
*
* @return The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the
* address pool. To specify a specific address from the address pool, use the Address
parameter
* instead.
*/
public final String publicIpv4Pool() {
return publicIpv4Pool;
}
/**
*
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP
* addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network
* border groups.
*
*
* @return A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot
* move between network border groups.
*/
public final String networkBorderGroup() {
return networkBorderGroup;
}
/**
*
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
* pool. Alternatively, specify a specific address from the address pool.
*
*
* @return The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the
* address pool. Alternatively, specify a specific address from the address pool.
*/
public final String customerOwnedIpv4Pool() {
return customerOwnedIpv4Pool;
}
/**
* For responses, this returns true if the service returned a value for the TagSpecifications 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 hasTagSpecifications() {
return tagSpecifications != null && !(tagSpecifications instanceof SdkAutoConstructList);
}
/**
*
* The tags to assign to the Elastic IP address.
*
*
* 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 #hasTagSpecifications} method.
*
*
* @return The tags to assign to the Elastic IP address.
*/
public final List tagSpecifications() {
return tagSpecifications;
}
/**
*
* The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more
* information, see Allocate
* sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.
*
*
* @return The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more
* information, see Allocate
* sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.
*/
public final String ipamPoolId() {
return ipamPoolId;
}
/**
*
* Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
*
*
* @return Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
*/
public final Boolean dryRun() {
return dryRun;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domainAsString());
hashCode = 31 * hashCode + Objects.hashCode(address());
hashCode = 31 * hashCode + Objects.hashCode(publicIpv4Pool());
hashCode = 31 * hashCode + Objects.hashCode(networkBorderGroup());
hashCode = 31 * hashCode + Objects.hashCode(customerOwnedIpv4Pool());
hashCode = 31 * hashCode + Objects.hashCode(hasTagSpecifications() ? tagSpecifications() : null);
hashCode = 31 * hashCode + Objects.hashCode(ipamPoolId());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AllocateAddressRequest)) {
return false;
}
AllocateAddressRequest other = (AllocateAddressRequest) obj;
return Objects.equals(domainAsString(), other.domainAsString()) && Objects.equals(address(), other.address())
&& Objects.equals(publicIpv4Pool(), other.publicIpv4Pool())
&& Objects.equals(networkBorderGroup(), other.networkBorderGroup())
&& Objects.equals(customerOwnedIpv4Pool(), other.customerOwnedIpv4Pool())
&& hasTagSpecifications() == other.hasTagSpecifications()
&& Objects.equals(tagSpecifications(), other.tagSpecifications())
&& Objects.equals(ipamPoolId(), other.ipamPoolId()) && Objects.equals(dryRun(), other.dryRun());
}
/**
* 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("AllocateAddressRequest").add("Domain", domainAsString()).add("Address", address())
.add("PublicIpv4Pool", publicIpv4Pool()).add("NetworkBorderGroup", networkBorderGroup())
.add("CustomerOwnedIpv4Pool", customerOwnedIpv4Pool())
.add("TagSpecifications", hasTagSpecifications() ? tagSpecifications() : null).add("IpamPoolId", ipamPoolId())
.add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Domain":
return Optional.ofNullable(clazz.cast(domainAsString()));
case "Address":
return Optional.ofNullable(clazz.cast(address()));
case "PublicIpv4Pool":
return Optional.ofNullable(clazz.cast(publicIpv4Pool()));
case "NetworkBorderGroup":
return Optional.ofNullable(clazz.cast(networkBorderGroup()));
case "CustomerOwnedIpv4Pool":
return Optional.ofNullable(clazz.cast(customerOwnedIpv4Pool()));
case "TagSpecifications":
return Optional.ofNullable(clazz.cast(tagSpecifications()));
case "IpamPoolId":
return Optional.ofNullable(clazz.cast(ipamPoolId()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function