software.amazon.awssdk.services.apigatewayv2.model

Class CreateApiRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request

software.amazon.awssdk.services.apigatewayv2.model.CreateApiRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateApiRequest.Builder,CreateApiRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateApiRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	apiKeySelectionExpression() An API key selection expression.
static CreateApiRequest.Builder	builder()
String	description() The description of the API.
Boolean	disableSchemaValidation() Avoid validating models when creating a deployment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the API.
ProtocolType	protocolType() The API protocol: Currently only WEBSOCKET is supported.
String	protocolTypeAsString() The API protocol: Currently only WEBSOCKET is supported.
String	routeSelectionExpression() The route selection expression for the API.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateApiRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The key-value map of strings.
CreateApiRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

apiKeySelectionExpression

public String apiKeySelectionExpression()

An API key selection expression. See API Key Selection Expressions.

Returns:

An API key selection expression. See API Key Selection Expressions.

description

public String description()

The description of the API.

Returns:

The description of the API.

disableSchemaValidation

public Boolean disableSchemaValidation()

Avoid validating models when creating a deployment.

Returns:

Avoid validating models when creating a deployment.

name

public String name()

The name of the API.

Returns:

The name of the API.

protocolType

public ProtocolType protocolType()

The API protocol: Currently only WEBSOCKET is supported.

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

Returns:

The API protocol: Currently only WEBSOCKET is supported.

See Also:

ProtocolType

protocolTypeAsString

public String protocolTypeAsString()

The API protocol: Currently only WEBSOCKET is supported.

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

Returns:

The API protocol: Currently only WEBSOCKET is supported.

See Also:

ProtocolType

routeSelectionExpression

public String routeSelectionExpression()

The route selection expression for the API.

Returns:

The route selection expression for the API.

version

public String version()

A version identifier for the API.

Returns:

A version identifier for the API.

tags

public Map<String,String> tags()

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

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

Returns:

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

toBuilder

public CreateApiRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateApiRequest.Builder,CreateApiRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

builder

public static CreateApiRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo