PutIntegrationResponseRequest (AWS Java SDK :: Services

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

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

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

Represents a put integration response request.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutIntegrationResponseRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PutIntegrationResponseRequest.Builder`	`builder()`
`ContentHandlingStrategy`	`contentHandling()` Specifies how to handle response payload content type conversions.
`String`	`contentHandlingAsString()` Specifies how to handle response payload content type conversions.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasResponseParameters()` For responses, this returns true if the service returned a value for the ResponseParameters property.
`boolean`	`hasResponseTemplates()` For responses, this returns true if the service returned a value for the ResponseTemplates property.
`String`	`httpMethod()` Specifies a put integration response request's HTTP method.
`String`	`resourceId()` Specifies a put integration response request's resource identifier.
`Map<String,String>`	`responseParameters()` A key-value map specifying response parameters that are passed to the method response from the back end.
`Map<String,String>`	`responseTemplates()` Specifies a put integration response's templates.
`String`	`restApiId()` The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`String`	`selectionPattern()` Specifies the selection pattern of a put integration response.
`static Class<? extends PutIntegrationResponseRequest.Builder>`	`serializableBuilderClass()`
`String`	`statusCode()` Specifies the status code that is used to map the integration response to an existing MethodResponse.
`PutIntegrationResponseRequest.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
  - restApiId
```
public final String restApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - resourceId
```
public final String resourceId()
```
    Specifies a put integration response request's resource identifier.
    
    Returns:
    
    Specifies a put integration response request's resource identifier.
  - httpMethod
```
public final String httpMethod()
```
    Specifies a put integration response request's HTTP method.
    
    Returns:
    
    Specifies a put integration response request's HTTP method.
  - statusCode
```
public final String statusCode()
```
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
    
    Returns:
    
    Specifies the status code that is used to map the integration response to an existing MethodResponse.
  - selectionPattern
```
public final String selectionPattern()
```
    Specifies the selection pattern of a put integration response.
    
    Returns:
    
    Specifies the selection pattern of a put integration response.
  - hasResponseParameters
```
public final boolean hasResponseParameters()
```
    For responses, this returns true if the service returned a value for the ResponseParameters 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.
  - responseParameters
```
public final Map<String,String> responseParameters()
```
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
    
    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 hasResponseParameters() method.
    
    Returns:
    
    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
  - hasResponseTemplates
```
public final boolean hasResponseTemplates()
```
    For responses, this returns true if the service returned a value for the ResponseTemplates 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.
  - responseTemplates
```
public final Map<String,String> responseTemplates()
```
    Specifies a put integration response's templates.
    
    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 hasResponseTemplates() method.
    
    Returns:
    
    Specifies a put integration response's templates.
  - contentHandling
```
public final ContentHandlingStrategy contentHandling()
```
    Specifies how to handle response 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 response payload will be passed through from the integration response to the method response without modification.
    
    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 response 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 response payload will be passed through from the integration response to the method response without modification.
    
    See Also:
    
    ContentHandlingStrategy
  - contentHandlingAsString
```
public final String contentHandlingAsString()
```
    Specifies how to handle response 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 response payload will be passed through from the integration response to the method response without modification.
    
    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 response 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 response payload will be passed through from the integration response to the method response without modification.
    
    See Also:
    
    ContentHandlingStrategy
  - toBuilder
```
public PutIntegrationResponseRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static PutIntegrationResponseRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutIntegrationResponseRequest.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 PutIntegrationResponseRequest

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

statusCode

selectionPattern

hasResponseParameters

responseParameters

hasResponseTemplates

responseTemplates

contentHandling

contentHandlingAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields