software.amazon.awssdk.services.apigateway.model.RequestValidator 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.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A set of validation rules for incoming Method requests.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RequestValidator implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(RequestValidator::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(RequestValidator::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField VALIDATE_REQUEST_BODY_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("validateRequestBody").getter(getter(RequestValidator::validateRequestBody))
.setter(setter(Builder::validateRequestBody))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("validateRequestBody").build())
.build();
private static final SdkField VALIDATE_REQUEST_PARAMETERS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("validateRequestParameters")
.getter(getter(RequestValidator::validateRequestParameters)).setter(setter(Builder::validateRequestParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("validateRequestParameters").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, NAME_FIELD,
VALIDATE_REQUEST_BODY_FIELD, VALIDATE_REQUEST_PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String name;
private final Boolean validateRequestBody;
private final Boolean validateRequestParameters;
private RequestValidator(BuilderImpl builder) {
this.id = builder.id;
this.name = builder.name;
this.validateRequestBody = builder.validateRequestBody;
this.validateRequestParameters = builder.validateRequestParameters;
}
/**
*
* The identifier of this RequestValidator.
*
*
* @return The identifier of this RequestValidator.
*/
public final String id() {
return id;
}
/**
*
* The name of this RequestValidator
*
*
* @return The name of this RequestValidator
*/
public final String name() {
return name;
}
/**
*
* A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
*
*
* @return A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
*/
public final Boolean validateRequestBody() {
return validateRequestBody;
}
/**
*
* A Boolean flag to indicate whether to validate request parameters (true) or not (false
* ).
*
*
* @return A Boolean flag to indicate whether to validate request parameters (true) or not (
* false).
*/
public final Boolean validateRequestParameters() {
return validateRequestParameters;
}
@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 + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(validateRequestBody());
hashCode = 31 * hashCode + Objects.hashCode(validateRequestParameters());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RequestValidator)) {
return false;
}
RequestValidator other = (RequestValidator) obj;
return Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(validateRequestBody(), other.validateRequestBody())
&& Objects.equals(validateRequestParameters(), other.validateRequestParameters());
}
/**
* 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("RequestValidator").add("Id", id()).add("Name", name())
.add("ValidateRequestBody", validateRequestBody()).add("ValidateRequestParameters", validateRequestParameters())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "validateRequestBody":
return Optional.ofNullable(clazz.cast(validateRequestBody()));
case "validateRequestParameters":
return Optional.ofNullable(clazz.cast(validateRequestParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RequestValidator) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of this RequestValidator.
*
*
* @param id
* The identifier of this RequestValidator.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The name of this RequestValidator
*
*
* @param name
* The name of this RequestValidator
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
*
*
* @param validateRequestBody
* A Boolean flag to indicate whether to validate a request body according to the configured Model
* schema.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validateRequestBody(Boolean validateRequestBody);
/**
*
* A Boolean flag to indicate whether to validate request parameters (true) or not (
* false).
*
*
* @param validateRequestParameters
* A Boolean flag to indicate whether to validate request parameters (true) or not (
* false).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validateRequestParameters(Boolean validateRequestParameters);
}
static final class BuilderImpl implements Builder {
private String id;
private String name;
private Boolean validateRequestBody;
private Boolean validateRequestParameters;
private BuilderImpl() {
}
private BuilderImpl(RequestValidator model) {
id(model.id);
name(model.name);
validateRequestBody(model.validateRequestBody);
validateRequestParameters(model.validateRequestParameters);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Boolean getValidateRequestBody() {
return validateRequestBody;
}
public final void setValidateRequestBody(Boolean validateRequestBody) {
this.validateRequestBody = validateRequestBody;
}
@Override
public final Builder validateRequestBody(Boolean validateRequestBody) {
this.validateRequestBody = validateRequestBody;
return this;
}
public final Boolean getValidateRequestParameters() {
return validateRequestParameters;
}
public final void setValidateRequestParameters(Boolean validateRequestParameters) {
this.validateRequestParameters = validateRequestParameters;
}
@Override
public final Builder validateRequestParameters(Boolean validateRequestParameters) {
this.validateRequestParameters = validateRequestParameters;
return this;
}
@Override
public RequestValidator build() {
return new RequestValidator(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}