software.amazon.awssdk.services.apigateway.model.UpdateUsageRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-gateway Show documentation
Show all versions of api-gateway 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 2013-2018 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.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import javax.annotation.Generated;
import software.amazon.awssdk.core.AwsRequestOverrideConfig;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified
* API key.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class UpdateUsageRequest extends APIGatewayRequest implements
ToCopyableBuilder {
private final String usagePlanId;
private final String keyId;
private final List patchOperations;
private UpdateUsageRequest(BuilderImpl builder) {
super(builder);
this.usagePlanId = builder.usagePlanId;
this.keyId = builder.keyId;
this.patchOperations = builder.patchOperations;
}
/**
*
* The Id of the usage plan associated with the usage data.
*
*
* @return The Id of the usage plan associated with the usage data.
*/
public String usagePlanId() {
return usagePlanId;
}
/**
*
* The identifier of the API key associated with the usage plan in which a temporary extension is granted to the
* remaining quota.
*
*
* @return The identifier of the API key associated with the usage plan in which a temporary extension is granted to
* the remaining quota.
*/
public String keyId() {
return keyId;
}
/**
*
* 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.
*
*
* @return A list of update operations to be applied to the specified resource and in the order specified in this
* list.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(usagePlanId());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(patchOperations());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateUsageRequest)) {
return false;
}
UpdateUsageRequest other = (UpdateUsageRequest) obj;
return Objects.equals(usagePlanId(), other.usagePlanId()) && Objects.equals(keyId(), other.keyId())
&& Objects.equals(patchOperations(), other.patchOperations());
}
@Override
public String toString() {
return ToString.builder("UpdateUsageRequest").add("UsagePlanId", usagePlanId()).add("KeyId", keyId())
.add("PatchOperations", patchOperations()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "usagePlanId":
return Optional.of(clazz.cast(usagePlanId()));
case "keyId":
return Optional.of(clazz.cast(keyId()));
case "patchOperations":
return Optional.of(clazz.cast(patchOperations()));
default:
return Optional.empty();
}
}
public interface Builder extends APIGatewayRequest.Builder, CopyableBuilder {
/**
*
* The Id of the usage plan associated with the usage data.
*
*
* @param usagePlanId
* The Id of the usage plan associated with the usage data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder usagePlanId(String usagePlanId);
/**
*
* The identifier of the API key associated with the usage plan in which a temporary extension is granted to the
* remaining quota.
*
*
* @param keyId
* The identifier of the API key associated with the usage plan in which a temporary extension is granted
* to the remaining quota.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* 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);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends APIGatewayRequest.BuilderImpl implements Builder {
private String usagePlanId;
private String keyId;
private List patchOperations;
private BuilderImpl() {
}
private BuilderImpl(UpdateUsageRequest model) {
usagePlanId(model.usagePlanId);
keyId(model.keyId);
patchOperations(model.patchOperations);
}
public final String getUsagePlanId() {
return usagePlanId;
}
@Override
public final Builder usagePlanId(String usagePlanId) {
this.usagePlanId = usagePlanId;
return this;
}
public final void setUsagePlanId(String usagePlanId) {
this.usagePlanId = usagePlanId;
}
public final String getKeyId() {
return keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
public final Collection getPatchOperations() {
return patchOperations != null ? patchOperations.stream().map(PatchOperation::toBuilder).collect(Collectors.toList())
: null;
}
@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;
}
public final void setPatchOperations(Collection patchOperations) {
this.patchOperations = ListOfPatchOperationCopier.copyFromBuilder(patchOperations);
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public UpdateUsageRequest build() {
return new UpdateUsageRequest(this);
}
}
}