com.amazonaws.services.apigateway.model

Class EndpointConfiguration

java.lang.Object

com.amazonaws.services.apigateway.model.EndpointConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointConfiguration()

Method Summary

Modifier and Type	Method and Description
EndpointConfiguration	clone()
boolean	equals(Object obj)
List<String>	getTypes() A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
List<String>	getVpcEndpointIds() A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setTypes(Collection<String> types) A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
void	setVpcEndpointIds(Collection<String> vpcEndpointIds) A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.
String	toString() Returns a string representation of this object.
EndpointConfiguration	withTypes(Collection<String> types) A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
EndpointConfiguration	withTypes(EndpointType... types) A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
EndpointConfiguration	withTypes(String... types) A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
EndpointConfiguration	withVpcEndpointIds(Collection<String> vpcEndpointIds) A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.
EndpointConfiguration	withVpcEndpointIds(String... vpcEndpointIds) A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointConfiguration

public EndpointConfiguration()

Method Detail

getTypes

public List<String> getTypes()

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.

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.

See Also:

EndpointType

setTypes

public void setTypes(Collection<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.

Parameters:

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.

See Also:

EndpointType

withTypes

public EndpointConfiguration withTypes(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.

NOTE: This method appends the values to the existing list (if any). Use setTypes(java.util.Collection) or withTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointType

withTypes

public EndpointConfiguration withTypes(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointType

withTypes

public EndpointConfiguration withTypes(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointType

getVpcEndpointIds

public List<String> getVpcEndpointIds()

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

Returns:

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

setVpcEndpointIds

public void setVpcEndpointIds(Collection<String> vpcEndpointIds)

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

Parameters:

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

withVpcEndpointIds

public EndpointConfiguration withVpcEndpointIds(String... vpcEndpointIds)

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

NOTE: This method appends the values to the existing list (if any). Use setVpcEndpointIds(java.util.Collection) or withVpcEndpointIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withVpcEndpointIds

public EndpointConfiguration withVpcEndpointIds(Collection<String> vpcEndpointIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EndpointConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.