com.google.firestore.v1

Interface ListCollectionIdsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListCollectionIdsRequest, ListCollectionIdsRequest.Builder

public interface ListCollectionIdsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ListCollectionIdsRequest.ConsistencySelectorCase	getConsistencySelectorCase()
int	getPageSize() The maximum number of results to return.
String	getPageToken() A page token.
com.google.protobuf.ByteString	getPageTokenBytes() A page token.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
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.
boolean	hasReadTime() Reads documents as they were at the given time.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

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

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

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

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 The maximum number of results to return.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 A page token. Must be a value from
 [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
 

string page_token = 3;

Returns:

The bytes for pageToken.

hasReadTime

boolean hasReadTime()

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

.google.protobuf.Timestamp read_time = 4;

Returns:

Whether the readTime field is set.

getReadTime

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

Returns:

The readTime.

getReadTimeOrBuilder

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

getConsistencySelectorCase

ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()