software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanRequest Maven / Gradle / Ivy
Show all versions of apigateway Show documentation
/*
* 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;
/**
*
* The PATCH request to update a usage plan of a given plan Id.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateUsagePlanRequest extends ApiGatewayRequest implements
ToCopyableBuilder {
private static final SdkField USAGE_PLAN_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("usagePlanId").getter(getter(UpdateUsagePlanRequest::usagePlanId)).setter(setter(Builder::usagePlanId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("usageplanId").build()).build();
private static final SdkField> PATCH_OPERATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("patchOperations")
.getter(getter(UpdateUsagePlanRequest::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(USAGE_PLAN_ID_FIELD,
PATCH_OPERATIONS_FIELD));
private final String usagePlanId;
private final List patchOperations;
private UpdateUsagePlanRequest(BuilderImpl builder) {
super(builder);
this.usagePlanId = builder.usagePlanId;
this.patchOperations = builder.patchOperations;
}
/**
*
* The Id of the to-be-updated usage plan.
*
*
* @return The Id of the to-be-updated usage plan.
*/
public final String usagePlanId() {
return usagePlanId;
}
/**
* For responses, this returns true if the service returned a value for the PatchOperations property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasPatchOperations() {
return patchOperations != null && !(patchOperations instanceof SdkAutoConstructList);
}
/**
*
* For more information about supported patch operations, see Patch Operations.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasPatchOperations} method.
*
*
* @return For more information about supported patch operations, see Patch Operations.
*/
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(usagePlanId());
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 UpdateUsagePlanRequest)) {
return false;
}
UpdateUsagePlanRequest other = (UpdateUsagePlanRequest) obj;
return Objects.equals(usagePlanId(), other.usagePlanId()) && 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("UpdateUsagePlanRequest").add("UsagePlanId", usagePlanId())
.add("PatchOperations", hasPatchOperations() ? patchOperations() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "usagePlanId":
return Optional.ofNullable(clazz.cast(usagePlanId()));
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((UpdateUsagePlanRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Id of the to-be-updated usage plan.
*
*
* @param usagePlanId
* The Id of the to-be-updated usage plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder usagePlanId(String usagePlanId);
/**
*
* For more information about supported patch operations, see Patch Operations.
*
*
* @param patchOperations
* For more information about supported patch operations, see Patch Operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder patchOperations(Collection patchOperations);
/**
*
* For more information about supported patch operations, see Patch Operations.
*
*
* @param patchOperations
* For more information about supported patch operations, see Patch Operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder patchOperations(PatchOperation... patchOperations);
/**
*
* For more information about supported patch operations, see Patch Operations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.apigateway.model.PatchOperation.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.apigateway.model.PatchOperation#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.apigateway.model.PatchOperation.Builder#build()} is called immediately
* and its result is passed to {@link #patchOperations(List)}.
*
* @param patchOperations
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.apigateway.model.PatchOperation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #patchOperations(java.util.Collection)
*/
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 usagePlanId;
private List patchOperations = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateUsagePlanRequest model) {
super(model);
usagePlanId(model.usagePlanId);
patchOperations(model.patchOperations);
}
public final String getUsagePlanId() {
return usagePlanId;
}
public final void setUsagePlanId(String usagePlanId) {
this.usagePlanId = usagePlanId;
}
@Override
public final Builder usagePlanId(String usagePlanId) {
this.usagePlanId = usagePlanId;
return this;
}
public final List getPatchOperations() {
List result = ListOfPatchOperationCopier.copyToBuilder(this.patchOperations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPatchOperations(Collection patchOperations) {
this.patchOperations = ListOfPatchOperationCopier.copyFromBuilder(patchOperations);
}
@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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateUsagePlanRequest build() {
return new UpdateUsagePlanRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}