software.amazon.awssdk.services.apigateway.model.CreateDocumentationVersionRequest 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.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.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;
/**
*
* Creates a new documentation version of a given API.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateDocumentationVersionRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("restApiId").getter(getter(CreateDocumentationVersionRequest::restApiId))
.setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField DOCUMENTATION_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("documentationVersion").getter(getter(CreateDocumentationVersionRequest::documentationVersion))
.setter(setter(Builder::documentationVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("documentationVersion").build())
.build();
private static final SdkField STAGE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("stageName").getter(getter(CreateDocumentationVersionRequest::stageName))
.setter(setter(Builder::stageName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("stageName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateDocumentationVersionRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD,
DOCUMENTATION_VERSION_FIELD, STAGE_NAME_FIELD, DESCRIPTION_FIELD));
private final String restApiId;
private final String documentationVersion;
private final String stageName;
private final String description;
private CreateDocumentationVersionRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.documentationVersion = builder.documentationVersion;
this.stageName = builder.stageName;
this.description = builder.description;
}
/**
*
* The string identifier of the associated RestApi.
*
*
* @return The string identifier of the associated RestApi.
*/
public final String restApiId() {
return restApiId;
}
/**
*
* The version identifier of the new snapshot.
*
*
* @return The version identifier of the new snapshot.
*/
public final String documentationVersion() {
return documentationVersion;
}
/**
*
* The stage name to be associated with the new documentation snapshot.
*
*
* @return The stage name to be associated with the new documentation snapshot.
*/
public final String stageName() {
return stageName;
}
/**
*
* A description about the new documentation snapshot.
*
*
* @return A description about the new documentation snapshot.
*/
public final String description() {
return description;
}
@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(documentationVersion());
hashCode = 31 * hashCode + Objects.hashCode(stageName());
hashCode = 31 * hashCode + Objects.hashCode(description());
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 CreateDocumentationVersionRequest)) {
return false;
}
CreateDocumentationVersionRequest other = (CreateDocumentationVersionRequest) obj;
return Objects.equals(restApiId(), other.restApiId())
&& Objects.equals(documentationVersion(), other.documentationVersion())
&& Objects.equals(stageName(), other.stageName()) && Objects.equals(description(), other.description());
}
/**
* 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("CreateDocumentationVersionRequest").add("RestApiId", restApiId())
.add("DocumentationVersion", documentationVersion()).add("StageName", stageName())
.add("Description", description()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "documentationVersion":
return Optional.ofNullable(clazz.cast(documentationVersion()));
case "stageName":
return Optional.ofNullable(clazz.cast(stageName()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDocumentationVersionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayRequest.Builder, SdkPojo,
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 version identifier of the new snapshot.
*
*
* @param documentationVersion
* The version identifier of the new snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentationVersion(String documentationVersion);
/**
*
* The stage name to be associated with the new documentation snapshot.
*
*
* @param stageName
* The stage name to be associated with the new documentation snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stageName(String stageName);
/**
*
* A description about the new documentation snapshot.
*
*
* @param description
* A description about the new documentation snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String documentationVersion;
private String stageName;
private String description;
private BuilderImpl() {
}
private BuilderImpl(CreateDocumentationVersionRequest model) {
super(model);
restApiId(model.restApiId);
documentationVersion(model.documentationVersion);
stageName(model.stageName);
description(model.description);
}
public final String getRestApiId() {
return restApiId;
}
public final void setRestApiId(String restApiId) {
this.restApiId = restApiId;
}
@Override
public final Builder restApiId(String restApiId) {
this.restApiId = restApiId;
return this;
}
public final String getDocumentationVersion() {
return documentationVersion;
}
public final void setDocumentationVersion(String documentationVersion) {
this.documentationVersion = documentationVersion;
}
@Override
public final Builder documentationVersion(String documentationVersion) {
this.documentationVersion = documentationVersion;
return this;
}
public final String getStageName() {
return stageName;
}
public final void setStageName(String stageName) {
this.stageName = stageName;
}
@Override
public final Builder stageName(String stageName) {
this.stageName = stageName;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateDocumentationVersionRequest build() {
return new CreateDocumentationVersionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}