Package software.amazon.awssdk.services.securityhub.model

Class AwsApiGatewayV2ApiDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsApiGatewayV2ApiDetails

All Implemented Interfaces:

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

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

Contains information about a version 2 API in Amazon API Gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsApiGatewayV2ApiDetails.Builder

Method Summary

Modifier and Type	Method	Description
String	apiEndpoint()	The URI of the API.
String	apiId()	The identifier of the API.
String	apiKeySelectionExpression()	An API key selection expression.
static AwsApiGatewayV2ApiDetails.Builder	builder()
AwsCorsConfiguration	corsConfiguration()	A cross-origin resource sharing (CORS) configuration.
String	createdDate()	Indicates when the API was created.
String	description()	A description of the API.
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.
String	protocolType()	The API protocol for the API.
String	routeSelectionExpression()	The route selection expression for the API.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiGatewayV2ApiDetails.Builder>	serializableBuilderClass()
AwsApiGatewayV2ApiDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The version identifier for the API.

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

apiEndpoint

public final String apiEndpoint()

The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

Returns:

The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

apiId

public final String apiId()

The identifier of the API.

Returns:

The identifier of the API.

apiKeySelectionExpression

public final String apiKeySelectionExpression()

An API key selection expression. Supported only for WebSocket APIs.

Returns:

An API key selection expression. Supported only for WebSocket APIs.

createdDate

public final String createdDate()

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

description

public final String description()

A description of the API.

Returns:

A description of the API.

version

public final String version()

The version identifier for the API.

Returns:

The version identifier for the API.

name

public final String name()

The name of the API.

Returns:

The name of the API.

protocolType

public final String protocolType()

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

Returns:

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

routeSelectionExpression

public final String routeSelectionExpression()

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

Returns:

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

corsConfiguration

public final AwsCorsConfiguration corsConfiguration()

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

Returns:

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

toBuilder

public AwsApiGatewayV2ApiDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>

builder

public static AwsApiGatewayV2ApiDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsApiGatewayV2ApiDetails.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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