Api (AWS Java SDK :: Services :: ApiGatewayV2 2.17.33 API)

java.lang.Object
- software.amazon.awssdk.services.apigatewayv2.model.Api

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

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

Represents an API.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Api.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apiEndpoint()` The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
`Boolean`	`apiGatewayManaged()` Specifies whether an API is managed by API Gateway.
`String`	`apiId()` The API ID.
`String`	`apiKeySelectionExpression()` An API key selection expression.
`static Api.Builder`	`builder()`
`Cors`	`corsConfiguration()` A CORS configuration.
`Instant`	`createdDate()` The timestamp when the API was created.
`String`	`description()` The description of the API.
`Boolean`	`disableExecuteApiEndpoint()` Specifies whether clients can invoke your API by using the default execute-api endpoint.
`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()`
`boolean`	`hasImportInfo()` For responses, this returns true if the service returned a value for the ImportInfo property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasWarnings()` For responses, this returns true if the service returned a value for the Warnings property.
`List<String>`	`importInfo()` The validation information during API import.
`String`	`name()` The name of the API.
`ProtocolType`	`protocolType()` The API protocol.
`String`	`protocolTypeAsString()` The API protocol.
`String`	`routeSelectionExpression()` The route selection expression for the API.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Api.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A collection of tags associated with the API.
`Api.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` A version identifier for the API.
`List<String>`	`warnings()` The warning messages reported when failonwarnings is turned on during API import.

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, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    
    Returns:
    
    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
  - apiGatewayManaged
```
public final Boolean apiGatewayManaged()
```
    Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
    
    Returns:
    
    Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
  - apiId
```
public final String apiId()
```
    The API ID.
    
    Returns:
    
    The API ID.
  - apiKeySelectionExpression
```
public final String apiKeySelectionExpression()
```
    An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    
    Returns:
    
    An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
  - corsConfiguration
```
public final Cors corsConfiguration()
```
    A CORS configuration. Supported only for HTTP APIs.
    
    Returns:
    
    A CORS configuration. Supported only for HTTP APIs.
  - createdDate
```
public final Instant createdDate()
```
    The timestamp when the API was created.
    
    Returns:
    
    The timestamp when the API was created.
  - description
```
public final String description()
```
    The description of the API.
    
    Returns:
    
    The description of the API.
  - disableSchemaValidation
```
public final Boolean disableSchemaValidation()
```
    Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    
    Returns:
    
    Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
  - disableExecuteApiEndpoint
```
public final Boolean disableExecuteApiEndpoint()
```
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
    
    Returns:
    
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
  - hasImportInfo
```
public final boolean hasImportInfo()
```
    For responses, this returns true if the service returned a value for the ImportInfo property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - importInfo
```
public final List<String> importInfo()
```
    The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImportInfo() method.
    
    Returns:
    
    The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
  - name
```
public final String name()
```
    The name of the API.
    
    Returns:
    
    The name of the API.
  - protocolType
```
public final ProtocolType protocolType()
```
    The API protocol.
    
    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.
    
    See Also:
    
    ProtocolType
  - protocolTypeAsString
```
public final String protocolTypeAsString()
```
    The API protocol.
    
    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.
    
    See Also:
    
    ProtocolType
  - routeSelectionExpression
```
public final String routeSelectionExpression()
```
    The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    
    Returns:
    
    The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    A collection of tags associated with the API.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A collection of tags associated with the API.
  - version
```
public final String version()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - hasWarnings
```
public final boolean hasWarnings()
```
    For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - warnings
```
public final List<String> warnings()
```
    The warning messages reported when failonwarnings is turned on during API import.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWarnings() method.
    
    Returns:
    
    The warning messages reported when failonwarnings is turned on during API import.
  - toBuilder
```
public Api.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Api.Builder,Api>
  - builder
```
public static Api.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Api.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

Class Api

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

apiGatewayManaged

apiId

apiKeySelectionExpression

corsConfiguration

createdDate

description

disableSchemaValidation

disableExecuteApiEndpoint

hasImportInfo

importInfo

name

protocolType

protocolTypeAsString

routeSelectionExpression

hasTags

tags

version

hasWarnings

warnings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields