Package software.amazon.awssdk.services.apigateway.model

Class RestApi

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RestApi.Builder,RestApi>

@Generated("software.amazon.awssdk:codegen")
public class RestApi
extends Object
implements StructuredPojo, ToCopyableBuilder<RestApi.Builder,RestApi>

Represents a REST API.

Create an API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestApi.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	binaryMediaTypes()	The list of binary media types supported by the RestApi.
static RestApi.Builder	builder()
Date	createdDate()	The timestamp when the API was created.
String	description()	The API's description.
boolean	equals(Object obj)
int	hashCode()
String	id()	The API's identifier.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The API's name.
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

Method Detail

id

public String id()

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

Returns:

The API's identifier. This identifier is unique across all of your APIs in Amazon 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 Date 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.

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.

Returns:

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

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

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.