software.amazon.awssdk.services.apigateway.model.PutGatewayResponseRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-gateway Show documentation
Show all versions of api-gateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* 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;
/**
*
* Creates a customization of a GatewayResponse of a specified response type and status code on the given
* RestApi.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class PutGatewayResponseRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String restApiId;
private final String responseType;
private final String statusCode;
private final Map responseParameters;
private final Map responseTemplates;
private PutGatewayResponseRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.responseType = builder.responseType;
this.statusCode = builder.statusCode;
this.responseParameters = builder.responseParameters;
this.responseTemplates = builder.responseTemplates;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
*
* The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #responseType} will
* return {@link GatewayResponseType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #responseTypeString}.
*
*
* @return The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
* @see GatewayResponseType
*/
public GatewayResponseType responseType() {
return GatewayResponseType.fromValue(responseType);
}
/**
*
*
* The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #responseType} will
* return {@link GatewayResponseType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #responseTypeString}.
*
*
* @return The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
* @see GatewayResponseType
*/
public String responseTypeString() {
return responseType;
}
/**
* The HTTP status code of the GatewayResponse.
*
* @return The HTTP status code of the GatewayResponse.
*/
public String statusCode() {
return statusCode;
}
/**
*
*
* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of
* key-value pairs.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Response parameters (paths, query strings and headers) of the GatewayResponse as a
* string-to-string map of key-value pairs.
*/
public Map responseParameters() {
return responseParameters;
}
/**
*
*
* Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
*/
public Map responseTemplates() {
return responseTemplates;
}
@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(responseTypeString());
hashCode = 31 * hashCode + Objects.hashCode(statusCode());
hashCode = 31 * hashCode + Objects.hashCode(responseParameters());
hashCode = 31 * hashCode + Objects.hashCode(responseTemplates());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutGatewayResponseRequest)) {
return false;
}
PutGatewayResponseRequest other = (PutGatewayResponseRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(responseTypeString(), other.responseTypeString())
&& Objects.equals(statusCode(), other.statusCode())
&& Objects.equals(responseParameters(), other.responseParameters())
&& Objects.equals(responseTemplates(), other.responseTemplates());
}
@Override
public String toString() {
return ToString.builder("PutGatewayResponseRequest").add("RestApiId", restApiId())
.add("ResponseType", responseTypeString()).add("StatusCode", statusCode())
.add("ResponseParameters", responseParameters()).add("ResponseTemplates", responseTemplates()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.of(clazz.cast(restApiId()));
case "responseType":
return Optional.of(clazz.cast(responseTypeString()));
case "statusCode":
return Optional.of(clazz.cast(statusCode()));
case "responseParameters":
return Optional.of(clazz.cast(responseParameters()));
case "responseTemplates":
return Optional.of(clazz.cast(responseTemplates()));
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 response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
*
*
*
* @param responseType
* The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
* @see GatewayResponseType
* @return Returns a reference to this object so that method calls can be chained together.
* @see GatewayResponseType
*/
Builder responseType(String responseType);
/**
*
*
* The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
*
*
*
* @param responseType
* The response type of the associated GatewayResponse. Valid values are
*
* - ACCESS_DENIED
* - API_CONFIGURATION_ERROR
* - AUTHORIZER_FAILURE
* - AUTHORIZER_CONFIGURATION_ERROR
* - BAD_REQUEST_PARAMETERS
* - BAD_REQUEST_BODY
* - DEFAULT_4XX
* - DEFAULT_5XX
* - EXPIRED_TOKEN
* - INVALID_SIGNATURE
* - INTEGRATION_FAILURE
* - INTEGRATION_TIMEOUT
* - INVALID_API_KEY
* - MISSING_AUTHENTICATION_TOKEN
* - QUOTA_EXCEEDED
* - REQUEST_TOO_LARGE
* - RESOURCE_NOT_FOUND
* - THROTTLED
* - UNAUTHORIZED
* - UNSUPPORTED_MEDIA_TYPES
*
* @see GatewayResponseType
* @return Returns a reference to this object so that method calls can be chained together.
* @see GatewayResponseType
*/
Builder responseType(GatewayResponseType responseType);
/**
* The HTTP status code of the GatewayResponse.
*
* @param statusCode
* The HTTP status code of the GatewayResponse.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusCode(String statusCode);
/**
*
*
* Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string
* map of key-value pairs.
*
*
*
* @param responseParameters
* Response parameters (paths, query strings and headers) of the GatewayResponse as a
* string-to-string map of key-value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseParameters(Map responseParameters);
/**
*
*
* Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
*
*
*
* @param responseTemplates
* Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseTemplates(Map responseTemplates);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends APIGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String responseType;
private String statusCode;
private Map responseParameters;
private Map responseTemplates;
private BuilderImpl() {
}
private BuilderImpl(PutGatewayResponseRequest model) {
restApiId(model.restApiId);
responseType(model.responseType);
statusCode(model.statusCode);
responseParameters(model.responseParameters);
responseTemplates(model.responseTemplates);
}
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 getResponseType() {
return responseType;
}
@Override
public final Builder responseType(String responseType) {
this.responseType = responseType;
return this;
}
@Override
public final Builder responseType(GatewayResponseType responseType) {
this.responseType(responseType.toString());
return this;
}
public final void setResponseType(String responseType) {
this.responseType = responseType;
}
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 = 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);
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public PutGatewayResponseRequest build() {
return new PutGatewayResponseRequest(this);
}
}
}