com.google.firestore.v1

Class PartitionQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.PartitionQueryRequest

All Implemented Interfaces:

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

public final class PartitionQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements PartitionQueryRequestOrBuilder

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

Protobuf type google.firestore.v1.PartitionQueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionQueryRequest.Builder The request for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
static class	PartitionQueryRequest.ConsistencySelectorCase
static class	PartitionQueryRequest.QueryTypeCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	PARTITION_COUNT_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER
static int	STRUCTURED_QUERY_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)
PartitionQueryRequest.ConsistencySelectorCase	getConsistencySelectorCase()
static PartitionQueryRequest	getDefaultInstance()
PartitionQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getPageSize() The maximum number of partitions to return in this call, subject to `partition_count`.
String	getPageToken() The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results.
com.google.protobuf.ByteString	getPageTokenBytes() The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<PartitionQueryRequest>	getParserForType()
long	getPartitionCount() The desired maximum number of partition points.
PartitionQueryRequest.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.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasReadTime() Reads documents as they were at the given time.
boolean	hasStructuredQuery() A structured query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PartitionQueryRequest.Builder	newBuilder()
static PartitionQueryRequest.Builder	newBuilder(PartitionQueryRequest prototype)
PartitionQueryRequest.Builder	newBuilderForType()
protected PartitionQueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PartitionQueryRequest	parseDelimitedFrom(InputStream input)
static PartitionQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(byte[] data)
static PartitionQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(ByteBuffer data)
static PartitionQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static PartitionQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PartitionQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(InputStream input)
static PartitionQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PartitionQueryRequest>	parser()
PartitionQueryRequest.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, 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

PARTITION_COUNT_FIELD_NUMBER

public static final int PARTITION_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_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 PartitionQueryRequest.QueryTypeCase getQueryTypeCase()

Specified by:

getQueryTypeCase in interface PartitionQueryRequestOrBuilder

getConsistencySelectorCase

public PartitionQueryRequest.ConsistencySelectorCase getConsistencySelectorCase()

Specified by:

getConsistencySelectorCase in interface PartitionQueryRequestOrBuilder

getParent

public String getParent()

 Required. The parent resource name. In the format:
 `projects/{project_id}/databases/{database_id}/documents`.
 Document resource names are not supported; only database resource names
 can be specified.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getParent in interface PartitionQueryRequestOrBuilder

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`.
 Document resource names are not supported; only database resource names
 can be specified.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getParentBytes in interface PartitionQueryRequestOrBuilder

Returns:

The bytes for parent.

hasStructuredQuery

public boolean hasStructuredQuery()

 A structured query.
 Query must specify collection with all descendants and be ordered by name
 ascending. Other filters, order bys, limits, offsets, and start/end
 cursors are not supported.
 

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

Specified by:

hasStructuredQuery in interface PartitionQueryRequestOrBuilder

Returns:

Whether the structuredQuery field is set.

getStructuredQuery

public StructuredQuery getStructuredQuery()

 A structured query.
 Query must specify collection with all descendants and be ordered by name
 ascending. Other filters, order bys, limits, offsets, and start/end
 cursors are not supported.
 

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

Specified by:

getStructuredQuery in interface PartitionQueryRequestOrBuilder

Returns:

The structuredQuery.

getStructuredQueryOrBuilder

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

 A structured query.
 Query must specify collection with all descendants and be ordered by name
 ascending. Other filters, order bys, limits, offsets, and start/end
 cursors are not supported.
 

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

Specified by:

getStructuredQueryOrBuilder in interface PartitionQueryRequestOrBuilder

getPartitionCount

public long getPartitionCount()

 The desired maximum number of partition points.
 The partitions may be returned across multiple pages of results.
 The number must be positive. The actual number of partitions
 returned may be fewer.
 For example, this may be set to one fewer than the number of parallel
 queries to be run, or in running a data pipeline job, one fewer than the
 number of workers or compute instances available.
 

int64 partition_count = 3;

Specified by:

getPartitionCount in interface PartitionQueryRequestOrBuilder

Returns:

The partitionCount.

getPageToken

public String getPageToken()

 The `next_page_token` value returned from a previous call to
 PartitionQuery that may be used to get an additional set of results.
 There are no ordering guarantees between sets of results. Thus, using
 multiple sets of results will require merging the different result sets.
 For example, two subsequent calls using a page_token may return:
  * cursor B, cursor M, cursor Q
  * cursor A, cursor U, cursor W
 To obtain a complete result set ordered with respect to the results of the
 query supplied to PartitionQuery, the results sets should be merged:
 cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
 

string page_token = 4;

Specified by:

getPageToken in interface PartitionQueryRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 The `next_page_token` value returned from a previous call to
 PartitionQuery that may be used to get an additional set of results.
 There are no ordering guarantees between sets of results. Thus, using
 multiple sets of results will require merging the different result sets.
 For example, two subsequent calls using a page_token may return:
  * cursor B, cursor M, cursor Q
  * cursor A, cursor U, cursor W
 To obtain a complete result set ordered with respect to the results of the
 query supplied to PartitionQuery, the results sets should be merged:
 cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface PartitionQueryRequestOrBuilder

Returns:

The bytes for pageToken.

getPageSize

public int getPageSize()

 The maximum number of partitions to return in this call, subject to
 `partition_count`.
 For example, if `partition_count` = 10 and `page_size` = 8, the first call
 to PartitionQuery will return up to 8 partitions and a `next_page_token`
 if more results exist. A second call to PartitionQuery will return up to
 2 partitions, to complete the total of 10 specified in `partition_count`.
 

int32 page_size = 5;

Specified by:

getPageSize in interface PartitionQueryRequestOrBuilder

Returns:

The pageSize.

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 = 6;

Specified by:

hasReadTime in interface PartitionQueryRequestOrBuilder

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 = 6;

Specified by:

getReadTime in interface PartitionQueryRequestOrBuilder

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 = 6;

Specified by:

getReadTimeOrBuilder in interface PartitionQueryRequestOrBuilder

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 PartitionQueryRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PartitionQueryRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PartitionQueryRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public PartitionQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PartitionQueryRequest.Builder newBuilder()

newBuilder

public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)

toBuilder

public PartitionQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PartitionQueryRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PartitionQueryRequest> 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 PartitionQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder