software.amazon.awssdk.services.timestreamwrite.model.Schema Maven / Gradle / Ivy
Show all versions of timestreamwrite 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.timestreamwrite.model;
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;
/**
*
* A Schema specifies the expected data model of the table.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Schema implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> COMPOSITE_PARTITION_KEY_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CompositePartitionKey")
.getter(getter(Schema::compositePartitionKey))
.setter(setter(Builder::compositePartitionKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CompositePartitionKey").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PartitionKey::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(COMPOSITE_PARTITION_KEY_FIELD));
private static final long serialVersionUID = 1L;
private final List compositePartitionKey;
private Schema(BuilderImpl builder) {
this.compositePartitionKey = builder.compositePartitionKey;
}
/**
* For responses, this returns true if the service returned a value for the CompositePartitionKey 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 hasCompositePartitionKey() {
return compositePartitionKey != null && !(compositePartitionKey instanceof SdkAutoConstructList);
}
/**
*
* A non-empty list of partition keys defining the attributes used to partition the table data. The order of the
* list determines the partition hierarchy. The name and type of each partition key as well as the partition key
* order cannot be changed after the table is created. However, the enforcement level of each partition key can be
* changed.
*
*
* 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 #hasCompositePartitionKey} method.
*
*
* @return A non-empty list of partition keys defining the attributes used to partition the table data. The order of
* the list determines the partition hierarchy. The name and type of each partition key as well as the
* partition key order cannot be changed after the table is created. However, the enforcement level of each
* partition key can be changed.
*/
public final List compositePartitionKey() {
return compositePartitionKey;
}
@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(hasCompositePartitionKey() ? compositePartitionKey() : null);
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 Schema)) {
return false;
}
Schema other = (Schema) obj;
return hasCompositePartitionKey() == other.hasCompositePartitionKey()
&& Objects.equals(compositePartitionKey(), other.compositePartitionKey());
}
/**
* 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("Schema")
.add("CompositePartitionKey", hasCompositePartitionKey() ? compositePartitionKey() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CompositePartitionKey":
return Optional.ofNullable(clazz.cast(compositePartitionKey()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Schema) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A non-empty list of partition keys defining the attributes used to partition the table data. The order of the
* list determines the partition hierarchy. The name and type of each partition key as well as the partition key
* order cannot be changed after the table is created. However, the enforcement level of each partition key can
* be changed.
*
*
* @param compositePartitionKey
* A non-empty list of partition keys defining the attributes used to partition the table data. The order
* of the list determines the partition hierarchy. The name and type of each partition key as well as the
* partition key order cannot be changed after the table is created. However, the enforcement level of
* each partition key can be changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder compositePartitionKey(Collection compositePartitionKey);
/**
*
* A non-empty list of partition keys defining the attributes used to partition the table data. The order of the
* list determines the partition hierarchy. The name and type of each partition key as well as the partition key
* order cannot be changed after the table is created. However, the enforcement level of each partition key can
* be changed.
*
*
* @param compositePartitionKey
* A non-empty list of partition keys defining the attributes used to partition the table data. The order
* of the list determines the partition hierarchy. The name and type of each partition key as well as the
* partition key order cannot be changed after the table is created. However, the enforcement level of
* each partition key can be changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder compositePartitionKey(PartitionKey... compositePartitionKey);
/**
*
* A non-empty list of partition keys defining the attributes used to partition the table data. The order of the
* list determines the partition hierarchy. The name and type of each partition key as well as the partition key
* order cannot be changed after the table is created. However, the enforcement level of each partition key can
* be changed.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.timestreamwrite.model.PartitionKey.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.timestreamwrite.model.PartitionKey#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.timestreamwrite.model.PartitionKey.Builder#build()} is called
* immediately and its result is passed to {@link #compositePartitionKey(List)}.
*
* @param compositePartitionKey
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.timestreamwrite.model.PartitionKey.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #compositePartitionKey(java.util.Collection)
*/
Builder compositePartitionKey(Consumer... compositePartitionKey);
}
static final class BuilderImpl implements Builder {
private List compositePartitionKey = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Schema model) {
compositePartitionKey(model.compositePartitionKey);
}
public final List getCompositePartitionKey() {
List result = PartitionKeyListCopier.copyToBuilder(this.compositePartitionKey);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCompositePartitionKey(Collection compositePartitionKey) {
this.compositePartitionKey = PartitionKeyListCopier.copyFromBuilder(compositePartitionKey);
}
@Override
public final Builder compositePartitionKey(Collection compositePartitionKey) {
this.compositePartitionKey = PartitionKeyListCopier.copy(compositePartitionKey);
return this;
}
@Override
@SafeVarargs
public final Builder compositePartitionKey(PartitionKey... compositePartitionKey) {
compositePartitionKey(Arrays.asList(compositePartitionKey));
return this;
}
@Override
@SafeVarargs
public final Builder compositePartitionKey(Consumer... compositePartitionKey) {
compositePartitionKey(Stream.of(compositePartitionKey).map(c -> PartitionKey.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Schema build() {
return new Schema(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}