UpdateIntegrationResponse (AWS Java SDK :: Services :: Amazon API Gateway 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponse

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

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

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateIntegrationResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateIntegrationResponse.Builder`	`builder()`
`List<String>`	`cacheKeyParameters()` A list of request parameters whose values API Gateway caches.
`String`	`cacheNamespace()` Specifies a group of related cached parameters.
`String`	`connectionId()` The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
`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`	`contentHandling()` Specifies how to handle request payload content type conversions.
`String`	`contentHandlingAsString()` Specifies how to handle request payload content type conversions.
`String`	`credentials()` Specifies the credentials required for the integration, if any.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCacheKeyParameters()` For responses, this returns true if the service returned a value for the CacheKeyParameters property.
`int`	`hashCode()`
`boolean`	`hasIntegrationResponses()` For responses, this returns true if the service returned a value for the IntegrationResponses property.
`boolean`	`hasRequestParameters()` For responses, this returns true if the service returned a value for the RequestParameters property.
`boolean`	`hasRequestTemplates()` For responses, this returns true if the service returned a value for the RequestTemplates property.
`String`	`httpMethod()` Specifies the integration's HTTP method type.
`Map<String,IntegrationResponse>`	`integrationResponses()` Specifies the integration's responses.
`String`	`passthroughBehavior()` Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.
`Map<String,String>`	`requestParameters()` A key-value map specifying request parameters that are passed from the method request to the back end.
`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 UpdateIntegrationResponse.Builder>`	`serializableBuilderClass()`
`Integer`	`timeoutInMillis()` Custom timeout between 50 and 29,000 milliseconds.
`TlsConfig`	`tlsConfig()` Specifies the TLS configuration for an integration.
`UpdateIntegrationResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`IntegrationType`	`type()` Specifies an API method integration type.
`String`	`typeAsString()` Specifies an API method integration type.
`String`	`uri()` Specifies Uniform Resource Identifier (URI) of the integration endpoint.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
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
  - type
```
public final IntegrationType type()
```
    Specifies an API method integration type. The valid value is one of the following:
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    
    If the service returns an enum value that is not available in the current SDK version, type will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies an API method integration type. The valid value is one of the following:
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    
    See Also:
    
    IntegrationType
  - typeAsString
```
public final String typeAsString()
```
    Specifies an API method integration type. The valid value is one of the following:
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    
    If the service returns an enum value that is not available in the current SDK version, type will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies an API method integration type. The valid value is one of the following:
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    
    See Also:
    
    IntegrationType
  - httpMethod
```
public final String httpMethod()
```
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this property is optional. For Lambda integrations, you must set the integration method to POST. For all other types, you must specify this property.
    
    Returns:
    
    Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this property is optional. For Lambda integrations, you must set the integration method to POST. For all other types, you must specify this property.
  - uri
```
public final String uri()
```
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    
    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    
    Returns:
    
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    
    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
  - connectionType
```
public final ConnectionType connectionType()
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is 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. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    See Also:
    
    ConnectionType
  - connectionTypeAsString
```
public final String connectionTypeAsString()
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is 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. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    See Also:
    
    ConnectionType
  - connectionId
```
public final String connectionId()
```
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    
    Returns:
    
    The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
  - credentials
```
public final String credentials()
```
    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 Amazon Web Services 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 Amazon Web Services services, specify null.
  - hasRequestParameters
```
public final boolean hasRequestParameters()
```
    For responses, this returns true if the service returned a value for the RequestParameters 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.
  - requestParameters
```
public final Map<String,String> requestParameters()
```
    A key-value map specifying request parameters that are passed from the method request to the back end. 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 back end. 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.
    
    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 hasRequestParameters() method.
    
    Returns:
    
    A key-value map specifying request parameters that are passed from the method request to the back end. 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 back end. 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.
  - hasRequestTemplates
```
public final boolean hasRequestTemplates()
```
    For responses, this returns true if the service returned a value for the RequestTemplates 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.
  - requestTemplates
```
public final 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.
    
    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 hasRequestTemplates() method.
    
    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.
  - passthroughBehavior
```
public final String passthroughBehavior()
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    
    Returns:
    
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  - contentHandling
```
public final ContentHandlingStrategy contentHandling()
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    
    If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().
    
    Returns:
    
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    
    See Also:
    
    ContentHandlingStrategy
  - contentHandlingAsString
```
public final String contentHandlingAsString()
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    
    If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().
    
    Returns:
    
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    
    See Also:
    
    ContentHandlingStrategy
  - timeoutInMillis
```
public final 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.
  - cacheNamespace
```
public final String cacheNamespace()
```
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    
    Returns:
    
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
  - hasCacheKeyParameters
```
public final boolean hasCacheKeyParameters()
```
    For responses, this returns true if the service returned a value for the CacheKeyParameters 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.
  - cacheKeyParameters
```
public final List<String> cacheKeyParameters()
```
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    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 hasCacheKeyParameters() method.
    
    Returns:
    
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
  - hasIntegrationResponses
```
public final boolean hasIntegrationResponses()
```
    For responses, this returns true if the service returned a value for the IntegrationResponses 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.
  - integrationResponses
```
public final Map<String,IntegrationResponse> integrationResponses()
```
    Specifies the integration's responses.
    
    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 hasIntegrationResponses() method.
    
    Returns:
    
    Specifies the integration's responses.
  - tlsConfig
```
public final TlsConfig tlsConfig()
```
    Specifies the TLS configuration for an integration.
    
    Returns:
    
    Specifies the TLS configuration for an integration.
  - toBuilder
```
public UpdateIntegrationResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static UpdateIntegrationResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateIntegrationResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateIntegrationResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

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

type

typeAsString

httpMethod

uri

connectionType

connectionTypeAsString

connectionId

credentials

hasRequestParameters

requestParameters

hasRequestTemplates

requestTemplates

passthroughBehavior

contentHandling

contentHandlingAsString

timeoutInMillis

cacheNamespace

hasCacheKeyParameters

cacheKeyParameters

hasIntegrationResponses

integrationResponses

tlsConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields