software.amazon.awssdk.services.apigateway.model.PutMethodResponseRequest 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 java.util.function.Consumer;
import javax.annotation.Generated;
import software.amazon.awssdk.core.AwsRequestOverrideConfig;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Request to add a MethodResponse to an existing Method resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class PutMethodResponseRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String restApiId;
private final String resourceId;
private final String httpMethod;
private final String statusCode;
private final Map responseParameters;
private final Map responseModels;
private PutMethodResponseRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.resourceId = builder.resourceId;
this.httpMethod = builder.httpMethod;
this.statusCode = builder.statusCode;
this.responseParameters = builder.responseParameters;
this.responseModels = builder.responseModels;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
* The Resource identifier for the Method resource.
*
*
* @return The Resource identifier for the Method resource.
*/
public String resourceId() {
return resourceId;
}
/**
*
* The HTTP verb of the Method resource.
*
*
* @return The HTTP verb of the Method resource.
*/
public String httpMethod() {
return httpMethod;
}
/**
*
* The method response's status code.
*
*
* @return The method response's status code.
*/
public String statusCode() {
return statusCode;
}
/**
*
* A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the
* caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether
* the method response parameter is required or not. The method response header names must match the pattern of
* method.response.header.{name}, where name is a valid and unique header name. The
* response parameter names defined here are available in the integration response to be mapped from an integration
* response header expressed in integration.response.header.{name}, a static value enclosed within a
* pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response
* payload in the form of integration.response.body.{JSON-expression}, where
* 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 required or optional response parameters that Amazon API Gateway can send back
* to the caller. A key defines a method response header name and the associated value is a Boolean flag
* indicating whether the method response parameter is required or not. The method response header names
* must match the pattern of method.response.header.{name}, where name is a valid
* and unique header name. The response parameter names defined here are available in the integration
* response to be mapped from an integration response header expressed in
* integration.response.header.{name}, a static value enclosed within a pair of single quotes
* (e.g., 'application/json'), or a JSON expression from the back-end response payload in the
* form of integration.response.body.{JSON-expression}, where JSON-expression is a
* valid JSON expression without the $ prefix.)
*/
public Map responseParameters() {
return responseParameters;
}
/**
*
* Specifies the Model resources used for the response's content type. Response models are represented as a
* key/value map, with a content type as the key and a Model name as the value.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Specifies the Model resources used for the response's content type. Response models are
* represented as a key/value map, with a content type as the key and a Model name as the value.
*/
public Map responseModels() {
return responseModels;
}
@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(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(resourceId());
hashCode = 31 * hashCode + Objects.hashCode(httpMethod());
hashCode = 31 * hashCode + Objects.hashCode(statusCode());
hashCode = 31 * hashCode + Objects.hashCode(responseParameters());
hashCode = 31 * hashCode + Objects.hashCode(responseModels());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutMethodResponseRequest)) {
return false;
}
PutMethodResponseRequest other = (PutMethodResponseRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(resourceId(), other.resourceId())
&& Objects.equals(httpMethod(), other.httpMethod()) && Objects.equals(statusCode(), other.statusCode())
&& Objects.equals(responseParameters(), other.responseParameters())
&& Objects.equals(responseModels(), other.responseModels());
}
@Override
public String toString() {
return ToString.builder("PutMethodResponseRequest").add("RestApiId", restApiId()).add("ResourceId", resourceId())
.add("HttpMethod", httpMethod()).add("StatusCode", statusCode()).add("ResponseParameters", responseParameters())
.add("ResponseModels", responseModels()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.of(clazz.cast(restApiId()));
case "resourceId":
return Optional.of(clazz.cast(resourceId()));
case "httpMethod":
return Optional.of(clazz.cast(httpMethod()));
case "statusCode":
return Optional.of(clazz.cast(statusCode()));
case "responseParameters":
return Optional.of(clazz.cast(responseParameters()));
case "responseModels":
return Optional.of(clazz.cast(responseModels()));
default:
return Optional.empty();
}
}
public interface Builder extends APIGatewayRequest.Builder, CopyableBuilder {
/**
*
* The string identifier of the associated RestApi.
*
*
* @param restApiId
* The string identifier of the associated RestApi.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder restApiId(String restApiId);
/**
*
* The Resource identifier for the Method resource.
*
*
* @param resourceId
* The Resource identifier for the Method resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceId(String resourceId);
/**
*
* The HTTP verb of the Method resource.
*
*
* @param httpMethod
* The HTTP verb of the Method resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder httpMethod(String httpMethod);
/**
*
* The method response's status code.
*
*
* @param statusCode
* The method response's status code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusCode(String statusCode);
/**
*
* A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to
* the caller. A key defines a method response header name and the associated value is a Boolean flag indicating
* whether the method response parameter is required or not. The method response header names must match the
* pattern of method.response.header.{name}, where name is a valid and unique header
* name. The response parameter names defined here are available in the integration response to be mapped from
* an integration response header expressed in integration.response.header.{name}, a static value
* enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from
* the back-end response payload in the form of integration.response.body.{JSON-expression}, where
* JSON-expression is a valid JSON expression without the $ prefix.)
*
*
* @param responseParameters
* A key-value map specifying required or optional response parameters that Amazon API Gateway can send
* back to the caller. A key defines a method response header name and the associated value is a Boolean
* flag indicating whether the method response parameter is required or not. The method response header
* names must match the pattern of method.response.header.{name}, where name is
* a valid and unique header name. The response parameter names defined here are available in the
* integration response to be mapped from an integration response header expressed in
* integration.response.header.{name}, a static value enclosed within a pair of single
* quotes (e.g., 'application/json'), or a JSON expression from the back-end response
* payload in the form of integration.response.body.{JSON-expression}, where
* 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 Model resources used for the response's content type. Response models are represented as
* a key/value map, with a content type as the key and a Model name as the value.
*
*
* @param responseModels
* Specifies the Model resources used for the response's content type. Response models are
* represented as a key/value map, with a content type as the key and a Model name as the value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseModels(Map responseModels);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends APIGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String resourceId;
private String httpMethod;
private String statusCode;
private Map responseParameters;
private Map responseModels;
private BuilderImpl() {
}
private BuilderImpl(PutMethodResponseRequest model) {
restApiId(model.restApiId);
resourceId(model.resourceId);
httpMethod(model.httpMethod);
statusCode(model.statusCode);
responseParameters(model.responseParameters);
responseModels(model.responseModels);
}
public final String getRestApiId() {
return restApiId;
}
@Override
public final Builder restApiId(String restApiId) {
this.restApiId = restApiId;
return this;
}
public final void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
public final String getResourceId() {
return resourceId;
}
@Override
public final Builder resourceId(String resourceId) {
this.resourceId = resourceId;
return this;
}
public final void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
public final String getHttpMethod() {
return httpMethod;
}
@Override
public final Builder httpMethod(String httpMethod) {
this.httpMethod = httpMethod;
return this;
}
public final void setHttpMethod(String httpMethod) {
this.httpMethod = httpMethod;
}
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 Map getResponseParameters() {
return responseParameters;
}
@Override
public final Builder responseParameters(Map responseParameters) {
this.responseParameters = MapOfStringToBooleanCopier.copy(responseParameters);
return this;
}
public final void setResponseParameters(Map responseParameters) {
this.responseParameters = MapOfStringToBooleanCopier.copy(responseParameters);
}
public final Map getResponseModels() {
return responseModels;
}
@Override
public final Builder responseModels(Map responseModels) {
this.responseModels = MapOfStringToStringCopier.copy(responseModels);
return this;
}
public final void setResponseModels(Map responseModels) {
this.responseModels = MapOfStringToStringCopier.copy(responseModels);
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public PutMethodResponseRequest build() {
return new PutMethodResponseRequest(this);
}
}
}