AwsApiGatewayV2ApiDetails (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsApiGatewayV2ApiDetails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>

@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.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsApiGatewayV2ApiDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AwsApiGatewayV2ApiDetails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

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
  - 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.
    
    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.
    
    Returns:
    
    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.
  - 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()
```
    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<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.43

Class AwsApiGatewayV2ApiDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

apiEndpoint

apiId

apiKeySelectionExpression

createdDate

description

version

name

protocolType

routeSelectionExpression

corsConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields