software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest 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.nio.ByteBuffer;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.adapter.StandardMemberCopier;
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.core.traits.PayloadTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Import documentation parts from an external (e.g., OpenAPI) definition file.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ImportDocumentationPartsRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("restApiId").getter(getter(ImportDocumentationPartsRequest::restApiId))
.setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField MODE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("mode")
.getter(getter(ImportDocumentationPartsRequest::modeAsString)).setter(setter(Builder::mode))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("mode").build()).build();
private static final SdkField FAIL_ON_WARNINGS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("failOnWarnings").getter(getter(ImportDocumentationPartsRequest::failOnWarnings))
.setter(setter(Builder::failOnWarnings))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("failonwarnings").build())
.build();
private static final SdkField BODY_FIELD = SdkField
. builder(MarshallingType.SDK_BYTES)
.memberName("body")
.getter(getter(ImportDocumentationPartsRequest::body))
.setter(setter(Builder::body))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("body").build(),
PayloadTrait.create()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD, MODE_FIELD,
FAIL_ON_WARNINGS_FIELD, BODY_FIELD));
private final String restApiId;
private final String mode;
private final Boolean failOnWarnings;
private final SdkBytes body;
private ImportDocumentationPartsRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.mode = builder.mode;
this.failOnWarnings = builder.failOnWarnings;
this.body = builder.body;
}
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @return [Required] The string identifier of the associated RestApi.
*/
public final String restApiId() {
return restApiId;
}
/**
*
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
* The default value is MERGE.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link PutMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the
* existing one. The default value is MERGE.
* @see PutMode
*/
public final PutMode mode() {
return PutMode.fromValue(mode);
}
/**
*
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
* The default value is MERGE.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link PutMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the
* existing one. The default value is MERGE.
* @see PutMode
*/
public final String modeAsString() {
return mode;
}
/**
*
* A query parameter to specify whether to rollback the documentation importation (true) or not (
* false) when a warning is encountered. The default value is false.
*
*
* @return A query parameter to specify whether to rollback the documentation importation (true) or not
* (false) when a warning is encountered. The default value is false.
*/
public final Boolean failOnWarnings() {
return failOnWarnings;
}
/**
*
* [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file,
* this is a JSON object.
*
*
* @return [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI
* file, this is a JSON object.
*/
public final SdkBytes body() {
return body;
}
@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(modeAsString());
hashCode = 31 * hashCode + Objects.hashCode(failOnWarnings());
hashCode = 31 * hashCode + Objects.hashCode(body());
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 ImportDocumentationPartsRequest)) {
return false;
}
ImportDocumentationPartsRequest other = (ImportDocumentationPartsRequest) obj;
return Objects.equals(restApiId(), other.restApiId()) && Objects.equals(modeAsString(), other.modeAsString())
&& Objects.equals(failOnWarnings(), other.failOnWarnings()) && Objects.equals(body(), other.body());
}
/**
* 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("ImportDocumentationPartsRequest").add("RestApiId", restApiId()).add("Mode", modeAsString())
.add("FailOnWarnings", failOnWarnings()).add("Body", body()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "mode":
return Optional.ofNullable(clazz.cast(modeAsString()));
case "failOnWarnings":
return Optional.ofNullable(clazz.cast(failOnWarnings()));
case "body":
return Optional.ofNullable(clazz.cast(body()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ImportDocumentationPartsRequest) 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);
/**
*
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the existing
* one. The default value is MERGE.
*
*
* @param mode
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the
* existing one. The default value is MERGE.
* @see PutMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PutMode
*/
Builder mode(String mode);
/**
*
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the existing
* one. The default value is MERGE.
*
*
* @param mode
* A query parameter to indicate whether to overwrite (OVERWRITE) any existing
* DocumentationParts definition or to merge (MERGE) the new definition into the
* existing one. The default value is MERGE.
* @see PutMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PutMode
*/
Builder mode(PutMode mode);
/**
*
* A query parameter to specify whether to rollback the documentation importation (true) or not (
* false) when a warning is encountered. The default value is false.
*
*
* @param failOnWarnings
* A query parameter to specify whether to rollback the documentation importation (true) or
* not (false) when a warning is encountered. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failOnWarnings(Boolean failOnWarnings);
/**
*
* [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI
* file, this is a JSON object.
*
*
* @param body
* [Required] Raw byte array representing the to-be-imported documentation parts. To import from an
* OpenAPI file, this is a JSON object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder body(SdkBytes body);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String mode;
private Boolean failOnWarnings;
private SdkBytes body;
private BuilderImpl() {
}
private BuilderImpl(ImportDocumentationPartsRequest model) {
super(model);
restApiId(model.restApiId);
mode(model.mode);
failOnWarnings(model.failOnWarnings);
body(model.body);
}
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 getMode() {
return mode;
}
@Override
public final Builder mode(String mode) {
this.mode = mode;
return this;
}
@Override
public final Builder mode(PutMode mode) {
this.mode(mode == null ? null : mode.toString());
return this;
}
public final void setMode(String mode) {
this.mode = mode;
}
public final Boolean getFailOnWarnings() {
return failOnWarnings;
}
@Override
public final Builder failOnWarnings(Boolean failOnWarnings) {
this.failOnWarnings = failOnWarnings;
return this;
}
public final void setFailOnWarnings(Boolean failOnWarnings) {
this.failOnWarnings = failOnWarnings;
}
public final ByteBuffer getBody() {
return body == null ? null : body.asByteBuffer();
}
@Override
public final Builder body(SdkBytes body) {
this.body = StandardMemberCopier.copy(body);
return this;
}
public final void setBody(ByteBuffer body) {
body(body == null ? null : SdkBytes.fromByteBuffer(body));
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ImportDocumentationPartsRequest build() {
return new ImportDocumentationPartsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}