com.google.firestore.v1

Class RunQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.RunQueryRequest

All Implemented Interfaces:

RunQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RunQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements RunQueryRequestOrBuilder

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

Protobuf type google.firestore.v1.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.v1.Firestore.RunQuery].
static class	RunQueryRequest.ConsistencySelectorCase
static class	RunQueryRequest.QueryTypeCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

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(Object obj)
RunQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
static RunQueryRequest	getDefaultInstance()
RunQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
TransactionOptions	getNewTransaction() Starts a new transaction and reads the documents.
TransactionOptionsOrBuilder	getNewTransactionOrBuilder() Starts a new transaction and reads the documents.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<RunQueryRequest>	getParserForType()
RunQueryRequest.QueryTypeCase	getQueryTypeCase()
com.google.protobuf.Timestamp	getReadTime() Reads documents as they were at the given time.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Reads documents as they were at the given time.
int	getSerializedSize()
StructuredQuery	getStructuredQuery() A structured query.
StructuredQueryOrBuilder	getStructuredQueryOrBuilder() A structured query.
com.google.protobuf.ByteString	getTransaction() Run the query within an already active transaction.
com.google.protobuf.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.
boolean	hasTransaction() Run the query within an already active transaction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunQueryRequest.Builder	newBuilder()
static RunQueryRequest.Builder	newBuilder(RunQueryRequest prototype)
RunQueryRequest.Builder	newBuilderForType()
protected RunQueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RunQueryRequest	parseDelimitedFrom(InputStream input)
static RunQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(byte[] data)
static RunQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(ByteBuffer data)
static RunQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static RunQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RunQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryRequest	parseFrom(InputStream input)
static RunQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunQueryRequest>	parser()
RunQueryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.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 String getParent()

 Required. 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getParent in interface RunQueryRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getParentBytes in interface RunQueryRequestOrBuilder

Returns:

The bytes for parent.

hasStructuredQuery

public boolean hasStructuredQuery()

 A structured query.
 

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

Specified by:

hasStructuredQuery in interface RunQueryRequestOrBuilder

Returns:

Whether the structuredQuery field is set.

getStructuredQuery

public StructuredQuery getStructuredQuery()

 A structured query.
 

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

Specified by:

getStructuredQuery in interface RunQueryRequestOrBuilder

Returns:

The structuredQuery.

getStructuredQueryOrBuilder

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

 A structured query.
 

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

Specified by:

getStructuredQueryOrBuilder in interface RunQueryRequestOrBuilder

hasTransaction

public boolean hasTransaction()

 Run the query within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.
 

bytes transaction = 5;

Specified by:

hasTransaction in interface RunQueryRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction

public com.google.protobuf.ByteString getTransaction()

 Run the query within an already active transaction.
 The value here is the opaque transaction ID to execute the query in.
 

bytes transaction = 5;

Specified by:

getTransaction in interface RunQueryRequestOrBuilder

Returns:

The transaction.

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.v1.TransactionOptions new_transaction = 6;

Specified by:

hasNewTransaction in interface RunQueryRequestOrBuilder

Returns:

Whether the newTransaction field is set.

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.v1.TransactionOptions new_transaction = 6;

Specified by:

getNewTransaction in interface RunQueryRequestOrBuilder

Returns:

The newTransaction.

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.v1.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 270 seconds.
 

.google.protobuf.Timestamp read_time = 7;

Specified by:

hasReadTime in interface RunQueryRequestOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.Timestamp getReadTime()

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

.google.protobuf.Timestamp read_time = 7;

Specified by:

getReadTime in interface RunQueryRequestOrBuilder

Returns:

The readTime.

getReadTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

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

.google.protobuf.Timestamp read_time = 7;

Specified by:

getReadTimeOrBuilder in interface RunQueryRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RunQueryRequest parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryRequest parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static RunQueryRequest parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunQueryRequest parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static RunQueryRequest parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static RunQueryRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static RunQueryRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public RunQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RunQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunQueryRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<RunQueryRequest> parser()

getParserForType

public com.google.protobuf.Parser<RunQueryRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RunQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder