Class PutIntegrationResponseRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutIntegrationResponseRequest.Builder,
PutIntegrationResponseRequest>
Represents a put integration response request.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ContentHandlingStrategy
Specifies how to handle response payload content type conversions.final String
Specifies how to handle response payload content type conversions.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResponseParameters property.final boolean
For responses, this returns true if the service returned a value for the ResponseTemplates property.final String
Specifies a put integration response request's HTTP method.final String
Specifies a put integration response request's resource identifier.A key-value map specifying response parameters that are passed to the method response from the back end.Specifies a put integration response's templates.final String
The string identifier of the associated RestApi.final String
Specifies the selection pattern of a put integration response.static Class
<? extends PutIntegrationResponseRequest.Builder> final String
Specifies the status code that is used to map the integration response to an existing MethodResponse.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Returns:
- The string identifier of the associated RestApi.
-
resourceId
Specifies a put integration response request's resource identifier.
- Returns:
- Specifies a put integration response request's resource identifier.
-
httpMethod
Specifies a put integration response request's HTTP method.
- Returns:
- Specifies a put integration response request's HTTP method.
-
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
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 theisEmpty()
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
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-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 theisEmpty()
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
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
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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 returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentHandlingAsString()
.- Returns:
- Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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:
-
contentHandlingAsString
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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 returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentHandlingAsString()
.- Returns:
- Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutIntegrationResponseRequest.Builder,
PutIntegrationResponseRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-