CreateRestApiRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.CreateRestApiRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateRestApiRequest.Builder,CreateRestApiRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRestApiRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<CreateRestApiRequest.Builder,CreateRestApiRequest>

The POST Request to add a new RestApi resource to your collection.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateRestApiRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateRestApiRequest.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 CreateRestApiRequest.Builder`	`builder()`
`String`	`cloneFrom()` The ID of the RestApi that you want to clone from.
`String`	`description()` The description of the RestApi.
`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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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()` [Required] The name of the RestApi.
`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 CreateRestApiRequest.Builder>`	`serializableBuilderClass()`
`CreateRestApiRequest.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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - name
```
public String name()
```
    [Required] The name of the RestApi.
    
    Returns:
    
    [Required] The name of the RestApi.
  - description
```
public String description()
```
    The description of the RestApi.
    
    Returns:
    
    The description of the RestApi.
  - version
```
public String version()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - cloneFrom
```
public String cloneFrom()
```
    The ID of the RestApi that you want to clone from.
    
    Returns:
    
    The ID of the RestApi that you want to clone from.
  - 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 CreateRestApiRequest.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<CreateRestApiRequest.Builder,CreateRestApiRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateRestApiRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRestApiRequest.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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - 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.

Class CreateRestApiRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

name

description

version

cloneFrom

binaryMediaTypes

minimumCompressionSize

apiKeySource

apiKeySourceAsString

endpointConfiguration

policy

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields