RestApi (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RestApi.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`Boolean`	`disableExecuteApiEndpoint()` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`EndpointConfiguration`	`endpointConfiguration()` The endpoint configuration of this RestApi showing the endpoint types of the API.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBinaryMediaTypes()` Returns true if the BinaryMediaTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasWarnings()` Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()`
`Map<String,String>`	`tags()` The collection of tags.
`RestApi.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`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 final 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 final String name()
```
    The API's name.
    
    Returns:
    
    The API's name.
  - description
```
public final String description()
```
    The API's description.
    
    Returns:
    
    The API's description.
  - createdDate
```
public final Instant createdDate()
```
    The timestamp when the API was created.
    
    Returns:
    
    The timestamp when the API was created.
  - version
```
public final String version()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - hasWarnings
```
public final boolean hasWarnings()
```
    Returns true if the Warnings 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.
  - warnings
```
public final 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.
    
    You can use hasWarnings() to see if a value was sent in this field.
    
    Returns:
    
    The warning messages reported when failonwarnings is turned on during API import.
  - hasBinaryMediaTypes
```
public final boolean hasBinaryMediaTypes()
```
    Returns true if the BinaryMediaTypes 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.
  - binaryMediaTypes
```
public final 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.
    
    You can use hasBinaryMediaTypes() to see if a value was sent in this field.
    
    Returns:
    
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
  - minimumCompressionSize
```
public final 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 final 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 final 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 final 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 final 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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - disableExecuteApiEndpoint
```
public final Boolean disableExecuteApiEndpoint()
```
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
    
    Returns:
    
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
  - 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 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.44

Class RestApi

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

name

description

createdDate

version

hasWarnings

warnings

hasBinaryMediaTypes

binaryMediaTypes

minimumCompressionSize

apiKeySource

apiKeySourceAsString

endpointConfiguration

policy

hasTags

tags

disableExecuteApiEndpoint

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields