software.amazon.awssdk.services.dynamodb.model.UpdateGlobalSecondaryIndexAction Maven / Gradle / Ivy
/*
* 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.dynamodb.model;
import java.io.Serializable;
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.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;
/**
*
* Represents the new provisioned throughput settings to be applied to a global secondary index.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateGlobalSecondaryIndexAction implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField INDEX_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndexName").getter(getter(UpdateGlobalSecondaryIndexAction::indexName))
.setter(setter(Builder::indexName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexName").build()).build();
private static final SdkField PROVISIONED_THROUGHPUT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ProvisionedThroughput")
.getter(getter(UpdateGlobalSecondaryIndexAction::provisionedThroughput))
.setter(setter(Builder::provisionedThroughput)).constructor(ProvisionedThroughput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProvisionedThroughput").build())
.build();
private static final SdkField ON_DEMAND_THROUGHPUT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OnDemandThroughput")
.getter(getter(UpdateGlobalSecondaryIndexAction::onDemandThroughput)).setter(setter(Builder::onDemandThroughput))
.constructor(OnDemandThroughput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnDemandThroughput").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INDEX_NAME_FIELD,
PROVISIONED_THROUGHPUT_FIELD, ON_DEMAND_THROUGHPUT_FIELD));
private static final long serialVersionUID = 1L;
private final String indexName;
private final ProvisionedThroughput provisionedThroughput;
private final OnDemandThroughput onDemandThroughput;
private UpdateGlobalSecondaryIndexAction(BuilderImpl builder) {
this.indexName = builder.indexName;
this.provisionedThroughput = builder.provisionedThroughput;
this.onDemandThroughput = builder.onDemandThroughput;
}
/**
*
* The name of the global secondary index to be updated.
*
*
* @return The name of the global secondary index to be updated.
*/
public final String indexName() {
return indexName;
}
/**
*
* Represents the provisioned throughput settings for the specified global secondary index.
*
*
* For current minimum and maximum provisioned throughput values, see Service, Account, and Table
* Quotas in the Amazon DynamoDB Developer Guide.
*
*
* @return Represents the provisioned throughput settings for the specified global secondary index.
*
* For current minimum and maximum provisioned throughput values, see Service, Account, and
* Table Quotas in the Amazon DynamoDB Developer Guide.
*/
public final ProvisionedThroughput provisionedThroughput() {
return provisionedThroughput;
}
/**
*
* Updates the maximum number of read and write units for the specified global secondary index. If you use this
* parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
*
*
* @return Updates the maximum number of read and write units for the specified global secondary index. If you use
* this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or
* both.
*/
public final OnDemandThroughput onDemandThroughput() {
return onDemandThroughput;
}
@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 + Objects.hashCode(indexName());
hashCode = 31 * hashCode + Objects.hashCode(provisionedThroughput());
hashCode = 31 * hashCode + Objects.hashCode(onDemandThroughput());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateGlobalSecondaryIndexAction)) {
return false;
}
UpdateGlobalSecondaryIndexAction other = (UpdateGlobalSecondaryIndexAction) obj;
return Objects.equals(indexName(), other.indexName())
&& Objects.equals(provisionedThroughput(), other.provisionedThroughput())
&& Objects.equals(onDemandThroughput(), other.onDemandThroughput());
}
/**
* 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("UpdateGlobalSecondaryIndexAction").add("IndexName", indexName())
.add("ProvisionedThroughput", provisionedThroughput()).add("OnDemandThroughput", onDemandThroughput()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "IndexName":
return Optional.ofNullable(clazz.cast(indexName()));
case "ProvisionedThroughput":
return Optional.ofNullable(clazz.cast(provisionedThroughput()));
case "OnDemandThroughput":
return Optional.ofNullable(clazz.cast(onDemandThroughput()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateGlobalSecondaryIndexAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the global secondary index to be updated.
*
*
* @param indexName
* The name of the global secondary index to be updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexName(String indexName);
/**
*
* Represents the provisioned throughput settings for the specified global secondary index.
*
*
* For current minimum and maximum provisioned throughput values, see Service, Account, and
* Table Quotas in the Amazon DynamoDB Developer Guide.
*
*
* @param provisionedThroughput
* Represents the provisioned throughput settings for the specified global secondary index.
*
* For current minimum and maximum provisioned throughput values, see Service, Account,
* and Table Quotas in the Amazon DynamoDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder provisionedThroughput(ProvisionedThroughput provisionedThroughput);
/**
*
* Represents the provisioned throughput settings for the specified global secondary index.
*
*
* For current minimum and maximum provisioned throughput values, see Service, Account, and
* Table Quotas in the Amazon DynamoDB Developer Guide.
*
* This is a convenience method that creates an instance of the {@link ProvisionedThroughput.Builder} avoiding
* the need to create one manually via {@link ProvisionedThroughput#builder()}.
*
*
* When the {@link Consumer} completes, {@link ProvisionedThroughput.Builder#build()} is called immediately and
* its result is passed to {@link #provisionedThroughput(ProvisionedThroughput)}.
*
* @param provisionedThroughput
* a consumer that will call methods on {@link ProvisionedThroughput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #provisionedThroughput(ProvisionedThroughput)
*/
default Builder provisionedThroughput(Consumer provisionedThroughput) {
return provisionedThroughput(ProvisionedThroughput.builder().applyMutation(provisionedThroughput).build());
}
/**
*
* Updates the maximum number of read and write units for the specified global secondary index. If you use this
* parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
*
*
* @param onDemandThroughput
* Updates the maximum number of read and write units for the specified global secondary index. If you
* use this parameter, you must specify MaxReadRequestUnits,
* MaxWriteRequestUnits, or both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onDemandThroughput(OnDemandThroughput onDemandThroughput);
/**
*
* Updates the maximum number of read and write units for the specified global secondary index. If you use this
* parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
*
* This is a convenience method that creates an instance of the {@link OnDemandThroughput.Builder} avoiding the
* need to create one manually via {@link OnDemandThroughput#builder()}.
*
*
* When the {@link Consumer} completes, {@link OnDemandThroughput.Builder#build()} is called immediately and its
* result is passed to {@link #onDemandThroughput(OnDemandThroughput)}.
*
* @param onDemandThroughput
* a consumer that will call methods on {@link OnDemandThroughput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #onDemandThroughput(OnDemandThroughput)
*/
default Builder onDemandThroughput(Consumer onDemandThroughput) {
return onDemandThroughput(OnDemandThroughput.builder().applyMutation(onDemandThroughput).build());
}
}
static final class BuilderImpl implements Builder {
private String indexName;
private ProvisionedThroughput provisionedThroughput;
private OnDemandThroughput onDemandThroughput;
private BuilderImpl() {
}
private BuilderImpl(UpdateGlobalSecondaryIndexAction model) {
indexName(model.indexName);
provisionedThroughput(model.provisionedThroughput);
onDemandThroughput(model.onDemandThroughput);
}
public final String getIndexName() {
return indexName;
}
public final void setIndexName(String indexName) {
this.indexName = indexName;
}
@Override
public final Builder indexName(String indexName) {
this.indexName = indexName;
return this;
}
public final ProvisionedThroughput.Builder getProvisionedThroughput() {
return provisionedThroughput != null ? provisionedThroughput.toBuilder() : null;
}
public final void setProvisionedThroughput(ProvisionedThroughput.BuilderImpl provisionedThroughput) {
this.provisionedThroughput = provisionedThroughput != null ? provisionedThroughput.build() : null;
}
@Override
public final Builder provisionedThroughput(ProvisionedThroughput provisionedThroughput) {
this.provisionedThroughput = provisionedThroughput;
return this;
}
public final OnDemandThroughput.Builder getOnDemandThroughput() {
return onDemandThroughput != null ? onDemandThroughput.toBuilder() : null;
}
public final void setOnDemandThroughput(OnDemandThroughput.BuilderImpl onDemandThroughput) {
this.onDemandThroughput = onDemandThroughput != null ? onDemandThroughput.build() : null;
}
@Override
public final Builder onDemandThroughput(OnDemandThroughput onDemandThroughput) {
this.onDemandThroughput = onDemandThroughput;
return this;
}
@Override
public UpdateGlobalSecondaryIndexAction build() {
return new UpdateGlobalSecondaryIndexAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}