AwsApiGatewayV2ApiDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsApiGatewayV2ApiDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsApiGatewayV2ApiDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a version 2 API in Amazon API Gateway.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsApiGatewayV2ApiDetails()

Constructors
Constructor and Description
`AwsApiGatewayV2ApiDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsApiGatewayV2ApiDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiEndpoint()` The URI of the API.
`String`	`getApiId()` The identifier of the API.
`String`	`getApiKeySelectionExpression()` An API key selection expression.
`AwsCorsConfiguration`	`getCorsConfiguration()` A cross-origin resource sharing (CORS) configuration.
`String`	`getCreatedDate()` Indicates when the API was created.
`String`	`getDescription()` A description of the API.
`String`	`getName()` The name of the API.
`String`	`getProtocolType()` The API protocol for the API.
`String`	`getRouteSelectionExpression()` The route selection expression for the API.
`String`	`getVersion()` The version identifier for the API.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiEndpoint(String apiEndpoint)` The URI of the API.
`void`	`setApiId(String apiId)` The identifier of the API.
`void`	`setApiKeySelectionExpression(String apiKeySelectionExpression)` An API key selection expression.
`void`	`setCorsConfiguration(AwsCorsConfiguration corsConfiguration)` A cross-origin resource sharing (CORS) configuration.
`void`	`setCreatedDate(String createdDate)` Indicates when the API was created.
`void`	`setDescription(String description)` A description of the API.
`void`	`setName(String name)` The name of the API.
`void`	`setProtocolType(String protocolType)` The API protocol for the API.
`void`	`setRouteSelectionExpression(String routeSelectionExpression)` The route selection expression for the API.
`void`	`setVersion(String version)` The version identifier for the API.
`String`	`toString()` Returns a string representation of this object.
`AwsApiGatewayV2ApiDetails`	`withApiEndpoint(String apiEndpoint)` The URI of the API.
`AwsApiGatewayV2ApiDetails`	`withApiId(String apiId)` The identifier of the API.
`AwsApiGatewayV2ApiDetails`	`withApiKeySelectionExpression(String apiKeySelectionExpression)` An API key selection expression.
`AwsApiGatewayV2ApiDetails`	`withCorsConfiguration(AwsCorsConfiguration corsConfiguration)` A cross-origin resource sharing (CORS) configuration.
`AwsApiGatewayV2ApiDetails`	`withCreatedDate(String createdDate)` Indicates when the API was created.
`AwsApiGatewayV2ApiDetails`	`withDescription(String description)` A description of the API.
`AwsApiGatewayV2ApiDetails`	`withName(String name)` The name of the API.
`AwsApiGatewayV2ApiDetails`	`withProtocolType(String protocolType)` The API protocol for the API.
`AwsApiGatewayV2ApiDetails`	`withRouteSelectionExpression(String routeSelectionExpression)` The route selection expression for the API.
`AwsApiGatewayV2ApiDetails`	`withVersion(String version)` The version identifier for the API.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsApiGatewayV2ApiDetails
```
public AwsApiGatewayV2ApiDetails()
```
- Method Detail
  - setApiEndpoint
```
public void setApiEndpoint(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.
    
    Parameters:
    
    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.
  - getApiEndpoint
```
public String getApiEndpoint()
```
    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.
  - withApiEndpoint
```
public AwsApiGatewayV2ApiDetails withApiEndpoint(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiId
```
public void setApiId(String apiId)
```
    The identifier of the API.
    
    Parameters:
    
    apiId - The identifier of the API.
  - getApiId
```
public String getApiId()
```
    The identifier of the API.
    
    Returns:
    
    The identifier of the API.
  - withApiId
```
public AwsApiGatewayV2ApiDetails withApiId(String apiId)
```
    The identifier of the API.
    
    Parameters:
    
    apiId - The identifier of the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiKeySelectionExpression
```
public void setApiKeySelectionExpression(String apiKeySelectionExpression)
```
    An API key selection expression. Supported only for WebSocket APIs.
    
    Parameters:
    
    apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs.
  - getApiKeySelectionExpression
```
public String getApiKeySelectionExpression()
```
    An API key selection expression. Supported only for WebSocket APIs.
    
    Returns:
    
    An API key selection expression. Supported only for WebSocket APIs.
  - withApiKeySelectionExpression
```
public AwsApiGatewayV2ApiDetails withApiKeySelectionExpression(String apiKeySelectionExpression)
```
    An API key selection expression. Supported only for WebSocket APIs.
    
    Parameters:
    
    apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(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)
    Parameters:
    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)
  - getCreatedDate
```
public String getCreatedDate()
```
    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)
  - withCreatedDate
```
public AwsApiGatewayV2ApiDetails withCreatedDate(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)
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the API.
    
    Parameters:
    
    description - A description of the API.
  - getDescription
```
public String getDescription()
```
    A description of the API.
    
    Returns:
    
    A description of the API.
  - withDescription
```
public AwsApiGatewayV2ApiDetails withDescription(String description)
```
    A description of the API.
    
    Parameters:
    
    description - A description of the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version identifier for the API.
    
    Parameters:
    
    version - The version identifier for the API.
  - getVersion
```
public String getVersion()
```
    The version identifier for the API.
    
    Returns:
    
    The version identifier for the API.
  - withVersion
```
public AwsApiGatewayV2ApiDetails withVersion(String version)
```
    The version identifier for the API.
    
    Parameters:
    
    version - The version identifier for the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the API.
    
    Parameters:
    
    name - The name of the API.
  - getName
```
public String getName()
```
    The name of the API.
    
    Returns:
    
    The name of the API.
  - withName
```
public AwsApiGatewayV2ApiDetails withName(String name)
```
    The name of the API.
    
    Parameters:
    
    name - The name of the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocolType
```
public void setProtocolType(String protocolType)
```
    The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
    
    Parameters:
    
    protocolType - The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
  - getProtocolType
```
public String getProtocolType()
```
    The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
    
    Returns:
    
    The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
  - withProtocolType
```
public AwsApiGatewayV2ApiDetails withProtocolType(String protocolType)
```
    The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
    
    Parameters:
    
    protocolType - The API protocol for the API.
    
    Valid values: WEBSOCKET | HTTP
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRouteSelectionExpression
```
public void setRouteSelectionExpression(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.
    
    Parameters:
    
    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.
  - getRouteSelectionExpression
```
public String getRouteSelectionExpression()
```
    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.
  - withRouteSelectionExpression
```
public AwsApiGatewayV2ApiDetails withRouteSelectionExpression(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCorsConfiguration
```
public void setCorsConfiguration(AwsCorsConfiguration corsConfiguration)
```
    A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
    
    Parameters:
    
    corsConfiguration - A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
  - getCorsConfiguration
```
public AwsCorsConfiguration getCorsConfiguration()
```
    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.
  - withCorsConfiguration
```
public AwsApiGatewayV2ApiDetails withCorsConfiguration(AwsCorsConfiguration corsConfiguration)
```
    A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
    
    Parameters:
    
    corsConfiguration - A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsApiGatewayV2ApiDetails clone()
```
    Overrides:
    
    clone 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.

AWS SDK for Java 1.x API Reference - 1.12.780

Class AwsApiGatewayV2ApiDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsApiGatewayV2ApiDetails

Method Detail

setApiEndpoint

getApiEndpoint

withApiEndpoint

setApiId

getApiId

withApiId

setApiKeySelectionExpression

getApiKeySelectionExpression

withApiKeySelectionExpression

setCreatedDate

getCreatedDate

withCreatedDate

setDescription

getDescription

withDescription

setVersion

getVersion

withVersion

setName

getName

withName

setProtocolType

getProtocolType

withProtocolType

setRouteSelectionExpression

getRouteSelectionExpression

withRouteSelectionExpression

setCorsConfiguration

getCorsConfiguration

withCorsConfiguration

toString

equals

hashCode

clone

marshall