software.amazon.awssdk.services.elasticloadbalancingv2.model.AvailabilityZone Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticloadbalancingv2 Show documentation
Show all versions of elasticloadbalancingv2 Show documentation
The AWS Java SDK for Elastic Load Balancing module holds the client classes that are used for
communicating with Elastic Load Balancing Service (API Version 2015-12-01)
/*
* 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.elasticloadbalancingv2.model;
import java.beans.Transient;
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 an Availability Zone.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AvailabilityZone implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ZONE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ZoneName").getter(getter(AvailabilityZone::zoneName)).setter(setter(Builder::zoneName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ZoneName").build()).build();
private static final SdkField SUBNET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SubnetId").getter(getter(AvailabilityZone::subnetId)).setter(setter(Builder::subnetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetId").build()).build();
private static final SdkField OUTPOST_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutpostId").getter(getter(AvailabilityZone::outpostId)).setter(setter(Builder::outpostId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutpostId").build()).build();
private static final SdkField> LOAD_BALANCER_ADDRESSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("LoadBalancerAddresses")
.getter(getter(AvailabilityZone::loadBalancerAddresses))
.setter(setter(Builder::loadBalancerAddresses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LoadBalancerAddresses").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(LoadBalancerAddress::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ZONE_NAME_FIELD,
SUBNET_ID_FIELD, OUTPOST_ID_FIELD, LOAD_BALANCER_ADDRESSES_FIELD));
private static final long serialVersionUID = 1L;
private final String zoneName;
private final String subnetId;
private final String outpostId;
private final List loadBalancerAddresses;
private AvailabilityZone(BuilderImpl builder) {
this.zoneName = builder.zoneName;
this.subnetId = builder.subnetId;
this.outpostId = builder.outpostId;
this.loadBalancerAddresses = builder.loadBalancerAddresses;
}
/**
*
* The name of the Availability Zone.
*
*
* @return The name of the Availability Zone.
*/
public final String zoneName() {
return zoneName;
}
/**
*
* The ID of the subnet. You can specify one subnet per Availability Zone.
*
*
* @return The ID of the subnet. You can specify one subnet per Availability Zone.
*/
public final String subnetId() {
return subnetId;
}
/**
*
* [Application Load Balancers on Outposts] The ID of the Outpost.
*
*
* @return [Application Load Balancers on Outposts] The ID of the Outpost.
*/
public final String outpostId() {
return outpostId;
}
/**
* For responses, this returns true if the service returned a value for the LoadBalancerAddresses 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 hasLoadBalancerAddresses() {
return loadBalancerAddresses != null && !(loadBalancerAddresses instanceof SdkAutoConstructList);
}
/**
*
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP
* address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you
* can specify a private IP address from the IPv4 range of the subnet.
*
*
* 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 #hasLoadBalancerAddresses} method.
*
*
* @return [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one
* Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal
* load balancers, you can specify a private IP address from the IPv4 range of the subnet.
*/
public final List loadBalancerAddresses() {
return loadBalancerAddresses;
}
@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(zoneName());
hashCode = 31 * hashCode + Objects.hashCode(subnetId());
hashCode = 31 * hashCode + Objects.hashCode(outpostId());
hashCode = 31 * hashCode + Objects.hashCode(hasLoadBalancerAddresses() ? loadBalancerAddresses() : 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 AvailabilityZone)) {
return false;
}
AvailabilityZone other = (AvailabilityZone) obj;
return Objects.equals(zoneName(), other.zoneName()) && Objects.equals(subnetId(), other.subnetId())
&& Objects.equals(outpostId(), other.outpostId())
&& hasLoadBalancerAddresses() == other.hasLoadBalancerAddresses()
&& Objects.equals(loadBalancerAddresses(), other.loadBalancerAddresses());
}
/**
* 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("AvailabilityZone").add("ZoneName", zoneName()).add("SubnetId", subnetId())
.add("OutpostId", outpostId())
.add("LoadBalancerAddresses", hasLoadBalancerAddresses() ? loadBalancerAddresses() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ZoneName":
return Optional.ofNullable(clazz.cast(zoneName()));
case "SubnetId":
return Optional.ofNullable(clazz.cast(subnetId()));
case "OutpostId":
return Optional.ofNullable(clazz.cast(outpostId()));
case "LoadBalancerAddresses":
return Optional.ofNullable(clazz.cast(loadBalancerAddresses()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AvailabilityZone) 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 Availability Zone.
*
*
* @param zoneName
* The name of the Availability Zone.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder zoneName(String zoneName);
/**
*
* The ID of the subnet. You can specify one subnet per Availability Zone.
*
*
* @param subnetId
* The ID of the subnet. You can specify one subnet per Availability Zone.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetId(String subnetId);
/**
*
* [Application Load Balancers on Outposts] The ID of the Outpost.
*
*
* @param outpostId
* [Application Load Balancers on Outposts] The ID of the Outpost.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outpostId(String outpostId);
/**
*
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic
* IP address per Availability Zone when you create an internal-facing load balancer. For internal load
* balancers, you can specify a private IP address from the IPv4 range of the subnet.
*
*
* @param loadBalancerAddresses
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one
* Elastic IP address per Availability Zone when you create an internal-facing load balancer. For
* internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder loadBalancerAddresses(Collection loadBalancerAddresses);
/**
*
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic
* IP address per Availability Zone when you create an internal-facing load balancer. For internal load
* balancers, you can specify a private IP address from the IPv4 range of the subnet.
*
*
* @param loadBalancerAddresses
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one
* Elastic IP address per Availability Zone when you create an internal-facing load balancer. For
* internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder loadBalancerAddresses(LoadBalancerAddress... loadBalancerAddresses);
/**
*
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic
* IP address per Availability Zone when you create an internal-facing load balancer. For internal load
* balancers, you can specify a private IP address from the IPv4 range of the subnet.
*
* 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 #loadBalancerAddresses(List)}.
*
* @param loadBalancerAddresses
* 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 #loadBalancerAddresses(List)
*/
Builder loadBalancerAddresses(Consumer... loadBalancerAddresses);
}
static final class BuilderImpl implements Builder {
private String zoneName;
private String subnetId;
private String outpostId;
private List loadBalancerAddresses = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AvailabilityZone model) {
zoneName(model.zoneName);
subnetId(model.subnetId);
outpostId(model.outpostId);
loadBalancerAddresses(model.loadBalancerAddresses);
}
public final String getZoneName() {
return zoneName;
}
public final void setZoneName(String zoneName) {
this.zoneName = zoneName;
}
@Override
@Transient
public final Builder zoneName(String zoneName) {
this.zoneName = zoneName;
return this;
}
public final String getSubnetId() {
return subnetId;
}
public final void setSubnetId(String subnetId) {
this.subnetId = subnetId;
}
@Override
@Transient
public final Builder subnetId(String subnetId) {
this.subnetId = subnetId;
return this;
}
public final String getOutpostId() {
return outpostId;
}
public final void setOutpostId(String outpostId) {
this.outpostId = outpostId;
}
@Override
@Transient
public final Builder outpostId(String outpostId) {
this.outpostId = outpostId;
return this;
}
public final List getLoadBalancerAddresses() {
List result = LoadBalancerAddressesCopier.copyToBuilder(this.loadBalancerAddresses);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setLoadBalancerAddresses(Collection loadBalancerAddresses) {
this.loadBalancerAddresses = LoadBalancerAddressesCopier.copyFromBuilder(loadBalancerAddresses);
}
@Override
@Transient
public final Builder loadBalancerAddresses(Collection loadBalancerAddresses) {
this.loadBalancerAddresses = LoadBalancerAddressesCopier.copy(loadBalancerAddresses);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder loadBalancerAddresses(LoadBalancerAddress... loadBalancerAddresses) {
loadBalancerAddresses(Arrays.asList(loadBalancerAddresses));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder loadBalancerAddresses(Consumer... loadBalancerAddresses) {
loadBalancerAddresses(Stream.of(loadBalancerAddresses)
.map(c -> LoadBalancerAddress.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public AvailabilityZone build() {
return new AvailabilityZone(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy