@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
AwsApiGatewayV2ApiDetails.Builder |
Modifier and Type | Method and 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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()
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()
The version identifier for the API.
|
copy
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.
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.
public final String apiId()
The identifier of the API.
public final String apiKeySelectionExpression()
An API key selection expression. Supported only for WebSocket APIs.
public final String createdDate()
Indicates when the API was created.
Uses the date-time
format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z
.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
public final String description()
A description of the API.
public final String version()
The version identifier for the API.
public final String name()
The name of the API.
public final String protocolType()
The API protocol for the API.
Valid values: WEBSOCKET
| HTTP
Valid values: WEBSOCKET
| HTTP
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.
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.
public final AwsCorsConfiguration corsConfiguration()
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
public AwsApiGatewayV2ApiDetails.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>
public static AwsApiGatewayV2ApiDetails.Builder builder()
public static Class<? extends AwsApiGatewayV2ApiDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.