software.amazon.awssdk.services.apigateway.model

Class EndpointConfiguration

java.lang.Object

software.amazon.awssdk.services.apigateway.model.EndpointConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointConfiguration.Builder,EndpointConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointConfiguration.Builder,EndpointConfiguration>

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static EndpointConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTypes() For responses, this returns true if the service returned a value for the Types property.
boolean	hasVpcEndpointIds() For responses, this returns true if the service returned a value for the VpcEndpointIds property.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointConfiguration.Builder>	serializableBuilderClass()
EndpointConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<EndpointType>	types() A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
List<String>	typesAsStrings() A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
List<String>	vpcEndpointIds() A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

types

public final List<EndpointType> 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.

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 hasTypes() method.

Returns:

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.

hasTypes

public final boolean hasTypes()

For responses, this returns true if the service returned a value for the Types property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

typesAsStrings

public final List<String> typesAsStrings()

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.

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 hasTypes() method.

Returns:

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.

hasVpcEndpointIds

public final boolean hasVpcEndpointIds()

For responses, this returns true if the service returned a value for the VpcEndpointIds property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

vpcEndpointIds

public final List<String> vpcEndpointIds()

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.

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 hasVpcEndpointIds() method.

Returns:

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

toBuilder

public EndpointConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointConfiguration.Builder,EndpointConfiguration>

builder

public static EndpointConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends EndpointConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo