Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 

Represents the output of a Query operation.

 
 public class QueryResult implements SerializableCloneable {

    
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
 
The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

 
     private Integer count;

    
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

 
     private Integer scannedCount;

    
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

 
     private java.util.Map<String,AttributeValuelastEvaluatedKey;

    
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
 
     private ConsumedCapacity consumedCapacity;

    
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

Returns:
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
 
         return ;
     }
    
    
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

Parameters:
items An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
 
    public void setItems(java.util.Collection<java.util.Map<String,AttributeValue>> items) {
        if (items == null) {
            this. = null;
            return;
        }
        itemsCopy.addAll(items);
        this. = itemsCopy;
    }
    
    
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

NOTE: This method appends the values to the existing list (if any). Use setItems(java.util.Collection) or withItems(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:
items An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
Returns:
A reference to this updated object so that method calls can be chained together.
    public QueryResult withItems(java.util.Map<String,AttributeValue>... items) {
        if (getItems() == nullsetItems(new java.util.ArrayList<java.util.Map<String,AttributeValue>>(items.length));
        for (java.util.Map<String,AttributeValuevalue : items) {
            getItems().add(value);
        }
        return this;
    }
    
    
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

Returns a reference to this object so that method calls can be chained together.

Parameters:
items An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (items == null) {
            this. = null;
        } else {
            itemsCopy.addAll(items);
            this. = itemsCopy;
        }
        return this;
    }

    
The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

Returns:
The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

    public Integer getCount() {
        return ;
    }
    
    
The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

Parameters:
count The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

    public void setCount(Integer count) {
        this. = count;
    }
    
    
The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

Returns a reference to this object so that method calls can be chained together.

Parameters:
count The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

Returns:
A reference to this updated object so that method calls can be chained together.
    public QueryResult withCount(Integer count) {
        this. = count;
        return this;
    }

    
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Returns:
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

    public Integer getScannedCount() {
        return ;
    }
    
    
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Parameters:
scannedCount The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

    public void setScannedCount(Integer scannedCount) {
        this. = scannedCount;
    }
    
    
The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Returns a reference to this object so that method calls can be chained together.

Parameters:
scannedCount The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Returns:
A reference to this updated object so that method calls can be chained together.
    public QueryResult withScannedCount(Integer scannedCount) {
        this. = scannedCount;
        return this;
    }

    
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

Returns:
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

        
        return ;
    }
    
    
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

Parameters:
lastEvaluatedKey The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

    public void setLastEvaluatedKey(java.util.Map<String,AttributeValuelastEvaluatedKey) {
        this. = lastEvaluatedKey;
    }
    
    
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

Returns a reference to this object so that method calls can be chained together.

Parameters:
lastEvaluatedKey The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

Returns:
A reference to this updated object so that method calls can be chained together.
    public QueryResult withLastEvaluatedKey(java.util.Map<String,AttributeValuelastEvaluatedKey) {
        setLastEvaluatedKey(lastEvaluatedKey);
        return this;
    }

    
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

The method adds a new key-value pair into LastEvaluatedKey parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:
key The key of the entry to be added into LastEvaluatedKey.
value The corresponding value of the entry to be added into LastEvaluatedKey.
    if (null == this.) {
    }
    if (this..containsKey(key))
      throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
    this..put(keyvalue);
    return this;
  }

  
Removes all the entries added into LastEvaluatedKey.

Returns a reference to this object so that method calls can be chained together.

    this. = null;
    return this;
  }
  
    
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Returns:
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
        return ;
    }
    
    
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Parameters:
consumedCapacity The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
    public void setConsumedCapacity(ConsumedCapacity consumedCapacity) {
        this. = consumedCapacity;
    }
    
    
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:
consumedCapacity The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
Returns:
A reference to this updated object so that method calls can be chained together.
    public QueryResult withConsumedCapacity(ConsumedCapacity consumedCapacity) {
        this. = consumedCapacity;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getItems() != nullsb.append("Items: " + getItems() + ",");
        if (getCount() != nullsb.append("Count: " + getCount() + ",");
        if (getScannedCount() != nullsb.append("ScannedCount: " + getScannedCount() + ",");
        if (getLastEvaluatedKey() != nullsb.append("LastEvaluatedKey: " + getLastEvaluatedKey() + ",");
        if (getConsumedCapacity() != nullsb.append("ConsumedCapacity: " + getConsumedCapacity() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getItems() == null) ? 0 : getItems().hashCode()); 
        hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode()); 
        hashCode = prime * hashCode + ((getScannedCount() == null) ? 0 : getScannedCount().hashCode()); 
        hashCode = prime * hashCode + ((getLastEvaluatedKey() == null) ? 0 : getLastEvaluatedKey().hashCode()); 
        hashCode = prime * hashCode + ((getConsumedCapacity() == null) ? 0 : getConsumedCapacity().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof QueryResult == falsereturn false;
        QueryResult other = (QueryResult)obj;
        
        if (other.getItems() == null ^ this.getItems() == nullreturn false;
        if (other.getItems() != null && other.getItems().equals(this.getItems()) == falsereturn false
        if (other.getCount() == null ^ this.getCount() == nullreturn false;
        if (other.getCount() != null && other.getCount().equals(this.getCount()) == falsereturn false
        if (other.getScannedCount() == null ^ this.getScannedCount() == nullreturn false;
        if (other.getScannedCount() != null && other.getScannedCount().equals(this.getScannedCount()) == falsereturn false
        if (other.getLastEvaluatedKey() == null ^ this.getLastEvaluatedKey() == nullreturn false;
        if (other.getLastEvaluatedKey() != null && other.getLastEvaluatedKey().equals(this.getLastEvaluatedKey()) == falsereturn false
        if (other.getConsumedCapacity() == null ^ this.getConsumedCapacity() == nullreturn false;
        if (other.getConsumedCapacity() != null && other.getConsumedCapacity().equals(this.getConsumedCapacity()) == falsereturn false
        return true;
    }
    
    @Override
    public QueryResult clone() {
        try {
            return (QueryResultsuper.clone();
        
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                    + "even though we're Cloneable!",
                    e);
        }
        
    }
}
    
New to GrepCode? Check out our FAQ X