UpdateIntegrationRequest (AWS Java SDK :: Services

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateIntegrationRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apiId()` The API identifier.
`static UpdateIntegrationRequest.Builder`	`builder()`
`String`	`connectionId()` The connection ID.
`ConnectionType`	`connectionType()` The type of the network connection to the integration endpoint.
`String`	`connectionTypeAsString()` The type of the network connection to the integration endpoint.
`ContentHandlingStrategy`	`contentHandlingStrategy()` Specifies how to handle response payload content type conversions.
`String`	`contentHandlingStrategyAsString()` Specifies how to handle response payload content type conversions.
`String`	`credentialsArn()` Specifies the credentials required for the integration, if any.
`String`	`description()` The description of the integration
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`integrationId()` The integration ID.
`String`	`integrationMethod()` Specifies the integration's HTTP method type.
`IntegrationType`	`integrationType()` The integration type of an integration.
`String`	`integrationTypeAsString()` The integration type of an integration.
`String`	`integrationUri()` For a Lambda proxy integration, this is the URI of the Lambda function.
`PassthroughBehavior`	`passthroughBehavior()` Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
`String`	`passthroughBehaviorAsString()` Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
`Map<String,String>`	`requestParameters()` A key-value map specifying request parameters that are passed from the method request to the backend.
`Map<String,String>`	`requestTemplates()` Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateIntegrationRequest.Builder>`	`serializableBuilderClass()`
`String`	`templateSelectionExpression()` The template selection expression for the integration.
`Integer`	`timeoutInMillis()` Custom timeout between 50 and 29,000 milliseconds.
`UpdateIntegrationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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 String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - connectionId
```
public String connectionId()
```
    The connection ID.
    
    Returns:
    
    The connection ID.
  - connectionType
```
public ConnectionType connectionType()
```
    The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    
    Returns:
    
    The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    
    See Also:
    
    ConnectionType
  - connectionTypeAsString
```
public String connectionTypeAsString()
```
    The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    
    Returns:
    
    The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    
    See Also:
    
    ConnectionType
  - contentHandlingStrategy
```
public ContentHandlingStrategy contentHandlingStrategy()
```
    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    
    If the service returns an enum value that is not available in the current SDK version, contentHandlingStrategy will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingStrategyAsString().
    
    Returns:
    
    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    
    See Also:
    
    ContentHandlingStrategy
  - contentHandlingStrategyAsString
```
public String contentHandlingStrategyAsString()
```
    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    
    If the service returns an enum value that is not available in the current SDK version, contentHandlingStrategy will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingStrategyAsString().
    
    Returns:
    
    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    
    See Also:
    
    ContentHandlingStrategy
  - credentialsArn
```
public String credentialsArn()
```
    Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
    
    Returns:
    
    Specifies the credentials required for the integration, if any. For AWS integrations, 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 the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
  - description
```
public String description()
```
    The description of the integration
    
    Returns:
    
    The description of the integration
  - integrationId
```
public String integrationId()
```
    The integration ID.
    
    Returns:
    
    The integration ID.
  - integrationMethod
```
public String integrationMethod()
```
    Specifies the integration's HTTP method type.
    
    Returns:
    
    Specifies the integration's HTTP method type.
  - integrationType
```
public IntegrationType integrationType()
```
    The integration type of an integration. One of the following:
    
    AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
    
    HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
    
    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.
    
    If the service returns an enum value that is not available in the current SDK version, integrationType will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from integrationTypeAsString().
    
    Returns:
    
    The integration type of an integration. One of the following:
    
    AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
    
    HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
    
    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.
    
    See Also:
    
    IntegrationType
  - integrationTypeAsString
```
public String integrationTypeAsString()
```
    The integration type of an integration. One of the following:
    
    AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
    
    HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
    
    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.
    
    If the service returns an enum value that is not available in the current SDK version, integrationType will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from integrationTypeAsString().
    
    Returns:
    
    The integration type of an integration. One of the following:
    
    AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
    
    HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
    
    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.
    
    See Also:
    
    IntegrationType
  - integrationUri
```
public String integrationUri()
```
    For a Lambda proxy integration, this is the URI of the Lambda function.
    
    Returns:
    
    For a Lambda proxy integration, this is the URI of the Lambda function.
  - passthroughBehavior
```
public PassthroughBehavior passthroughBehavior()
```
    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
    
    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
    
    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
    
    If the service returns an enum value that is not available in the current SDK version, passthroughBehavior will return PassthroughBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from passthroughBehaviorAsString().
    
    Returns:
    
    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
    
    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
    
    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
    
    See Also:
    
    PassthroughBehavior
  - passthroughBehaviorAsString
```
public String passthroughBehaviorAsString()
```
    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
    
    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
    
    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
    
    If the service returns an enum value that is not available in the current SDK version, passthroughBehavior will return PassthroughBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from passthroughBehaviorAsString().
    
    Returns:
    
    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
    
    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
    
    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
    
    See Also:
    
    PassthroughBehavior
  - requestParameters
```
public Map<String,String> requestParameters()
```
    A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
  - requestTemplates
```
public Map<String,String> requestTemplates()
```
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
  - templateSelectionExpression
```
public String templateSelectionExpression()
```
    The template selection expression for the integration.
    
    Returns:
    
    The template selection expression for the integration.
  - timeoutInMillis
```
public Integer timeoutInMillis()
```
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    
    Returns:
    
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
  - toBuilder
```
public UpdateIntegrationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateIntegrationRequest.Builder,UpdateIntegrationRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
  - builder
```
public static UpdateIntegrationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateIntegrationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateIntegrationRequest

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

connectionId

connectionType

connectionTypeAsString

contentHandlingStrategy

contentHandlingStrategyAsString

credentialsArn

description

integrationId

integrationMethod

integrationType

integrationTypeAsString

integrationUri

passthroughBehavior

passthroughBehaviorAsString

requestParameters

requestTemplates

templateSelectionExpression

timeoutInMillis

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields