software.amazon.awssdk.services.apigateway.model.UpdateDocumentationPartRequest 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.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Updates an existing documentation part of a given API.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateDocumentationPartRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField REST_API_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("restApiId").getter(getter(UpdateDocumentationPartRequest::restApiId)).setter(setter(Builder::restApiId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("restapi_id").build()).build();
private static final SdkField DOCUMENTATION_PART_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("documentationPartId").getter(getter(UpdateDocumentationPartRequest::documentationPartId))
.setter(setter(Builder::documentationPartId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("part_id").build()).build();
private static final SdkField> PATCH_OPERATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("patchOperations")
.getter(getter(UpdateDocumentationPartRequest::patchOperations))
.setter(setter(Builder::patchOperations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("patchOperations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PatchOperation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REST_API_ID_FIELD,
DOCUMENTATION_PART_ID_FIELD, PATCH_OPERATIONS_FIELD));
private final String restApiId;
private final String documentationPartId;
private final List patchOperations;
private UpdateDocumentationPartRequest(BuilderImpl builder) {
super(builder);
this.restApiId = builder.restApiId;
this.documentationPartId = builder.documentationPartId;
this.patchOperations = builder.patchOperations;
}
/**
*
* [Required] The string identifier of the associated RestApi.
*
*
* @return [Required] The string identifier of the associated RestApi.
*/
public final String restApiId() {
return restApiId;
}
/**
*
* [Required] The identifier of the to-be-updated documentation part.
*
*
* @return [Required] The identifier of the to-be-updated documentation part.
*/
public final String documentationPartId() {
return documentationPartId;
}
/**
* Returns true if the PatchOperations 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 hasPatchOperations() {
return patchOperations != null && !(patchOperations instanceof SdkAutoConstructList);
}
/**
*
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPatchOperations()} to see if a value was sent in this field.
*
*
* @return A list of update operations to be applied to the specified resource and in the order specified in this
* list.
*/
public final List patchOperations() {
return patchOperations;
}
@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(documentationPartId());
hashCode = 31 * hashCode + Objects.hashCode(hasPatchOperations() ? patchOperations() : 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 UpdateDocumentationPartRequest)) {
return false;
}
UpdateDocumentationPartRequest other = (UpdateDocumentationPartRequest) obj;
return Objects.equals(restApiId(), other.restApiId())
&& Objects.equals(documentationPartId(), other.documentationPartId())
&& hasPatchOperations() == other.hasPatchOperations()
&& Objects.equals(patchOperations(), other.patchOperations());
}
/**
* 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("UpdateDocumentationPartRequest").add("RestApiId", restApiId())
.add("DocumentationPartId", documentationPartId())
.add("PatchOperations", hasPatchOperations() ? patchOperations() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "restApiId":
return Optional.ofNullable(clazz.cast(restApiId()));
case "documentationPartId":
return Optional.ofNullable(clazz.cast(documentationPartId()));
case "patchOperations":
return Optional.ofNullable(clazz.cast(patchOperations()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateDocumentationPartRequest) 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] The identifier of the to-be-updated documentation part.
*
*
* @param documentationPartId
* [Required] The identifier of the to-be-updated documentation part.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentationPartId(String documentationPartId);
/**
*
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*
*
* @param patchOperations
* A list of update operations to be applied to the specified resource and in the order specified in this
* list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder patchOperations(Collection patchOperations);
/**
*
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*
*
* @param patchOperations
* A list of update operations to be applied to the specified resource and in the order specified in this
* list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder patchOperations(PatchOperation... patchOperations);
/**
*
* A list of update operations to be applied to the specified resource and in the order specified in this list.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #patchOperations(List)}.
*
* @param patchOperations
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #patchOperations(List)
*/
Builder patchOperations(Consumer... patchOperations);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ApiGatewayRequest.BuilderImpl implements Builder {
private String restApiId;
private String documentationPartId;
private List patchOperations = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateDocumentationPartRequest model) {
super(model);
restApiId(model.restApiId);
documentationPartId(model.documentationPartId);
patchOperations(model.patchOperations);
}
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 getDocumentationPartId() {
return documentationPartId;
}
@Override
public final Builder documentationPartId(String documentationPartId) {
this.documentationPartId = documentationPartId;
return this;
}
public final void setDocumentationPartId(String documentationPartId) {
this.documentationPartId = documentationPartId;
}
public final List getPatchOperations() {
List result = ListOfPatchOperationCopier.copyToBuilder(this.patchOperations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder patchOperations(Collection patchOperations) {
this.patchOperations = ListOfPatchOperationCopier.copy(patchOperations);
return this;
}
@Override
@SafeVarargs
public final Builder patchOperations(PatchOperation... patchOperations) {
patchOperations(Arrays.asList(patchOperations));
return this;
}
@Override
@SafeVarargs
public final Builder patchOperations(Consumer... patchOperations) {
patchOperations(Stream.of(patchOperations).map(c -> PatchOperation.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setPatchOperations(Collection patchOperations) {
this.patchOperations = ListOfPatchOperationCopier.copyFromBuilder(patchOperations);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateDocumentationPartRequest build() {
return new UpdateDocumentationPartRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}