GetApiResponse (AWS Java SDK :: Services :: ApiGatewayV2 2.9.26 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
    - - software.amazon.awssdk.services.apigatewayv2.model.GetApiResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetApiResponse.Builder,GetApiResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetApiResponse
extends ApiGatewayV2Response
implements ToCopyableBuilder<GetApiResponse.Builder,GetApiResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetApiResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetApiResponse.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.
`String`	`apiId()` The API ID.
`String`	`apiKeySelectionExpression()` An API key selection expression.
`static GetApiResponse.Builder`	`builder()`
`Instant`	`createdDate()` The timestamp when the API was created.
`String`	`description()` The description of the API.
`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()`
`String`	`name()` The name of the API.
`ProtocolType`	`protocolType()` The API protocol: Currently only WEBSOCKET is supported.
`String`	`protocolTypeAsString()` The API protocol: Currently only WEBSOCKET is supported.
`String`	`routeSelectionExpression()` The route selection expression for the API.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetApiResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The key-value map of strings.
`GetApiResponse.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 software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 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.
  - apiId
```
public String apiId()
```
    The API ID.
    
    Returns:
    
    The API ID.
  - apiKeySelectionExpression
```
public String apiKeySelectionExpression()
```
    An API key selection expression. See API Key Selection Expressions.
    
    Returns:
    
    An API key selection expression. See API Key Selection Expressions.
  - createdDate
```
public Instant createdDate()
```
    The timestamp when the API was created.
    
    Returns:
    
    The timestamp when the API was created.
  - description
```
public String description()
```
    The description of the API.
    
    Returns:
    
    The description of the API.
  - disableSchemaValidation
```
public Boolean disableSchemaValidation()
```
    Avoid validating models when creating a deployment.
    
    Returns:
    
    Avoid validating models when creating a deployment.
  - name
```
public String name()
```
    The name of the API.
    
    Returns:
    
    The name of the API.
  - protocolType
```
public ProtocolType protocolType()
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    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: Currently only WEBSOCKET is supported.
    
    See Also:
    
    ProtocolType
  - protocolTypeAsString
```
public String protocolTypeAsString()
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    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: Currently only WEBSOCKET is supported.
    
    See Also:
    
    ProtocolType
  - routeSelectionExpression
```
public String routeSelectionExpression()
```
    The route selection expression for the API.
    
    Returns:
    
    The route selection expression for the API.
  - version
```
public String version()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - warnings
```
public 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.
    
    Returns:
    
    The warning messages reported when failonwarnings is turned on during API import.
  - tags
```
public Map<String,String> tags()
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
  - toBuilder
```
public GetApiResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetApiResponse.Builder,GetApiResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetApiResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetApiResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetApiResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

apiEndpoint

apiId

apiKeySelectionExpression

createdDate

description

disableSchemaValidation

name

protocolType

protocolTypeAsString

routeSelectionExpression

version

warnings

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields