
software.amazon.awssdk.services.dynamodb.model.ReplicaSettingsDescription 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.beans.Transient;
import java.io.Serializable;
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.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;
/**
*
* Represents the properties of a replica.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ReplicaSettingsDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField REGION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RegionName").getter(getter(ReplicaSettingsDescription::regionName)).setter(setter(Builder::regionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RegionName").build()).build();
private static final SdkField REPLICA_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReplicaStatus").getter(getter(ReplicaSettingsDescription::replicaStatusAsString))
.setter(setter(Builder::replicaStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaStatus").build()).build();
private static final SdkField REPLICA_BILLING_MODE_SUMMARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReplicaBillingModeSummary")
.getter(getter(ReplicaSettingsDescription::replicaBillingModeSummary))
.setter(setter(Builder::replicaBillingModeSummary)).constructor(BillingModeSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaBillingModeSummary").build())
.build();
private static final SdkField REPLICA_PROVISIONED_READ_CAPACITY_UNITS_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("ReplicaProvisionedReadCapacityUnits")
.getter(getter(ReplicaSettingsDescription::replicaProvisionedReadCapacityUnits))
.setter(setter(Builder::replicaProvisionedReadCapacityUnits))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReplicaProvisionedReadCapacityUnits").build()).build();
private static final SdkField REPLICA_PROVISIONED_READ_CAPACITY_AUTO_SCALING_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ReplicaProvisionedReadCapacityAutoScalingSettings")
.getter(getter(ReplicaSettingsDescription::replicaProvisionedReadCapacityAutoScalingSettings))
.setter(setter(Builder::replicaProvisionedReadCapacityAutoScalingSettings))
.constructor(AutoScalingSettingsDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReplicaProvisionedReadCapacityAutoScalingSettings").build()).build();
private static final SdkField REPLICA_PROVISIONED_WRITE_CAPACITY_UNITS_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("ReplicaProvisionedWriteCapacityUnits")
.getter(getter(ReplicaSettingsDescription::replicaProvisionedWriteCapacityUnits))
.setter(setter(Builder::replicaProvisionedWriteCapacityUnits))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReplicaProvisionedWriteCapacityUnits").build()).build();
private static final SdkField REPLICA_PROVISIONED_WRITE_CAPACITY_AUTO_SCALING_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ReplicaProvisionedWriteCapacityAutoScalingSettings")
.getter(getter(ReplicaSettingsDescription::replicaProvisionedWriteCapacityAutoScalingSettings))
.setter(setter(Builder::replicaProvisionedWriteCapacityAutoScalingSettings))
.constructor(AutoScalingSettingsDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReplicaProvisionedWriteCapacityAutoScalingSettings").build()).build();
private static final SdkField> REPLICA_GLOBAL_SECONDARY_INDEX_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ReplicaGlobalSecondaryIndexSettings")
.getter(getter(ReplicaSettingsDescription::replicaGlobalSecondaryIndexSettings))
.setter(setter(Builder::replicaGlobalSecondaryIndexSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ReplicaGlobalSecondaryIndexSettings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReplicaGlobalSecondaryIndexSettingsDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField REPLICA_TABLE_CLASS_SUMMARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReplicaTableClassSummary")
.getter(getter(ReplicaSettingsDescription::replicaTableClassSummary))
.setter(setter(Builder::replicaTableClassSummary)).constructor(TableClassSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaTableClassSummary").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REGION_NAME_FIELD,
REPLICA_STATUS_FIELD, REPLICA_BILLING_MODE_SUMMARY_FIELD, REPLICA_PROVISIONED_READ_CAPACITY_UNITS_FIELD,
REPLICA_PROVISIONED_READ_CAPACITY_AUTO_SCALING_SETTINGS_FIELD, REPLICA_PROVISIONED_WRITE_CAPACITY_UNITS_FIELD,
REPLICA_PROVISIONED_WRITE_CAPACITY_AUTO_SCALING_SETTINGS_FIELD, REPLICA_GLOBAL_SECONDARY_INDEX_SETTINGS_FIELD,
REPLICA_TABLE_CLASS_SUMMARY_FIELD));
private static final long serialVersionUID = 1L;
private final String regionName;
private final String replicaStatus;
private final BillingModeSummary replicaBillingModeSummary;
private final Long replicaProvisionedReadCapacityUnits;
private final AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings;
private final Long replicaProvisionedWriteCapacityUnits;
private final AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings;
private final List replicaGlobalSecondaryIndexSettings;
private final TableClassSummary replicaTableClassSummary;
private ReplicaSettingsDescription(BuilderImpl builder) {
this.regionName = builder.regionName;
this.replicaStatus = builder.replicaStatus;
this.replicaBillingModeSummary = builder.replicaBillingModeSummary;
this.replicaProvisionedReadCapacityUnits = builder.replicaProvisionedReadCapacityUnits;
this.replicaProvisionedReadCapacityAutoScalingSettings = builder.replicaProvisionedReadCapacityAutoScalingSettings;
this.replicaProvisionedWriteCapacityUnits = builder.replicaProvisionedWriteCapacityUnits;
this.replicaProvisionedWriteCapacityAutoScalingSettings = builder.replicaProvisionedWriteCapacityAutoScalingSettings;
this.replicaGlobalSecondaryIndexSettings = builder.replicaGlobalSecondaryIndexSettings;
this.replicaTableClassSummary = builder.replicaTableClassSummary;
}
/**
*
* The Region name of the replica.
*
*
* @return The Region name of the replica.
*/
public final String regionName() {
return regionName;
}
/**
*
* The current state of the Region:
*
*
* -
*
* CREATING
- The Region is being created.
*
*
* -
*
* UPDATING
- The Region is being updated.
*
*
* -
*
* DELETING
- The Region is being deleted.
*
*
* -
*
* ACTIVE
- The Region is ready for use.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #replicaStatus}
* will return {@link ReplicaStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #replicaStatusAsString}.
*
*
* @return The current state of the Region:
*
* -
*
* CREATING
- The Region is being created.
*
*
* -
*
* UPDATING
- The Region is being updated.
*
*
* -
*
* DELETING
- The Region is being deleted.
*
*
* -
*
* ACTIVE
- The Region is ready for use.
*
*
* @see ReplicaStatus
*/
public final ReplicaStatus replicaStatus() {
return ReplicaStatus.fromValue(replicaStatus);
}
/**
*
* The current state of the Region:
*
*
* -
*
* CREATING
- The Region is being created.
*
*
* -
*
* UPDATING
- The Region is being updated.
*
*
* -
*
* DELETING
- The Region is being deleted.
*
*
* -
*
* ACTIVE
- The Region is ready for use.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #replicaStatus}
* will return {@link ReplicaStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #replicaStatusAsString}.
*
*
* @return The current state of the Region:
*
* -
*
* CREATING
- The Region is being created.
*
*
* -
*
* UPDATING
- The Region is being updated.
*
*
* -
*
* DELETING
- The Region is being deleted.
*
*
* -
*
* ACTIVE
- The Region is ready for use.
*
*
* @see ReplicaStatus
*/
public final String replicaStatusAsString() {
return replicaStatus;
}
/**
*
* The read/write capacity mode of the replica.
*
*
* @return The read/write capacity mode of the replica.
*/
public final BillingModeSummary replicaBillingModeSummary() {
return replicaBillingModeSummary;
}
/**
*
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* @return The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*/
public final Long replicaProvisionedReadCapacityUnits() {
return replicaProvisionedReadCapacityUnits;
}
/**
*
* Auto scaling settings for a global table replica's read capacity units.
*
*
* @return Auto scaling settings for a global table replica's read capacity units.
*/
public final AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings() {
return replicaProvisionedReadCapacityAutoScalingSettings;
}
/**
*
* The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException
. For
* more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* @return The maximum number of writes consumed per second before DynamoDB returns a
* ThrottlingException
. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*/
public final Long replicaProvisionedWriteCapacityUnits() {
return replicaProvisionedWriteCapacityUnits;
}
/**
*
* Auto scaling settings for a global table replica's write capacity units.
*
*
* @return Auto scaling settings for a global table replica's write capacity units.
*/
public final AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings() {
return replicaProvisionedWriteCapacityAutoScalingSettings;
}
/**
* For responses, this returns true if the service returned a value for the ReplicaGlobalSecondaryIndexSettings
* 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 hasReplicaGlobalSecondaryIndexSettings() {
return replicaGlobalSecondaryIndexSettings != null
&& !(replicaGlobalSecondaryIndexSettings instanceof SdkAutoConstructList);
}
/**
*
* Replica global secondary index settings for the global table.
*
*
* 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 #hasReplicaGlobalSecondaryIndexSettings}
* method.
*
*
* @return Replica global secondary index settings for the global table.
*/
public final List replicaGlobalSecondaryIndexSettings() {
return replicaGlobalSecondaryIndexSettings;
}
/**
* Returns the value of the ReplicaTableClassSummary property for this object.
*
* @return The value of the ReplicaTableClassSummary property for this object.
*/
public final TableClassSummary replicaTableClassSummary() {
return replicaTableClassSummary;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(regionName());
hashCode = 31 * hashCode + Objects.hashCode(replicaStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(replicaBillingModeSummary());
hashCode = 31 * hashCode + Objects.hashCode(replicaProvisionedReadCapacityUnits());
hashCode = 31 * hashCode + Objects.hashCode(replicaProvisionedReadCapacityAutoScalingSettings());
hashCode = 31 * hashCode + Objects.hashCode(replicaProvisionedWriteCapacityUnits());
hashCode = 31 * hashCode + Objects.hashCode(replicaProvisionedWriteCapacityAutoScalingSettings());
hashCode = 31 * hashCode
+ Objects.hashCode(hasReplicaGlobalSecondaryIndexSettings() ? replicaGlobalSecondaryIndexSettings() : null);
hashCode = 31 * hashCode + Objects.hashCode(replicaTableClassSummary());
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 ReplicaSettingsDescription)) {
return false;
}
ReplicaSettingsDescription other = (ReplicaSettingsDescription) obj;
return Objects.equals(regionName(), other.regionName())
&& Objects.equals(replicaStatusAsString(), other.replicaStatusAsString())
&& Objects.equals(replicaBillingModeSummary(), other.replicaBillingModeSummary())
&& Objects.equals(replicaProvisionedReadCapacityUnits(), other.replicaProvisionedReadCapacityUnits())
&& Objects.equals(replicaProvisionedReadCapacityAutoScalingSettings(),
other.replicaProvisionedReadCapacityAutoScalingSettings())
&& Objects.equals(replicaProvisionedWriteCapacityUnits(), other.replicaProvisionedWriteCapacityUnits())
&& Objects.equals(replicaProvisionedWriteCapacityAutoScalingSettings(),
other.replicaProvisionedWriteCapacityAutoScalingSettings())
&& hasReplicaGlobalSecondaryIndexSettings() == other.hasReplicaGlobalSecondaryIndexSettings()
&& Objects.equals(replicaGlobalSecondaryIndexSettings(), other.replicaGlobalSecondaryIndexSettings())
&& Objects.equals(replicaTableClassSummary(), other.replicaTableClassSummary());
}
/**
* 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("ReplicaSettingsDescription")
.add("RegionName", regionName())
.add("ReplicaStatus", replicaStatusAsString())
.add("ReplicaBillingModeSummary", replicaBillingModeSummary())
.add("ReplicaProvisionedReadCapacityUnits", replicaProvisionedReadCapacityUnits())
.add("ReplicaProvisionedReadCapacityAutoScalingSettings", replicaProvisionedReadCapacityAutoScalingSettings())
.add("ReplicaProvisionedWriteCapacityUnits", replicaProvisionedWriteCapacityUnits())
.add("ReplicaProvisionedWriteCapacityAutoScalingSettings", replicaProvisionedWriteCapacityAutoScalingSettings())
.add("ReplicaGlobalSecondaryIndexSettings",
hasReplicaGlobalSecondaryIndexSettings() ? replicaGlobalSecondaryIndexSettings() : null)
.add("ReplicaTableClassSummary", replicaTableClassSummary()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RegionName":
return Optional.ofNullable(clazz.cast(regionName()));
case "ReplicaStatus":
return Optional.ofNullable(clazz.cast(replicaStatusAsString()));
case "ReplicaBillingModeSummary":
return Optional.ofNullable(clazz.cast(replicaBillingModeSummary()));
case "ReplicaProvisionedReadCapacityUnits":
return Optional.ofNullable(clazz.cast(replicaProvisionedReadCapacityUnits()));
case "ReplicaProvisionedReadCapacityAutoScalingSettings":
return Optional.ofNullable(clazz.cast(replicaProvisionedReadCapacityAutoScalingSettings()));
case "ReplicaProvisionedWriteCapacityUnits":
return Optional.ofNullable(clazz.cast(replicaProvisionedWriteCapacityUnits()));
case "ReplicaProvisionedWriteCapacityAutoScalingSettings":
return Optional.ofNullable(clazz.cast(replicaProvisionedWriteCapacityAutoScalingSettings()));
case "ReplicaGlobalSecondaryIndexSettings":
return Optional.ofNullable(clazz.cast(replicaGlobalSecondaryIndexSettings()));
case "ReplicaTableClassSummary":
return Optional.ofNullable(clazz.cast(replicaTableClassSummary()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function