software.amazon.awssdk.services.opensearch.model.VPCDerivedInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
The AWS Java SDK for Open Search module holds the client classes that are used for
communicating with Open Search.
/*
* 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.opensearch.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.Function;
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;
/**
*
* Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your
* Amazon OpenSearch Service domains using a VPC.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class VPCDerivedInfo implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VPCId")
.getter(getter(VPCDerivedInfo::vpcId)).setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VPCId").build()).build();
private static final SdkField> SUBNET_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubnetIds")
.getter(getter(VPCDerivedInfo::subnetIds))
.setter(setter(Builder::subnetIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> AVAILABILITY_ZONES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AvailabilityZones")
.getter(getter(VPCDerivedInfo::availabilityZones))
.setter(setter(Builder::availabilityZones))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AvailabilityZones").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SECURITY_GROUP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SecurityGroupIds")
.getter(getter(VPCDerivedInfo::securityGroupIds))
.setter(setter(Builder::securityGroupIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecurityGroupIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VPC_ID_FIELD,
SUBNET_IDS_FIELD, AVAILABILITY_ZONES_FIELD, SECURITY_GROUP_IDS_FIELD));
private static final long serialVersionUID = 1L;
private final String vpcId;
private final List subnetIds;
private final List availabilityZones;
private final List securityGroupIds;
private VPCDerivedInfo(BuilderImpl builder) {
this.vpcId = builder.vpcId;
this.subnetIds = builder.subnetIds;
this.availabilityZones = builder.availabilityZones;
this.securityGroupIds = builder.securityGroupIds;
}
/**
*
* The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
*
*
* @return The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
*/
public final String vpcId() {
return vpcId;
}
/**
* For responses, this returns true if the service returned a value for the SubnetIds 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 hasSubnetIds() {
return subnetIds != null && !(subnetIds instanceof SdkAutoConstructList);
}
/**
*
* The subnets for the VPC endpoint.
*
*
* 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 #hasSubnetIds} method.
*
*
* @return The subnets for the VPC endpoint.
*/
public final List subnetIds() {
return subnetIds;
}
/**
* For responses, this returns true if the service returned a value for the AvailabilityZones 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 hasAvailabilityZones() {
return availabilityZones != null && !(availabilityZones instanceof SdkAutoConstructList);
}
/**
*
* The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
*
*
* 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 #hasAvailabilityZones} method.
*
*
* @return The Availability Zones for the domain. Exists only if the domain was created with VPCOptions
* .
*/
public final List availabilityZones() {
return availabilityZones;
}
/**
* For responses, this returns true if the service returned a value for the SecurityGroupIds 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 hasSecurityGroupIds() {
return securityGroupIds != null && !(securityGroupIds instanceof SdkAutoConstructList);
}
/**
*
* The security groups for the VPC endpoint.
*
*
* 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 #hasSecurityGroupIds} method.
*
*
* @return The security groups for the VPC endpoint.
*/
public final List securityGroupIds() {
return securityGroupIds;
}
@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(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(hasSubnetIds() ? subnetIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAvailabilityZones() ? availabilityZones() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSecurityGroupIds() ? securityGroupIds() : 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 VPCDerivedInfo)) {
return false;
}
VPCDerivedInfo other = (VPCDerivedInfo) obj;
return Objects.equals(vpcId(), other.vpcId()) && hasSubnetIds() == other.hasSubnetIds()
&& Objects.equals(subnetIds(), other.subnetIds()) && hasAvailabilityZones() == other.hasAvailabilityZones()
&& Objects.equals(availabilityZones(), other.availabilityZones())
&& hasSecurityGroupIds() == other.hasSecurityGroupIds()
&& Objects.equals(securityGroupIds(), other.securityGroupIds());
}
/**
* 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("VPCDerivedInfo").add("VPCId", vpcId()).add("SubnetIds", hasSubnetIds() ? subnetIds() : null)
.add("AvailabilityZones", hasAvailabilityZones() ? availabilityZones() : null)
.add("SecurityGroupIds", hasSecurityGroupIds() ? securityGroupIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "VPCId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "SubnetIds":
return Optional.ofNullable(clazz.cast(subnetIds()));
case "AvailabilityZones":
return Optional.ofNullable(clazz.cast(availabilityZones()));
case "SecurityGroupIds":
return Optional.ofNullable(clazz.cast(securityGroupIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((VPCDerivedInfo) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
*
*
* @param vpcId
* The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* The subnets for the VPC endpoint.
*
*
* @param subnetIds
* The subnets for the VPC endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(Collection subnetIds);
/**
*
* The subnets for the VPC endpoint.
*
*
* @param subnetIds
* The subnets for the VPC endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(String... subnetIds);
/**
*
* The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
*
*
* @param availabilityZones
* The Availability Zones for the domain. Exists only if the domain was created with
* VPCOptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availabilityZones(Collection availabilityZones);
/**
*
* The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
*
*
* @param availabilityZones
* The Availability Zones for the domain. Exists only if the domain was created with
* VPCOptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder availabilityZones(String... availabilityZones);
/**
*
* The security groups for the VPC endpoint.
*
*
* @param securityGroupIds
* The security groups for the VPC endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityGroupIds(Collection securityGroupIds);
/**
*
* The security groups for the VPC endpoint.
*
*
* @param securityGroupIds
* The security groups for the VPC endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityGroupIds(String... securityGroupIds);
}
static final class BuilderImpl implements Builder {
private String vpcId;
private List subnetIds = DefaultSdkAutoConstructList.getInstance();
private List availabilityZones = DefaultSdkAutoConstructList.getInstance();
private List securityGroupIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(VPCDerivedInfo model) {
vpcId(model.vpcId);
subnetIds(model.subnetIds);
availabilityZones(model.availabilityZones);
securityGroupIds(model.securityGroupIds);
}
public final String getVpcId() {
return vpcId;
}
public final void setVpcId(String vpcId) {
this.vpcId = vpcId;
}
@Override
@Transient
public final Builder vpcId(String vpcId) {
this.vpcId = vpcId;
return this;
}
public final Collection getSubnetIds() {
if (subnetIds instanceof SdkAutoConstructList) {
return null;
}
return subnetIds;
}
public final void setSubnetIds(Collection subnetIds) {
this.subnetIds = StringListCopier.copy(subnetIds);
}
@Override
@Transient
public final Builder subnetIds(Collection subnetIds) {
this.subnetIds = StringListCopier.copy(subnetIds);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder subnetIds(String... subnetIds) {
subnetIds(Arrays.asList(subnetIds));
return this;
}
public final Collection getAvailabilityZones() {
if (availabilityZones instanceof SdkAutoConstructList) {
return null;
}
return availabilityZones;
}
public final void setAvailabilityZones(Collection availabilityZones) {
this.availabilityZones = StringListCopier.copy(availabilityZones);
}
@Override
@Transient
public final Builder availabilityZones(Collection availabilityZones) {
this.availabilityZones = StringListCopier.copy(availabilityZones);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder availabilityZones(String... availabilityZones) {
availabilityZones(Arrays.asList(availabilityZones));
return this;
}
public final Collection getSecurityGroupIds() {
if (securityGroupIds instanceof SdkAutoConstructList) {
return null;
}
return securityGroupIds;
}
public final void setSecurityGroupIds(Collection securityGroupIds) {
this.securityGroupIds = StringListCopier.copy(securityGroupIds);
}
@Override
@Transient
public final Builder securityGroupIds(Collection securityGroupIds) {
this.securityGroupIds = StringListCopier.copy(securityGroupIds);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder securityGroupIds(String... securityGroupIds) {
securityGroupIds(Arrays.asList(securityGroupIds));
return this;
}
@Override
public VPCDerivedInfo build() {
return new VPCDerivedInfo(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy