com.google.firestore.v1beta1

Class RunQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1beta1.RunQueryRequest

All Implemented Interfaces:

RunQueryRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class RunQueryRequest
extends GeneratedMessageV3
implements RunQueryRequestOrBuilder

 The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
 

Protobuf type google.firestore.v1beta1.RunQueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunQueryRequest.Builder The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
static class	RunQueryRequest.ConsistencySelectorCase
static class	RunQueryRequest.QueryTypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEW_TRANSACTION_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER
static int	STRUCTURED_QUERY_FIELD_NUMBER
static int	TRANSACTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
RunQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
static RunQueryRequest	getDefaultInstance()
RunQueryRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
TransactionOptions	getNewTransaction() Starts a new transaction and reads the documents.
TransactionOptionsOrBuilder	getNewTransactionOrBuilder() Starts a new transaction and reads the documents.
java.lang.String	getParent() The parent resource name.
ByteString	getParentBytes() The parent resource name.
Parser<RunQueryRequest>	getParserForType()
RunQueryRequest.QueryTypeCase	getQueryTypeCase()
Timestamp	getReadTime() Reads documents as they were at the given time.
TimestampOrBuilder	getReadTimeOrBuilder() Reads documents as they were at the given time.
int	getSerializedSize()
StructuredQuery	getStructuredQuery() A structured query.
StructuredQueryOrBuilder	getStructuredQueryOrBuilder() A structured query.
ByteString	getTransaction() Reads documents in a transaction.
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasNewTransaction() Starts a new transaction and reads the documents.
boolean	hasReadTime() Reads documents as they were at the given time.
boolean	hasStructuredQuery() A structured query.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunQueryRequest.Builder	newBuilder()
static RunQueryRequest.Builder	newBuilder(RunQueryRequest prototype)
RunQueryRequest.Builder	newBuilderForType()
protected RunQueryRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static RunQueryRequest	parseDelimitedFrom(java.io.InputStream input)
static RunQueryRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(byte[] data)
static RunQueryRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(java.nio.ByteBuffer data)
static RunQueryRequest	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(ByteString data)
static RunQueryRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(CodedInputStream input)
static RunQueryRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(java.io.InputStream input)
static RunQueryRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<RunQueryRequest>	parser()
RunQueryRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

STRUCTURED_QUERY_FIELD_NUMBER

public static final int STRUCTURED_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

NEW_TRANSACTION_FIELD_NUMBER

public static final int NEW_TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getQueryTypeCase

public RunQueryRequest.QueryTypeCase getQueryTypeCase()

Specified by:

getQueryTypeCase in interface RunQueryRequestOrBuilder

getConsistencySelectorCase

public RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Specified by:

getConsistencySelectorCase in interface RunQueryRequestOrBuilder

getParent

public java.lang.String getParent()

 The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 

string parent = 1;

Specified by:

getParent in interface RunQueryRequestOrBuilder

getParentBytes

public ByteString getParentBytes()

 The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 For example:
 `projects/my-project/databases/my-database/documents` or
 `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 

string parent = 1;

Specified by:

getParentBytes in interface RunQueryRequestOrBuilder

hasStructuredQuery

public boolean hasStructuredQuery()

 A structured query.
 

.google.firestore.v1beta1.StructuredQuery structured_query = 2;

Specified by:

hasStructuredQuery in interface RunQueryRequestOrBuilder

getStructuredQuery

public StructuredQuery getStructuredQuery()

 A structured query.
 

.google.firestore.v1beta1.StructuredQuery structured_query = 2;

Specified by:

getStructuredQuery in interface RunQueryRequestOrBuilder

getStructuredQueryOrBuilder

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

 A structured query.
 

.google.firestore.v1beta1.StructuredQuery structured_query = 2;

Specified by:

getStructuredQueryOrBuilder in interface RunQueryRequestOrBuilder

getTransaction

public ByteString getTransaction()

 Reads documents in a transaction.
 

bytes transaction = 5;

Specified by:

getTransaction in interface RunQueryRequestOrBuilder

hasNewTransaction

public boolean hasNewTransaction()

 Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
 

.google.firestore.v1beta1.TransactionOptions new_transaction = 6;

Specified by:

hasNewTransaction in interface RunQueryRequestOrBuilder

getNewTransaction

public TransactionOptions getNewTransaction()

 Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
 

.google.firestore.v1beta1.TransactionOptions new_transaction = 6;

Specified by:

getNewTransaction in interface RunQueryRequestOrBuilder

getNewTransactionOrBuilder

public TransactionOptionsOrBuilder getNewTransactionOrBuilder()

 Starts a new transaction and reads the documents.
 Defaults to a read-only transaction.
 The new transaction ID will be returned as the first response in the
 stream.
 

.google.firestore.v1beta1.TransactionOptions new_transaction = 6;

Specified by:

getNewTransactionOrBuilder in interface RunQueryRequestOrBuilder

hasReadTime

public boolean hasReadTime()

 Reads documents as they were at the given time.
 This may not be older than 60 seconds.
 

.google.protobuf.Timestamp read_time = 7;

Specified by:

hasReadTime in interface RunQueryRequestOrBuilder

getReadTime

public Timestamp getReadTime()

 Reads documents as they were at the given time.
 This may not be older than 60 seconds.
 

.google.protobuf.Timestamp read_time = 7;

Specified by:

getReadTime in interface RunQueryRequestOrBuilder

getReadTimeOrBuilder

public TimestampOrBuilder getReadTimeOrBuilder()

 Reads documents as they were at the given time.
 This may not be older than 60 seconds.
 

.google.protobuf.Timestamp read_time = 7;

Specified by:

getReadTimeOrBuilder in interface RunQueryRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static RunQueryRequest parseFrom(java.nio.ByteBuffer data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(java.nio.ByteBuffer data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(ByteString data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(byte[] data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(byte[] data,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(java.io.InputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RunQueryRequest parseFrom(java.io.InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static RunQueryRequest parseDelimitedFrom(java.io.InputStream input)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static RunQueryRequest parseDelimitedFrom(java.io.InputStream input,
                                                 ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RunQueryRequest parseFrom(CodedInputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static RunQueryRequest parseFrom(CodedInputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public RunQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RunQueryRequest.Builder newBuilder()

newBuilder

public static RunQueryRequest.Builder newBuilder(RunQueryRequest prototype)

toBuilder

public RunQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RunQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RunQueryRequest getDefaultInstance()

parser

public static Parser<RunQueryRequest> parser()

getParserForType

public Parser<RunQueryRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RunQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder