software.amazon.awssdk.services.apigateway.model

Class RestApi

java.lang.Object

software.amazon.awssdk.services.apigateway.model.RestApi

All Implemented Interfaces:

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

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

Represents a REST API.

Create an API

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestApi.Builder

Method Summary

Modifier and Type	Method and Description
ApiKeySourceType	apiKeySource() The source of the API key for metering requests according to a usage plan.
String	apiKeySourceAsString() The source of the API key for metering requests according to a usage plan.
List<String>	binaryMediaTypes() The list of binary media types supported by the RestApi.
static RestApi.Builder	builder()
Instant	createdDate() The timestamp when the API was created.
String	description() The API's description.
EndpointConfiguration	endpointConfiguration() The endpoint configuration of this RestApi showing the endpoint types of the API.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The API's identifier.
Integer	minimumCompressionSize() A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.
String	name() The API's name.
String	policy() A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends RestApi.Builder>	serializableBuilderClass()
RestApi.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	version() A version identifier for the API.
List<String>	warnings() The warning messages reported when failonwarnings is turned on during API import.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public String id()

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Returns:

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

name

public String name()

The API's name.

Returns:

The API's name.

description

public String description()

The API's description.

Returns:

The API's description.

createdDate

public Instant createdDate()

The timestamp when the API was created.

Returns:

The timestamp when the API was created.

version

public String version()

A version identifier for the API.

Returns:

A version identifier for the API.

warnings

public List<String> warnings()

The warning messages reported when failonwarnings is turned on during API import.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The warning messages reported when failonwarnings is turned on during API import.

binaryMediaTypes

public List<String> binaryMediaTypes()

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

minimumCompressionSize

public Integer minimumCompressionSize()

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Returns:

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

apiKeySource

public ApiKeySourceType apiKeySource()

The source of the API key for metering requests according to a usage plan. Valid values are:

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

If the service returns an enum value that is not available in the current SDK version, apiKeySource will return ApiKeySourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiKeySourceAsString().

Returns:

The source of the API key for metering requests according to a usage plan. Valid values are:

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

See Also:

ApiKeySourceType

apiKeySourceAsString

public String apiKeySourceAsString()

The source of the API key for metering requests according to a usage plan. Valid values are:

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

If the service returns an enum value that is not available in the current SDK version, apiKeySource will return ApiKeySourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiKeySourceAsString().

Returns:

The source of the API key for metering requests according to a usage plan. Valid values are:

• HEADER to read the API key from the X-API-Key header of a request.
• AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

See Also:

ApiKeySourceType

endpointConfiguration

public EndpointConfiguration endpointConfiguration()

The endpoint configuration of this RestApi showing the endpoint types of the API.

Returns:

The endpoint configuration of this RestApi showing the endpoint types of the API.

policy

public String policy()

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Returns:

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

toBuilder

public RestApi.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RestApi.Builder,RestApi>

Returns:

a builder for type T

builder

public static RestApi.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.