software.amazon.awssdk.services.apigateway.model.IntegrationResponse Maven / Gradle / Ivy
Show all versions of api-gateway Show documentation
/*
* Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.apigateway.model;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.protocol.ProtocolMarshaller;
import software.amazon.awssdk.core.protocol.StructuredPojo;
import software.amazon.awssdk.services.apigateway.transform.IntegrationResponseMarshaller;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents an integration response. The status code must map to an existing MethodResponse, and parameters and
* templates can be used to transform the back-end response.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public class IntegrationResponse implements StructuredPojo, ToCopyableBuilder {
private final String statusCode;
private final String selectionPattern;
private final Map responseParameters;
private final Map responseTemplates;
private final String contentHandling;
private IntegrationResponse(BuilderImpl builder) {
this.statusCode = builder.statusCode;
this.selectionPattern = builder.selectionPattern;
this.responseParameters = builder.responseParameters;
this.responseTemplates = builder.responseTemplates;
this.contentHandling = builder.contentHandling;
}
/**
*
* Specifies the status code that is used to map the integration response to an existing MethodResponse.
*
*
* @return Specifies the status code that is used to map the integration response to an existing
* MethodResponse.
*/
public String statusCode() {
return statusCode;
}
/**
*
* Specifies the regular expression (regex) pattern used to choose an integration response based on the response
* from the back end. For example, if the success response returns nothing and the error response returns some
* string, you could use the .+ regex to match error response. However, make sure that the error
* response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda
* function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status
* code is matched.
*
*
* @return Specifies the regular expression (regex) pattern used to choose an integration response based on the
* response from the back end. For example, if the success response returns nothing and the error response
* returns some string, you could use the .+ regex to match error response. However, make sure
* that the error response does not contain any newline (\n) character in such cases. If the
* back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP
* and AWS back ends, the HTTP status code is matched.
*/
public String selectionPattern() {
return selectionPattern;
}
/**
*
* 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 is a valid and unique response header name and JSON-expression is a valid
* JSON expression without the $ prefix.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return 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 is a valid and unique
* response header name and JSON-expression is a valid JSON expression without the
* $ prefix.
*/
public Map responseParameters() {
return responseParameters;
}
/**
*
* Specifies the templates used to transform the integration response body. Response templates are represented as a
* key/value map, with a content-type as the key and a template as the value.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Specifies the templates used to transform the integration response body. Response templates are
* represented as a key/value map, with a content-type as the key and a template as the value.
*/
public Map responseTemplates() {
return responseTemplates;
}
/**
*
* 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
* method response without modification.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #contentHandling}
* will return {@link ContentHandlingStrategy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #contentHandlingString}.
*
*
* @return 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 method response without modification.
* @see ContentHandlingStrategy
*/
public ContentHandlingStrategy contentHandling() {
return ContentHandlingStrategy.fromValue(contentHandling);
}
/**
*
* 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
* method response without modification.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #contentHandling}
* will return {@link ContentHandlingStrategy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #contentHandlingString}.
*
*
* @return 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 method response without modification.
* @see ContentHandlingStrategy
*/
public String contentHandlingString() {
return contentHandling;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(statusCode());
hashCode = 31 * hashCode + Objects.hashCode(selectionPattern());
hashCode = 31 * hashCode + Objects.hashCode(responseParameters());
hashCode = 31 * hashCode + Objects.hashCode(responseTemplates());
hashCode = 31 * hashCode + Objects.hashCode(contentHandlingString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof IntegrationResponse)) {
return false;
}
IntegrationResponse other = (IntegrationResponse) obj;
return Objects.equals(statusCode(), other.statusCode()) && Objects.equals(selectionPattern(), other.selectionPattern())
&& Objects.equals(responseParameters(), other.responseParameters())
&& Objects.equals(responseTemplates(), other.responseTemplates())
&& Objects.equals(contentHandlingString(), other.contentHandlingString());
}
@Override
public String toString() {
return ToString.builder("IntegrationResponse").add("StatusCode", statusCode())
.add("SelectionPattern", selectionPattern()).add("ResponseParameters", responseParameters())
.add("ResponseTemplates", responseTemplates()).add("ContentHandling", contentHandlingString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "statusCode":
return Optional.of(clazz.cast(statusCode()));
case "selectionPattern":
return Optional.of(clazz.cast(selectionPattern()));
case "responseParameters":
return Optional.of(clazz.cast(responseParameters()));
case "responseTemplates":
return Optional.of(clazz.cast(responseTemplates()));
case "contentHandling":
return Optional.of(clazz.cast(contentHandlingString()));
default:
return Optional.empty();
}
}
@SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
IntegrationResponseMarshaller.getInstance().marshall(this, protocolMarshaller);
}
public interface Builder extends CopyableBuilder {
/**
*
* Specifies the status code that is used to map the integration response to an existing MethodResponse.
*
*
* @param statusCode
* Specifies the status code that is used to map the integration response to an existing
* MethodResponse.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusCode(String statusCode);
/**
*
* Specifies the regular expression (regex) pattern used to choose an integration response based on the response
* from the back end. For example, if the success response returns nothing and the error response returns some
* string, you could use the .+ regex to match error response. However, make sure that the error
* response does not contain any newline (\n) character in such cases. If the back end is an AWS
* Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the
* HTTP status code is matched.
*
*
* @param selectionPattern
* Specifies the regular expression (regex) pattern used to choose an integration response based on the
* response from the back end. For example, if the success response returns nothing and the error
* response returns some string, you could use the .+ regex to match error response.
* However, make sure that the error response does not contain any newline (\n) character in
* such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is
* matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder selectionPattern(String selectionPattern);
/**
*
* 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 is a valid and unique response header name and JSON-expression is a
* valid JSON expression without the $ prefix.
*
*
* @param 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 is a valid and
* unique response header name and JSON-expression is a valid JSON expression without the
* $ prefix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseParameters(Map responseParameters);
/**
*
* Specifies the templates used to transform the integration response body. Response templates are represented
* as a key/value map, with a content-type as the key and a template as the value.
*
*
* @param responseTemplates
* Specifies the templates used to transform the integration response body. Response templates are
* represented as a key/value map, with a content-type as the key and a template as the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseTemplates(Map responseTemplates);
/**
*
* 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 method response without modification.
*
*
* @param contentHandling
* 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 method response without modification.
* @see ContentHandlingStrategy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContentHandlingStrategy
*/
Builder contentHandling(String contentHandling);
/**
*
* 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 method response without modification.
*
*
* @param contentHandling
* 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 method response without modification.
* @see ContentHandlingStrategy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContentHandlingStrategy
*/
Builder contentHandling(ContentHandlingStrategy contentHandling);
}
static final class BuilderImpl implements Builder {
private String statusCode;
private String selectionPattern;
private Map responseParameters;
private Map responseTemplates;
private String contentHandling;
private BuilderImpl() {
}
private BuilderImpl(IntegrationResponse model) {
statusCode(model.statusCode);
selectionPattern(model.selectionPattern);
responseParameters(model.responseParameters);
responseTemplates(model.responseTemplates);
contentHandling(model.contentHandling);
}
public final String getStatusCode() {
return statusCode;
}
@Override
public final Builder statusCode(String statusCode) {
this.statusCode = statusCode;
return this;
}
public final void setStatusCode(String statusCode) {
this.statusCode = statusCode;
}
public final String getSelectionPattern() {
return selectionPattern;
}
@Override
public final Builder selectionPattern(String selectionPattern) {
this.selectionPattern = selectionPattern;
return this;
}
public final void setSelectionPattern(String selectionPattern) {
this.selectionPattern = selectionPattern;
}
public final Map getResponseParameters() {
return responseParameters;
}
@Override
public final Builder responseParameters(Map responseParameters) {
this.responseParameters = MapOfStringToStringCopier.copy(responseParameters);
return this;
}
public final void setResponseParameters(Map responseParameters) {
this.responseParameters = MapOfStringToStringCopier.copy(responseParameters);
}
public final Map getResponseTemplates() {
return responseTemplates;
}
@Override
public final Builder responseTemplates(Map responseTemplates) {
this.responseTemplates = MapOfStringToStringCopier.copy(responseTemplates);
return this;
}
public final void setResponseTemplates(Map responseTemplates) {
this.responseTemplates = MapOfStringToStringCopier.copy(responseTemplates);
}
public final String getContentHandling() {
return contentHandling;
}
@Override
public final Builder contentHandling(String contentHandling) {
this.contentHandling = contentHandling;
return this;
}
@Override
public final Builder contentHandling(ContentHandlingStrategy contentHandling) {
this.contentHandling(contentHandling.toString());
return this;
}
public final void setContentHandling(String contentHandling) {
this.contentHandling = contentHandling;
}
@Override
public IntegrationResponse build() {
return new IntegrationResponse(this);
}
}
}