software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway 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 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.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 an Authorizer.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TestInvokeAuthorizerRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("restApiId").getter(getter(TestInvokeAuthorizerRequest::restApiId)).setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField AUTHORIZER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("authorizerId").getter(getter(TestInvokeAuthorizerRequest::authorizerId))
.setter(setter(Builder::authorizerId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("authorizer_id").build()).build();
private static final SdkField> HEADERS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("headers")
.getter(getter(TestInvokeAuthorizerRequest::headers))
.setter(setter(Builder::headers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("headers").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField>> MULTI_VALUE_HEADERS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("multiValueHeaders")
.getter(getter(TestInvokeAuthorizerRequest::multiValueHeaders))
.setter(setter(Builder::multiValueHeaders))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("multiValueHeaders").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final SdkField PATH_WITH_QUERY_STRING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("pathWithQueryString").getter(getter(TestInvokeAuthorizerRequest::pathWithQueryString))
.setter(setter(Builder::pathWithQueryString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pathWithQueryString").build())
.build();
private static final SdkField BODY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("body")
.getter(getter(TestInvokeAuthorizerRequest::body)).setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("body").build()).build();
private static final SdkField> STAGE_VARIABLES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("stageVariables")
.getter(getter(TestInvokeAuthorizerRequest::stageVariables))
.setter(setter(Builder::stageVariables))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("stageVariables").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> ADDITIONAL_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("additionalContext")
.getter(getter(TestInvokeAuthorizerRequest::additionalContext))
.setter(setter(Builder::additionalContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("additionalContext").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD,
AUTHORIZER_ID_FIELD, HEADERS_FIELD, MULTI_VALUE_HEADERS_FIELD, PATH_WITH_QUERY_STRING_FIELD, BODY_FIELD,
STAGE_VARIABLES_FIELD, ADDITIONAL_CONTEXT_FIELD));
private final String restApiId;
private final String authorizerId;
private final Map headers;
private final Map> multiValueHeaders;
private final String pathWithQueryString;
private final String body;
private final Map stageVariables;
private final Map additionalContext;
private TestInvokeAuthorizerRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.authorizerId = builder.authorizerId;
this.headers = builder.headers;
this.multiValueHeaders = builder.multiValueHeaders;
this.pathWithQueryString = builder.pathWithQueryString;
this.body = builder.body;
this.stageVariables = builder.stageVariables;
this.additionalContext = builder.additionalContext;
}
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @return [Required] The string identifier of the associated RestApi.
*/
public final String restApiId() {
return restApiId;
}
/**
*
* [Required] Specifies a test invoke authorizer request's Authorizer ID.
*
*
* @return [Required] Specifies a test invoke authorizer request's Authorizer ID.
*/
public final String authorizerId() {
return authorizerId;
}
/**
* Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasHeaders() {
return headers != null && !(headers instanceof SdkAutoConstructMap);
}
/**
*
* [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming
* authorization token, or identity source, should be specified.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasHeaders()} to see if a value was sent in this field.
*
*
* @return [Required] A key-value map of headers to simulate an incoming invocation request. This is where the
* incoming authorization token, or identity source, should be specified.
*/
public final Map headers() {
return headers;
}
/**
* Returns true if the MultiValueHeaders property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasMultiValueHeaders() {
return multiValueHeaders != null && !(multiValueHeaders instanceof SdkAutoConstructMap);
}
/**
*
* [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is
* where the incoming authorization token, or identity source, may be specified.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasMultiValueHeaders()} to see if a value was sent in this field.
*
*
* @return [Optional] The headers as a map from string to list of values to simulate an incoming invocation request.
* This is where the incoming authorization token, or identity source, may be specified.
*/
public final Map> multiValueHeaders() {
return multiValueHeaders;
}
/**
*
* [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path
* parameters and query string parameters.
*
*
* @return [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify
* path parameters and query string parameters.
*/
public final String pathWithQueryString() {
return pathWithQueryString;
}
/**
*
* [Optional] The simulated request body of an incoming invocation request.
*
*
* @return [Optional] The simulated request body of an incoming invocation request.
*/
public final String body() {
return body;
}
/**
* Returns true if the StageVariables property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasStageVariables() {
return stageVariables != null && !(stageVariables instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* You can use {@link #hasStageVariables()} to see if a value was sent in this field.
*
*
* @return A key-value map of stage variables to simulate an invocation on a deployed Stage.
*/
public final Map stageVariables() {
return stageVariables;
}
/**
* Returns true if the AdditionalContext property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasAdditionalContext() {
return additionalContext != null && !(additionalContext instanceof SdkAutoConstructMap);
}
/**
*
* [Optional] A key-value map of additional context variables.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAdditionalContext()} to see if a value was sent in this field.
*
*
* @return [Optional] A key-value map of additional context variables.
*/
public final Map additionalContext() {
return additionalContext;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(restApiId());
hashCode = 31 * hashCode + Objects.hashCode(authorizerId());
hashCode = 31 * hashCode + Objects.hashCode(hasHeaders() ? headers() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMultiValueHeaders() ? multiValueHeaders() : null);
hashCode = 31 * hashCode + Objects.hashCode(pathWithQueryString());
hashCode = 31 * hashCode + Objects.hashCode(body());
hashCode = 31 * hashCode + Objects.hashCode(hasStageVariables() ? stageVariables() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAdditionalContext() ? additionalContext() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TestInvokeAuthorizerRequest)) {
return false;
}
TestInvokeAuthorizerRequest other = (TestInvokeAuthorizerRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(authorizerId(), other.authorizerId())
&& hasHeaders() == other.hasHeaders() && Objects.equals(headers(), other.headers())
&& hasMultiValueHeaders() == other.hasMultiValueHeaders()
&& Objects.equals(multiValueHeaders(), other.multiValueHeaders())
&& Objects.equals(pathWithQueryString(), other.pathWithQueryString()) && Objects.equals(body(), other.body())
&& hasStageVariables() == other.hasStageVariables() && Objects.equals(stageVariables(), other.stageVariables())
&& hasAdditionalContext() == other.hasAdditionalContext()
&& Objects.equals(additionalContext(), other.additionalContext());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("TestInvokeAuthorizerRequest").add("RestApiId", restApiId()).add("AuthorizerId", authorizerId())
.add("Headers", hasHeaders() ? headers() : null)
.add("MultiValueHeaders", hasMultiValueHeaders() ? multiValueHeaders() : null)
.add("PathWithQueryString", pathWithQueryString()).add("Body", body())
.add("StageVariables", hasStageVariables() ? stageVariables() : null)
.add("AdditionalContext", hasAdditionalContext() ? additionalContext() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "authorizerId":
return Optional.ofNullable(clazz.cast(authorizerId()));
case "headers":
return Optional.ofNullable(clazz.cast(headers()));
case "multiValueHeaders":
return Optional.ofNullable(clazz.cast(multiValueHeaders()));
case "pathWithQueryString":
return Optional.ofNullable(clazz.cast(pathWithQueryString()));
case "body":
return Optional.ofNullable(clazz.cast(body()));
case "stageVariables":
return Optional.ofNullable(clazz.cast(stageVariables()));
case "additionalContext":
return Optional.ofNullable(clazz.cast(additionalContext()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TestInvokeAuthorizerRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @param restApiId
* [Required] 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);
/**
*
* [Required] Specifies a test invoke authorizer request's Authorizer ID.
*
*
* @param authorizerId
* [Required] Specifies a test invoke authorizer request's Authorizer ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authorizerId(String authorizerId);
/**
*
* [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming
* authorization token, or identity source, should be specified.
*
*
* @param headers
* [Required] A key-value map of headers to simulate an incoming invocation request. This is where the
* incoming authorization token, or identity source, should be specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headers(Map headers);
/**
*
* [Optional] The headers as a map from string to list of values to simulate an incoming invocation request.
* This is where the incoming authorization token, or identity source, may be specified.
*
*
* @param multiValueHeaders
* [Optional] The headers as a map from string to list of values to simulate an incoming invocation
* request. This is where the incoming authorization token, or identity source, may be specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder multiValueHeaders(Map> multiValueHeaders);
/**
*
* [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify
* path parameters and query string parameters.
*
*
* @param pathWithQueryString
* [Optional] 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);
/**
*
* [Optional] The simulated request body of an incoming invocation request.
*
*
* @param body
* [Optional] 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 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);
/**
*
* [Optional] A key-value map of additional context variables.
*
*
* @param additionalContext
* [Optional] A key-value map of additional context variables.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalContext(Map additionalContext);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String authorizerId;
private Map headers = DefaultSdkAutoConstructMap.getInstance();
private Map> multiValueHeaders = DefaultSdkAutoConstructMap.getInstance();
private String pathWithQueryString;
private String body;
private Map stageVariables = DefaultSdkAutoConstructMap.getInstance();
private Map additionalContext = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(TestInvokeAuthorizerRequest model) {
super(model);
restApiId(model.restApiId);
authorizerId(model.authorizerId);
headers(model.headers);
multiValueHeaders(model.multiValueHeaders);
pathWithQueryString(model.pathWithQueryString);
body(model.body);
stageVariables(model.stageVariables);
additionalContext(model.additionalContext);
}
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 getAuthorizerId() {
return authorizerId;
}
@Override
public final Builder authorizerId(String authorizerId) {
this.authorizerId = authorizerId;
return this;
}
public final void setAuthorizerId(String authorizerId) {
this.authorizerId = authorizerId;
}
public final Map getHeaders() {
if (headers instanceof SdkAutoConstructMap) {
return null;
}
return headers;
}
@Override
public final Builder headers(Map headers) {
this.headers = MapOfStringToStringCopier.copy(headers);
return this;
}
public final void setHeaders(Map headers) {
this.headers = MapOfStringToStringCopier.copy(headers);
}
public final Map> getMultiValueHeaders() {
if (multiValueHeaders instanceof SdkAutoConstructMap) {
return null;
}
return multiValueHeaders;
}
@Override
public final Builder multiValueHeaders(Map> multiValueHeaders) {
this.multiValueHeaders = MapOfStringToListCopier.copy(multiValueHeaders);
return this;
}
public final void setMultiValueHeaders(Map> multiValueHeaders) {
this.multiValueHeaders = MapOfStringToListCopier.copy(multiValueHeaders);
}
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 getStageVariables() {
if (stageVariables instanceof SdkAutoConstructMap) {
return null;
}
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);
}
public final Map getAdditionalContext() {
if (additionalContext instanceof SdkAutoConstructMap) {
return null;
}
return additionalContext;
}
@Override
public final Builder additionalContext(Map additionalContext) {
this.additionalContext = MapOfStringToStringCopier.copy(additionalContext);
return this;
}
public final void setAdditionalContext(Map additionalContext) {
this.additionalContext = MapOfStringToStringCopier.copy(additionalContext);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public TestInvokeAuthorizerRequest build() {
return new TestInvokeAuthorizerRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}