software.amazon.awssdk.services.apigateway.model.EndpointConfiguration Maven / Gradle / Ivy
Show all versions of apigateway 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.apigateway.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.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;
/**
*
* The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name
* (DomainName) has.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(EndpointConfiguration::typesAsStrings))
.setter(setter(Builder::typesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("types").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> VPC_ENDPOINT_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(EndpointConfiguration::vpcEndpointIds))
.setter(setter(Builder::vpcEndpointIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("vpcEndpointIds").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(TYPES_FIELD,
VPC_ENDPOINT_IDS_FIELD));
private static final long serialVersionUID = 1L;
private final List types;
private final List vpcEndpointIds;
private EndpointConfiguration(BuilderImpl builder) {
this.types = builder.types;
this.vpcEndpointIds = builder.vpcEndpointIds;
}
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and
* its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is
* PRIVATE.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTypes()} to see if a value was sent in this field.
*
*
* @return A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional
* API and its custom domain name, the endpoint type is REGIONAL. For a private API, the
* endpoint type is PRIVATE.
*/
public List types() {
return ListOfEndpointTypeCopier.copyStringToEnum(types);
}
/**
* Returns true if the Types property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasTypes() {
return types != null && !(types instanceof SdkAutoConstructList);
}
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and
* its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is
* PRIVATE.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTypes()} to see if a value was sent in this field.
*
*
* @return A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional
* API and its custom domain name, the endpoint type is REGIONAL. For a private API, the
* endpoint type is PRIVATE.
*/
public List typesAsStrings() {
return types;
}
/**
* Returns true if the VpcEndpointIds property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasVpcEndpointIds() {
return vpcEndpointIds != null && !(vpcEndpointIds instanceof SdkAutoConstructList);
}
/**
*
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported
* for PRIVATE endpoint type.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasVpcEndpointIds()} to see if a value was sent in this field.
*
*
* @return A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only
* supported for PRIVATE endpoint type.
*/
public List vpcEndpointIds() {
return vpcEndpointIds;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typesAsStrings());
hashCode = 31 * hashCode + Objects.hashCode(vpcEndpointIds());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointConfiguration)) {
return false;
}
EndpointConfiguration other = (EndpointConfiguration) obj;
return Objects.equals(typesAsStrings(), other.typesAsStrings())
&& Objects.equals(vpcEndpointIds(), other.vpcEndpointIds());
}
/**
* 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 String toString() {
return ToString.builder("EndpointConfiguration").add("Types", typesAsStrings()).add("VpcEndpointIds", vpcEndpointIds())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "types":
return Optional.ofNullable(clazz.cast(typesAsStrings()));
case "vpcEndpointIds":
return Optional.ofNullable(clazz.cast(vpcEndpointIds()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API
* and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type
* is PRIVATE.
*
*
* @param types
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For
* an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a
* regional API and its custom domain name, the endpoint type is REGIONAL. For a private
* API, the endpoint type is PRIVATE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder typesWithStrings(Collection types);
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API
* and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type
* is PRIVATE.
*
*
* @param types
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For
* an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a
* regional API and its custom domain name, the endpoint type is REGIONAL. For a private
* API, the endpoint type is PRIVATE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder typesWithStrings(String... types);
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API
* and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type
* is PRIVATE.
*
*
* @param types
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For
* an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a
* regional API and its custom domain name, the endpoint type is REGIONAL. For a private
* API, the endpoint type is PRIVATE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder types(Collection types);
/**
*
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an
* edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API
* and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type
* is PRIVATE.
*
*
* @param types
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For
* an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a
* regional API and its custom domain name, the endpoint type is REGIONAL. For a private
* API, the endpoint type is PRIVATE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder types(EndpointType... types);
/**
*
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only
* supported for PRIVATE endpoint type.
*
*
* @param vpcEndpointIds
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is
* only supported for PRIVATE endpoint type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcEndpointIds(Collection vpcEndpointIds);
/**
*
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only
* supported for PRIVATE endpoint type.
*
*
* @param vpcEndpointIds
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is
* only supported for PRIVATE endpoint type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcEndpointIds(String... vpcEndpointIds);
}
static final class BuilderImpl implements Builder {
private List types = DefaultSdkAutoConstructList.getInstance();
private List vpcEndpointIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(EndpointConfiguration model) {
typesWithStrings(model.types);
vpcEndpointIds(model.vpcEndpointIds);
}
public final Collection getTypes() {
return types;
}
@Override
public final Builder typesWithStrings(Collection types) {
this.types = ListOfEndpointTypeCopier.copy(types);
return this;
}
@Override
@SafeVarargs
public final Builder typesWithStrings(String... types) {
typesWithStrings(Arrays.asList(types));
return this;
}
@Override
public final Builder types(Collection types) {
this.types = ListOfEndpointTypeCopier.copyEnumToString(types);
return this;
}
@Override
@SafeVarargs
public final Builder types(EndpointType... types) {
types(Arrays.asList(types));
return this;
}
public final void setTypes(Collection types) {
this.types = ListOfEndpointTypeCopier.copy(types);
}
public final Collection getVpcEndpointIds() {
return vpcEndpointIds;
}
@Override
public final Builder vpcEndpointIds(Collection vpcEndpointIds) {
this.vpcEndpointIds = ListOfStringCopier.copy(vpcEndpointIds);
return this;
}
@Override
@SafeVarargs
public final Builder vpcEndpointIds(String... vpcEndpointIds) {
vpcEndpointIds(Arrays.asList(vpcEndpointIds));
return this;
}
public final void setVpcEndpointIds(Collection vpcEndpointIds) {
this.vpcEndpointIds = ListOfStringCopier.copy(vpcEndpointIds);
}
@Override
public EndpointConfiguration build() {
return new EndpointConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}