software.amazon.awssdk.services.dynamodb.model.AttributeDefinition Maven / Gradle / Ivy
/*
* 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.dynamodb.model;
import java.util.Objects;
import java.util.Optional;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.protocol.ProtocolMarshaller;
import software.amazon.awssdk.core.protocol.StructuredPojo;
import software.amazon.awssdk.services.dynamodb.transform.AttributeDefinitionMarshaller;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents an attribute for describing the key schema for the table and indexes.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AttributeDefinition implements StructuredPojo,
ToCopyableBuilder {
private final String attributeName;
private final String attributeType;
private AttributeDefinition(BuilderImpl builder) {
this.attributeName = builder.attributeName;
this.attributeType = builder.attributeType;
}
/**
*
* A name for the attribute.
*
*
* @return A name for the attribute.
*/
public String attributeName() {
return attributeName;
}
/**
*
* The data type for the attribute, where:
*
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attributeType}
* will return {@link ScalarAttributeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #attributeTypeAsString}.
*
*
* @return The data type for the attribute, where:
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
* @see ScalarAttributeType
*/
public ScalarAttributeType attributeType() {
return ScalarAttributeType.fromValue(attributeType);
}
/**
*
* The data type for the attribute, where:
*
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attributeType}
* will return {@link ScalarAttributeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #attributeTypeAsString}.
*
*
* @return The data type for the attribute, where:
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
* @see ScalarAttributeType
*/
public String attributeTypeAsString() {
return attributeType;
}
@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(attributeName());
hashCode = 31 * hashCode + Objects.hashCode(attributeTypeAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AttributeDefinition)) {
return false;
}
AttributeDefinition other = (AttributeDefinition) obj;
return Objects.equals(attributeName(), other.attributeName())
&& Objects.equals(attributeTypeAsString(), other.attributeTypeAsString());
}
@Override
public String toString() {
return ToString.builder("AttributeDefinition").add("AttributeName", attributeName())
.add("AttributeType", attributeTypeAsString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AttributeName":
return Optional.ofNullable(clazz.cast(attributeName()));
case "AttributeType":
return Optional.ofNullable(clazz.cast(attributeTypeAsString()));
default:
return Optional.empty();
}
}
@SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
AttributeDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
public interface Builder extends CopyableBuilder {
/**
*
* A name for the attribute.
*
*
* @param attributeName
* A name for the attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeName(String attributeName);
/**
*
* The data type for the attribute, where:
*
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
*
*
* @param attributeType
* The data type for the attribute, where:
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
* @see ScalarAttributeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalarAttributeType
*/
Builder attributeType(String attributeType);
/**
*
* The data type for the attribute, where:
*
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
*
*
* @param attributeType
* The data type for the attribute, where:
*
* -
*
* S - the attribute is of type String
*
*
* -
*
* N - the attribute is of type Number
*
*
* -
*
* B - the attribute is of type Binary
*
*
* @see ScalarAttributeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalarAttributeType
*/
Builder attributeType(ScalarAttributeType attributeType);
}
static final class BuilderImpl implements Builder {
private String attributeName;
private String attributeType;
private BuilderImpl() {
}
private BuilderImpl(AttributeDefinition model) {
attributeName(model.attributeName);
attributeType(model.attributeType);
}
public final String getAttributeName() {
return attributeName;
}
@Override
public final Builder attributeName(String attributeName) {
this.attributeName = attributeName;
return this;
}
public final void setAttributeName(String attributeName) {
this.attributeName = attributeName;
}
public final String getAttributeType() {
return attributeType;
}
@Override
public final Builder attributeType(String attributeType) {
this.attributeType = attributeType;
return this;
}
@Override
public final Builder attributeType(ScalarAttributeType attributeType) {
this.attributeType(attributeType.toString());
return this;
}
public final void setAttributeType(String attributeType) {
this.attributeType = attributeType;
}
@Override
public AttributeDefinition build() {
return new AttributeDefinition(this);
}
}
}