java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request
    - - software.amazon.awssdk.services.apigatewayv2.model.UpdateApiRequest

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

@Generated("software.amazon.awssdk:codegen")
public final class UpdateApiRequest
extends ApiGatewayV2Request
implements ToCopyableBuilder<UpdateApiRequest.Builder,UpdateApiRequest>

Updates an Api.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateApiRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apiId()`	The API identifier.
`String`	`apiKeySelectionExpression()`	An API key selection expression.
`static UpdateApiRequest.Builder`	`builder()`
`Cors`	`corsConfiguration()`	A CORS configuration.
`String`	`credentialsArn()`	This property is part of quick create.
`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()`
`String`	`name()`	The name of the API.
`String`	`routeKey()`	This property is part of quick create.
`String`	`routeSelectionExpression()`	The route selection expression for the API.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateApiRequest.Builder>`	`serializableBuilderClass()`
`String`	`target()`	This property is part of quick create.
`UpdateApiRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`version()`	A version identifier for the API.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - apiId
```
public final String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - 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.
  - credentialsArn
```
public final String credentialsArn()
```
    This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
    
    Returns:
    
    This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
  - 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.
  - name
```
public final String name()
```
    The name of the API.
    
    Returns:
    
    The name of the API.
  - routeKey
```
public final String routeKey()
```
    This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
    
    Returns:
    
    This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
  - 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.
  - target
```
public final String target()
```
    This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
    
    Returns:
    
    This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
  - version
```
public final String version()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - toBuilder
```
public UpdateApiRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateApiRequest.Builder,UpdateApiRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
  - builder
```
public static UpdateApiRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateApiRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateApiRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

apiId

apiKeySelectionExpression

corsConfiguration

credentialsArn

description

disableSchemaValidation

disableExecuteApiEndpoint

name

routeKey

routeSelectionExpression

target

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField