software.amazon.awssdk.services.apigateway.model.TestInvokeMethodRequest 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;
/**
*
* Make a request to simulate the execution of a Method.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class TestInvokeMethodRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String restApiId;
private final String resourceId;
private final String httpMethod;
private final String pathWithQueryString;
private final String body;
private final Map headers;
private final String clientCertificateId;
private final Map stageVariables;
private TestInvokeMethodRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.resourceId = builder.resourceId;
this.httpMethod = builder.httpMethod;
this.pathWithQueryString = builder.pathWithQueryString;
this.body = builder.body;
this.headers = builder.headers;
this.clientCertificateId = builder.clientCertificateId;
this.stageVariables = builder.stageVariables;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public String restApiId() {
return restApiId;
}
/**
*
* Specifies a test invoke method request's resource ID.
*
*
* @return Specifies a test invoke method request's resource ID.
*/
public String resourceId() {
return resourceId;
}
/**
*
* Specifies a test invoke method request's HTTP method.
*
*
* @return Specifies a test invoke method request's HTTP method.
*/
public String httpMethod() {
return httpMethod;
}
/**
*
* The URI path, including query string, of the simulated invocation request. Use this to specify path parameters
* and query string parameters.
*
*
* @return The URI path, including query string, of the simulated invocation request. Use this to specify path
* parameters and query string parameters.
*/
public String pathWithQueryString() {
return pathWithQueryString;
}
/**
*
* The simulated request body of an incoming invocation request.
*
*
* @return The simulated request body of an incoming invocation request.
*/
public String body() {
return body;
}
/**
*
* A key-value map of headers to simulate an incoming invocation request.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A key-value map of headers to simulate an incoming invocation request.
*/
public Map headers() {
return headers;
}
/**
*
* A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when
* making the HTTPS request to the defined back-end endpoint.
*
*
* @return A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate
* when making the HTTPS request to the defined back-end endpoint.
*/
public String clientCertificateId() {
return clientCertificateId;
}
/**
*
* A key-value map of stage variables to simulate an invocation on a deployed Stage.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/
public Map stageVariables() {
return stageVariables;
}
@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(pathWithQueryString());
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(headers());
hashCode = 31 * hashCode + Objects.hashCode(clientCertificateId());
hashCode = 31 * hashCode + Objects.hashCode(stageVariables());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TestInvokeMethodRequest)) {
return false;
}
TestInvokeMethodRequest other = (TestInvokeMethodRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(resourceId(), other.resourceId())
&& Objects.equals(httpMethod(), other.httpMethod())
&& Objects.equals(pathWithQueryString(), other.pathWithQueryString()) && Objects.equals(body(), other.body())
&& Objects.equals(headers(), other.headers())
&& Objects.equals(clientCertificateId(), other.clientCertificateId())
&& Objects.equals(stageVariables(), other.stageVariables());
}
@Override
public String toString() {
return ToString.builder("TestInvokeMethodRequest").add("RestApiId", restApiId()).add("ResourceId", resourceId())
.add("HttpMethod", httpMethod()).add("PathWithQueryString", pathWithQueryString()).add("Body", body())
.add("Headers", headers()).add("ClientCertificateId", clientCertificateId())
.add("StageVariables", stageVariables()).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 "pathWithQueryString":
return Optional.of(clazz.cast(pathWithQueryString()));
case "body":
return Optional.of(clazz.cast(body()));
case "headers":
return Optional.of(clazz.cast(headers()));
case "clientCertificateId":
return Optional.of(clazz.cast(clientCertificateId()));
case "stageVariables":
return Optional.of(clazz.cast(stageVariables()));
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);
/**
*
* Specifies a test invoke method request's resource ID.
*
*
* @param resourceId
* Specifies a test invoke method request's resource ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceId(String resourceId);
/**
*
* Specifies a test invoke method request's HTTP method.
*
*
* @param httpMethod
* Specifies a test invoke method request's HTTP method.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder httpMethod(String httpMethod);
/**
*
* The URI path, including query string, of the simulated invocation request. Use this to specify path
* parameters and query string parameters.
*
*
* @param pathWithQueryString
* The URI path, including query string, of the simulated invocation request. Use this to specify path
* parameters and query string parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pathWithQueryString(String pathWithQueryString);
/**
*
* The simulated request body of an incoming invocation request.
*
*
* @param body
* The simulated request body of an incoming invocation request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder body(String body);
/**
*
* A key-value map of headers to simulate an incoming invocation request.
*
*
* @param headers
* A key-value map of headers to simulate an incoming invocation request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headers(Map headers);
/**
*
* A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate
* when making the HTTPS request to the defined back-end endpoint.
*
*
* @param clientCertificateId
* A ClientCertificate identifier to use in the test invocation. API Gateway will use the
* certificate when making the HTTPS request to the defined back-end endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientCertificateId(String clientCertificateId);
/**
*
* A key-value map of stage variables to simulate an invocation on a deployed Stage.
*
*
* @param stageVariables
* A key-value map of stage variables to simulate an invocation on a deployed Stage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stageVariables(Map stageVariables);
@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 pathWithQueryString;
private String body;
private Map headers;
private String clientCertificateId;
private Map stageVariables;
private BuilderImpl() {
}
private BuilderImpl(TestInvokeMethodRequest model) {
restApiId(model.restApiId);
resourceId(model.resourceId);
httpMethod(model.httpMethod);
pathWithQueryString(model.pathWithQueryString);
body(model.body);
headers(model.headers);
clientCertificateId(model.clientCertificateId);
stageVariables(model.stageVariables);
}
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 getPathWithQueryString() {
return pathWithQueryString;
}
@Override
public final Builder pathWithQueryString(String pathWithQueryString) {
this.pathWithQueryString = pathWithQueryString;
return this;
}
public final void setPathWithQueryString(String pathWithQueryString) {
this.pathWithQueryString = pathWithQueryString;
}
public final String getBody() {
return body;
}
@Override
public final Builder body(String body) {
this.body = body;
return this;
}
public final void setBody(String body) {
this.body = body;
}
public final Map getHeaders() {
return headers;
}
@Override
public final Builder headers(Map headers) {
this.headers = MapOfHeaderValuesCopier.copy(headers);
return this;
}
public final void setHeaders(Map headers) {
this.headers = MapOfHeaderValuesCopier.copy(headers);
}
public final String getClientCertificateId() {
return clientCertificateId;
}
@Override
public final Builder clientCertificateId(String clientCertificateId) {
this.clientCertificateId = clientCertificateId;
return this;
}
public final void setClientCertificateId(String clientCertificateId) {
this.clientCertificateId = clientCertificateId;
}
public final Map getStageVariables() {
return stageVariables;
}
@Override
public final Builder stageVariables(Map stageVariables) {
this.stageVariables = MapOfStringToStringCopier.copy(stageVariables);
return this;
}
public final void setStageVariables(Map stageVariables) {
this.stageVariables = MapOfStringToStringCopier.copy(stageVariables);
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public TestInvokeMethodRequest build() {
return new TestInvokeMethodRequest(this);
}
}
}