com.amazonaws.services.dynamodbv2.model.Projection Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
/**
*
* Represents attributes that are copied (projected) from the table into
* an index. These are in addition to the primary key attributes and
* index key attributes, which are automatically projected.
*
*/
public class Projection implements Serializable {
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*/
private String projectionType;
/**
* Represents the non-key attribute names which will be projected into
* the index.
For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* Constraints:
* Length: 1 - 20
*/
private com.amazonaws.internal.ListWithAutoConstructFlag nonKeyAttributes;
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*
* @return The set of attributes that are projected into the index:
-
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* @see ProjectionType
*/
public String getProjectionType() {
return projectionType;
}
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*
* @param projectionType The set of attributes that are projected into the index:
-
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* @see ProjectionType
*/
public void setProjectionType(String projectionType) {
this.projectionType = projectionType;
}
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*
* @param projectionType The set of attributes that are projected into the index:
-
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ProjectionType
*/
public Projection withProjectionType(String projectionType) {
this.projectionType = projectionType;
return this;
}
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*
* @param projectionType The set of attributes that are projected into the index:
-
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* @see ProjectionType
*/
public void setProjectionType(ProjectionType projectionType) {
this.projectionType = projectionType.toString();
}
/**
* The set of attributes that are projected into the index: -
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: ALL, KEYS_ONLY, INCLUDE
*
* @param projectionType The set of attributes that are projected into the index:
-
*
KEYS_ONLY - Only the index and primary keys are
* projected into the index.
-
INCLUDE - Only
* the specified table attributes are projected into the index. The list
* of projected attributes are in NonKeyAttributes.
-
*
ALL - All of the table attributes are projected into
* the index.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ProjectionType
*/
public Projection withProjectionType(ProjectionType projectionType) {
this.projectionType = projectionType.toString();
return this;
}
/**
* Represents the non-key attribute names which will be projected into
* the index. For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* Constraints:
* Length: 1 - 20
*
* @return Represents the non-key attribute names which will be projected into
* the index.
For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*/
public java.util.List getNonKeyAttributes() {
return nonKeyAttributes;
}
/**
* Represents the non-key attribute names which will be projected into
* the index. For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* Constraints:
* Length: 1 - 20
*
* @param nonKeyAttributes Represents the non-key attribute names which will be projected into
* the index.
For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*/
public void setNonKeyAttributes(java.util.Collection nonKeyAttributes) {
if (nonKeyAttributes == null) {
this.nonKeyAttributes = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag nonKeyAttributesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(nonKeyAttributes.size());
nonKeyAttributesCopy.addAll(nonKeyAttributes);
this.nonKeyAttributes = nonKeyAttributesCopy;
}
/**
* Represents the non-key attribute names which will be projected into
* the index. For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 20
*
* @param nonKeyAttributes Represents the non-key attribute names which will be projected into
* the index.
For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public Projection withNonKeyAttributes(String... nonKeyAttributes) {
if (getNonKeyAttributes() == null) setNonKeyAttributes(new java.util.ArrayList(nonKeyAttributes.length));
for (String value : nonKeyAttributes) {
getNonKeyAttributes().add(value);
}
return this;
}
/**
* Represents the non-key attribute names which will be projected into
* the index. For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 20
*
* @param nonKeyAttributes Represents the non-key attribute names which will be projected into
* the index.
For local secondary indexes, the total count of
* NonKeyAttributes summed across all of the local secondary
* indexes, must not exceed 20. If you project the same attribute into
* two different indexes, this counts as two distinct attributes when
* determining the total.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public Projection withNonKeyAttributes(java.util.Collection nonKeyAttributes) {
if (nonKeyAttributes == null) {
this.nonKeyAttributes = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag nonKeyAttributesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(nonKeyAttributes.size());
nonKeyAttributesCopy.addAll(nonKeyAttributes);
this.nonKeyAttributes = nonKeyAttributesCopy;
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getProjectionType() != null) sb.append("ProjectionType: " + getProjectionType() + ",");
if (getNonKeyAttributes() != null) sb.append("NonKeyAttributes: " + getNonKeyAttributes() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getProjectionType() == null) ? 0 : getProjectionType().hashCode());
hashCode = prime * hashCode + ((getNonKeyAttributes() == null) ? 0 : getNonKeyAttributes().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof Projection == false) return false;
Projection other = (Projection)obj;
if (other.getProjectionType() == null ^ this.getProjectionType() == null) return false;
if (other.getProjectionType() != null && other.getProjectionType().equals(this.getProjectionType()) == false) return false;
if (other.getNonKeyAttributes() == null ^ this.getNonKeyAttributes() == null) return false;
if (other.getNonKeyAttributes() != null && other.getNonKeyAttributes().equals(this.getNonKeyAttributes()) == false) return false;
return true;
}
}