com.google.datastore.v1

Class QueryResultBatch.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<QueryResultBatch.Builder>

com.google.datastore.v1.QueryResultBatch.Builder

All Implemented Interfaces:

QueryResultBatchOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

QueryResultBatch

public static final class QueryResultBatch.Builder
extends GeneratedMessageV3.Builder<QueryResultBatch.Builder>
implements QueryResultBatchOrBuilder

 A batch of results produced by a query.
 

Protobuf type google.datastore.v1.QueryResultBatch

Method Summary

Modifier and Type	Method and Description
QueryResultBatch.Builder	addAllEntityResults(java.lang.Iterable<? extends EntityResult> values) The results for this batch.
QueryResultBatch.Builder	addEntityResults(EntityResult.Builder builderForValue) The results for this batch.
QueryResultBatch.Builder	addEntityResults(EntityResult value) The results for this batch.
QueryResultBatch.Builder	addEntityResults(int index, EntityResult.Builder builderForValue) The results for this batch.
QueryResultBatch.Builder	addEntityResults(int index, EntityResult value) The results for this batch.
EntityResult.Builder	addEntityResultsBuilder() The results for this batch.
EntityResult.Builder	addEntityResultsBuilder(int index) The results for this batch.
QueryResultBatch.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
QueryResultBatch	build()
QueryResultBatch	buildPartial()
QueryResultBatch.Builder	clear()
QueryResultBatch.Builder	clearEndCursor() A cursor that points to the position after the last result in the batch.
QueryResultBatch.Builder	clearEntityResults() The results for this batch.
QueryResultBatch.Builder	clearEntityResultType() The result type for every entity in `entity_results`.
QueryResultBatch.Builder	clearField(Descriptors.FieldDescriptor field)
QueryResultBatch.Builder	clearMoreResults() The state of the query after the current batch.
QueryResultBatch.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
QueryResultBatch.Builder	clearSkippedCursor() A cursor that points to the position after the last skipped result.
QueryResultBatch.Builder	clearSkippedResults() The number of results skipped, typically because of an offset.
QueryResultBatch.Builder	clearSnapshotVersion() The version number of the snapshot this batch was returned from.
QueryResultBatch.Builder	clone()
QueryResultBatch	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
ByteString	getEndCursor() A cursor that points to the position after the last result in the batch.
EntityResult	getEntityResults(int index) The results for this batch.
EntityResult.Builder	getEntityResultsBuilder(int index) The results for this batch.
java.util.List<EntityResult.Builder>	getEntityResultsBuilderList() The results for this batch.
int	getEntityResultsCount() The results for this batch.
java.util.List<EntityResult>	getEntityResultsList() The results for this batch.
EntityResultOrBuilder	getEntityResultsOrBuilder(int index) The results for this batch.
java.util.List<? extends EntityResultOrBuilder>	getEntityResultsOrBuilderList() The results for this batch.
EntityResult.ResultType	getEntityResultType() The result type for every entity in `entity_results`.
int	getEntityResultTypeValue() The result type for every entity in `entity_results`.
QueryResultBatch.MoreResultsType	getMoreResults() The state of the query after the current batch.
int	getMoreResultsValue() The state of the query after the current batch.
ByteString	getSkippedCursor() A cursor that points to the position after the last skipped result.
int	getSkippedResults() The number of results skipped, typically because of an offset.
long	getSnapshotVersion() The version number of the snapshot this batch was returned from.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
QueryResultBatch.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
QueryResultBatch.Builder	mergeFrom(Message other)
QueryResultBatch.Builder	mergeFrom(QueryResultBatch other)
QueryResultBatch.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
QueryResultBatch.Builder	removeEntityResults(int index) The results for this batch.
QueryResultBatch.Builder	setEndCursor(ByteString value) A cursor that points to the position after the last result in the batch.
QueryResultBatch.Builder	setEntityResults(int index, EntityResult.Builder builderForValue) The results for this batch.
QueryResultBatch.Builder	setEntityResults(int index, EntityResult value) The results for this batch.
QueryResultBatch.Builder	setEntityResultType(EntityResult.ResultType value) The result type for every entity in `entity_results`.
QueryResultBatch.Builder	setEntityResultTypeValue(int value) The result type for every entity in `entity_results`.
QueryResultBatch.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
QueryResultBatch.Builder	setMoreResults(QueryResultBatch.MoreResultsType value) The state of the query after the current batch.
QueryResultBatch.Builder	setMoreResultsValue(int value) The state of the query after the current batch.
QueryResultBatch.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
QueryResultBatch.Builder	setSkippedCursor(ByteString value) A cursor that points to the position after the last skipped result.
QueryResultBatch.Builder	setSkippedResults(int value) The number of results skipped, typically because of an offset.
QueryResultBatch.Builder	setSnapshotVersion(long value) The version number of the snapshot this batch was returned from.
QueryResultBatch.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

clear

public QueryResultBatch.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

getDefaultInstanceForType

public QueryResultBatch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public QueryResultBatch build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public QueryResultBatch buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public QueryResultBatch.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

setField

public QueryResultBatch.Builder setField(Descriptors.FieldDescriptor field,
                                         java.lang.Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

clearField

public QueryResultBatch.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

clearOneof

public QueryResultBatch.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

setRepeatedField

public QueryResultBatch.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                 int index,
                                                 java.lang.Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

addRepeatedField

public QueryResultBatch.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

mergeFrom

public QueryResultBatch.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<QueryResultBatch.Builder>

mergeFrom

public QueryResultBatch.Builder mergeFrom(QueryResultBatch other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

mergeFrom

public QueryResultBatch.Builder mergeFrom(CodedInputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<QueryResultBatch.Builder>

Throws:

java.io.IOException

getSkippedResults

public int getSkippedResults()

 The number of results skipped, typically because of an offset.
 

int32 skipped_results = 6;

Specified by:

getSkippedResults in interface QueryResultBatchOrBuilder

setSkippedResults

public QueryResultBatch.Builder setSkippedResults(int value)

 The number of results skipped, typically because of an offset.
 

int32 skipped_results = 6;

clearSkippedResults

public QueryResultBatch.Builder clearSkippedResults()

 The number of results skipped, typically because of an offset.
 

int32 skipped_results = 6;

getSkippedCursor

public ByteString getSkippedCursor()

 A cursor that points to the position after the last skipped result.
 Will be set when `skipped_results` != 0.
 

bytes skipped_cursor = 3;

Specified by:

getSkippedCursor in interface QueryResultBatchOrBuilder

setSkippedCursor

public QueryResultBatch.Builder setSkippedCursor(ByteString value)

 A cursor that points to the position after the last skipped result.
 Will be set when `skipped_results` != 0.
 

bytes skipped_cursor = 3;

clearSkippedCursor

public QueryResultBatch.Builder clearSkippedCursor()

 A cursor that points to the position after the last skipped result.
 Will be set when `skipped_results` != 0.
 

bytes skipped_cursor = 3;

getEntityResultTypeValue

public int getEntityResultTypeValue()

 The result type for every entity in `entity_results`.
 

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

Specified by:

getEntityResultTypeValue in interface QueryResultBatchOrBuilder

setEntityResultTypeValue

public QueryResultBatch.Builder setEntityResultTypeValue(int value)

 The result type for every entity in `entity_results`.
 

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

getEntityResultType

public EntityResult.ResultType getEntityResultType()

 The result type for every entity in `entity_results`.
 

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

Specified by:

getEntityResultType in interface QueryResultBatchOrBuilder

setEntityResultType

public QueryResultBatch.Builder setEntityResultType(EntityResult.ResultType value)

 The result type for every entity in `entity_results`.
 

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

clearEntityResultType

public QueryResultBatch.Builder clearEntityResultType()

 The result type for every entity in `entity_results`.
 

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

getEntityResultsList

public java.util.List<EntityResult> getEntityResultsList()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

Specified by:

getEntityResultsList in interface QueryResultBatchOrBuilder

getEntityResultsCount

public int getEntityResultsCount()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

Specified by:

getEntityResultsCount in interface QueryResultBatchOrBuilder

getEntityResults

public EntityResult getEntityResults(int index)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

Specified by:

getEntityResults in interface QueryResultBatchOrBuilder

setEntityResults

public QueryResultBatch.Builder setEntityResults(int index,
                                                 EntityResult value)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

setEntityResults

public QueryResultBatch.Builder setEntityResults(int index,
                                                 EntityResult.Builder builderForValue)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addEntityResults

public QueryResultBatch.Builder addEntityResults(EntityResult value)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addEntityResults

public QueryResultBatch.Builder addEntityResults(int index,
                                                 EntityResult value)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addEntityResults

public QueryResultBatch.Builder addEntityResults(EntityResult.Builder builderForValue)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addEntityResults

public QueryResultBatch.Builder addEntityResults(int index,
                                                 EntityResult.Builder builderForValue)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addAllEntityResults

public QueryResultBatch.Builder addAllEntityResults(java.lang.Iterable<? extends EntityResult> values)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

clearEntityResults

public QueryResultBatch.Builder clearEntityResults()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

removeEntityResults

public QueryResultBatch.Builder removeEntityResults(int index)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

getEntityResultsBuilder

public EntityResult.Builder getEntityResultsBuilder(int index)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

getEntityResultsOrBuilder

public EntityResultOrBuilder getEntityResultsOrBuilder(int index)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

Specified by:

getEntityResultsOrBuilder in interface QueryResultBatchOrBuilder

getEntityResultsOrBuilderList

public java.util.List<? extends EntityResultOrBuilder> getEntityResultsOrBuilderList()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

Specified by:

getEntityResultsOrBuilderList in interface QueryResultBatchOrBuilder

addEntityResultsBuilder

public EntityResult.Builder addEntityResultsBuilder()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

addEntityResultsBuilder

public EntityResult.Builder addEntityResultsBuilder(int index)

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

getEntityResultsBuilderList

public java.util.List<EntityResult.Builder> getEntityResultsBuilderList()

 The results for this batch.
 

repeated .google.datastore.v1.EntityResult entity_results = 2;

getEndCursor

public ByteString getEndCursor()

 A cursor that points to the position after the last result in the batch.
 

bytes end_cursor = 4;

Specified by:

getEndCursor in interface QueryResultBatchOrBuilder

setEndCursor

public QueryResultBatch.Builder setEndCursor(ByteString value)

 A cursor that points to the position after the last result in the batch.
 

bytes end_cursor = 4;

clearEndCursor

public QueryResultBatch.Builder clearEndCursor()

 A cursor that points to the position after the last result in the batch.
 

bytes end_cursor = 4;

getMoreResultsValue

public int getMoreResultsValue()

 The state of the query after the current batch.
 

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

Specified by:

getMoreResultsValue in interface QueryResultBatchOrBuilder

setMoreResultsValue

public QueryResultBatch.Builder setMoreResultsValue(int value)

 The state of the query after the current batch.
 

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

getMoreResults

public QueryResultBatch.MoreResultsType getMoreResults()

 The state of the query after the current batch.
 

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

Specified by:

getMoreResults in interface QueryResultBatchOrBuilder

setMoreResults

public QueryResultBatch.Builder setMoreResults(QueryResultBatch.MoreResultsType value)

 The state of the query after the current batch.
 

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

clearMoreResults

public QueryResultBatch.Builder clearMoreResults()

 The state of the query after the current batch.
 

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

getSnapshotVersion

public long getSnapshotVersion()

 The version number of the snapshot this batch was returned from.
 This applies to the range of results from the query's `start_cursor` (or
 the beginning of the query if no cursor was given) to this batch's
 `end_cursor` (not the query's `end_cursor`).
 In a single transaction, subsequent query result batches for the same query
 can have a greater snapshot version number. Each batch's snapshot version
 is valid for all preceding batches.
 The value will be zero for eventually consistent queries.
 

int64 snapshot_version = 7;

Specified by:

getSnapshotVersion in interface QueryResultBatchOrBuilder

setSnapshotVersion

public QueryResultBatch.Builder setSnapshotVersion(long value)

 The version number of the snapshot this batch was returned from.
 This applies to the range of results from the query's `start_cursor` (or
 the beginning of the query if no cursor was given) to this batch's
 `end_cursor` (not the query's `end_cursor`).
 In a single transaction, subsequent query result batches for the same query
 can have a greater snapshot version number. Each batch's snapshot version
 is valid for all preceding batches.
 The value will be zero for eventually consistent queries.
 

int64 snapshot_version = 7;

clearSnapshotVersion

public QueryResultBatch.Builder clearSnapshotVersion()

 The version number of the snapshot this batch was returned from.
 This applies to the range of results from the query's `start_cursor` (or
 the beginning of the query if no cursor was given) to this batch's
 `end_cursor` (not the query's `end_cursor`).
 In a single transaction, subsequent query result batches for the same query
 can have a greater snapshot version number. Each batch's snapshot version
 is valid for all preceding batches.
 The value will be zero for eventually consistent queries.
 

int64 snapshot_version = 7;

setUnknownFields

public final QueryResultBatch.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>

mergeUnknownFields

public final QueryResultBatch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<QueryResultBatch.Builder>