com.google.appengine.repackaged.com.google.datastore.v1.QueryResultBatchOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appengine-api-1.0-sdk
Show all versions of appengine-api-1.0-sdk
API for Google App Engine standard environment with some of the dependencies shaded (repackaged)
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/datastore/v1/query.proto
package com.google.datastore.v1;
public interface QueryResultBatchOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.datastore.v1.QueryResultBatch)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The number of results skipped, typically because of an offset.
*
*
* int32 skipped_results = 6;
*
* @return The skippedResults.
*/
int getSkippedResults();
/**
*
*
*
* A cursor that points to the position after the last skipped result.
* Will be set when `skipped_results` != 0.
*
*
* bytes skipped_cursor = 3;
*
* @return The skippedCursor.
*/
com.google.protobuf.ByteString getSkippedCursor();
/**
*
*
*
* The result type for every entity in `entity_results`.
*
*
* .google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
*
* @return The enum numeric value on the wire for entityResultType.
*/
int getEntityResultTypeValue();
/**
*
*
*
* The result type for every entity in `entity_results`.
*
*
* .google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
*
* @return The entityResultType.
*/
com.google.datastore.v1.EntityResult.ResultType getEntityResultType();
/**
*
*
*
* The results for this batch.
*
*
* repeated .google.datastore.v1.EntityResult entity_results = 2;
*/
java.util.List getEntityResultsList();
/**
*
*
*
* The results for this batch.
*
*
* repeated .google.datastore.v1.EntityResult entity_results = 2;
*/
com.google.datastore.v1.EntityResult getEntityResults(int index);
/**
*
*
*
* The results for this batch.
*
*
* repeated .google.datastore.v1.EntityResult entity_results = 2;
*/
int getEntityResultsCount();
/**
*
*
*
* The results for this batch.
*
*
* repeated .google.datastore.v1.EntityResult entity_results = 2;
*/
java.util.List
getEntityResultsOrBuilderList();
/**
*
*
*
* The results for this batch.
*
*
* repeated .google.datastore.v1.EntityResult entity_results = 2;
*/
com.google.datastore.v1.EntityResultOrBuilder getEntityResultsOrBuilder(int index);
/**
*
*
*
* A cursor that points to the position after the last result in the batch.
*
*
* bytes end_cursor = 4;
*
* @return The endCursor.
*/
com.google.protobuf.ByteString getEndCursor();
/**
*
*
*
* The state of the query after the current batch.
*
*
* .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
*
* @return The enum numeric value on the wire for moreResults.
*/
int getMoreResultsValue();
/**
*
*
*
* The state of the query after the current batch.
*
*
* .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
*
* @return The moreResults.
*/
com.google.datastore.v1.QueryResultBatch.MoreResultsType getMoreResults();
/**
*
*
*
* 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;
*
* @return The snapshotVersion.
*/
long getSnapshotVersion();
/**
*
*
*
* Read timestamp 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 timestamp. Each batch's read timestamp
* is valid for all preceding batches.
* This value will not be set for eventually consistent queries in Cloud
* Datastore.
*
*
* .google.protobuf.Timestamp read_time = 8;
*
* @return Whether the readTime field is set.
*/
boolean hasReadTime();
/**
*
*
*
* Read timestamp 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 timestamp. Each batch's read timestamp
* is valid for all preceding batches.
* This value will not be set for eventually consistent queries in Cloud
* Datastore.
*
*
* .google.protobuf.Timestamp read_time = 8;
*
* @return The readTime.
*/
com.google.protobuf.Timestamp getReadTime();
/**
*
*
*
* Read timestamp 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 timestamp. Each batch's read timestamp
* is valid for all preceding batches.
* This value will not be set for eventually consistent queries in Cloud
* Datastore.
*
*
* .google.protobuf.Timestamp read_time = 8;
*/
com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();
}