PutIntegrationRequest (AWS Java SDK :: Services :: Amazon API Gateway 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.PutIntegrationRequest

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

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

Sets up a method's integration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutIntegrationRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PutIntegrationRequest.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 whether credentials are required for a put integration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCacheKeyParameters()` Returns true if the CacheKeyParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRequestParameters()` Returns true if the RequestParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasRequestTemplates()` Returns true if the RequestTemplates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`httpMethod()` [Required] Specifies a put integration request's HTTP method.
`String`	`integrationHttpMethod()` Specifies a put integration HTTP method.
`String`	`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.
`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.
`String`	`resourceId()` [Required] Specifies a put integration request's resource ID.
`String`	`restApiId()` [Required] The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutIntegrationRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`timeoutInMillis()` Custom timeout between 50 and 29,000 milliseconds.
`TlsConfig`	`tlsConfig()` Returns the value of the TlsConfig property for this object.
`PutIntegrationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`IntegrationType`	`type()` [Required] Specifies a put integration input's type.
`String`	`typeAsString()` [Required] Specifies a put integration input's type.
`String`	`uri()` Specifies Uniform Resource Identifier (URI) of the integration endpoint.

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
  - restApiId
```
public final String restApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - resourceId
```
public final String resourceId()
```
    [Required] Specifies a put integration request's resource ID.
    
    Returns:
    
    [Required] Specifies a put integration request's resource ID.
  - httpMethod
```
public final String httpMethod()
```
    [Required] Specifies a put integration request's HTTP method.
    
    Returns:
    
    [Required] Specifies a put integration request's HTTP method.
  - type
```
public final IntegrationType type()
```
    [Required] Specifies a put integration input's type.
    
    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:
    
    [Required] Specifies a put integration input's type.
    
    See Also:
    
    IntegrationType
  - typeAsString
```
public final String typeAsString()
```
    [Required] Specifies a put integration input's type.
    
    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:
    
    [Required] Specifies a put integration input's type.
    
    See Also:
    
    IntegrationType
  - integrationHttpMethod
```
public final String integrationHttpMethod()
```
    Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
    
    Returns:
    
    Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
  - 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 either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    - 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 AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS 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 AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS 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 either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    
    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 AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS 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 AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS 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 whether credentials are required for a put integration.
    
    Returns:
    
    Specifies whether credentials are required for a put integration.
  - hasRequestParameters
```
public final boolean hasRequestParameters()
```
    Returns true if the RequestParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasRequestParameters() to see if a value was sent in this field.
    
    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()
```
    Returns true if the RequestTemplates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasRequestTemplates() to see if a value was sent in this field.
    
    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 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 back end 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 415 response.
    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 back end 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 415 response.
  - 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()
```
    Returns true if the CacheKeyParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasCacheKeyParameters() to see if a value was sent in this field.
    
    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.
  - 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:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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.
  - tlsConfig
```
public final TlsConfig tlsConfig()
```
    Returns the value of the TlsConfig property for this object.
    
    Returns:
    
    The value of the TlsConfig property for this object.
  - toBuilder
```
public PutIntegrationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static PutIntegrationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutIntegrationRequest.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

Class PutIntegrationRequest

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

restApiId

resourceId

httpMethod

type

typeAsString

integrationHttpMethod

uri

connectionType

connectionTypeAsString

connectionId

credentials

hasRequestParameters

requestParameters

hasRequestTemplates

requestTemplates

passthroughBehavior

cacheNamespace

hasCacheKeyParameters

cacheKeyParameters

contentHandling

contentHandlingAsString

timeoutInMillis

tlsConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields