Class ListCollectionIdsRequest (3.21.0)

public final class ListCollectionIdsRequest extends GeneratedMessageV3 implements ListCollectionIdsRequestOrBuilder

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListCollectionIdsRequest getDefaultInstance()
Returns
Type Description
ListCollectionIdsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListCollectionIdsRequest.Builder newBuilder()
Returns
Type Description
ListCollectionIdsRequest.Builder

newBuilder(ListCollectionIdsRequest prototype)

public static ListCollectionIdsRequest.Builder newBuilder(ListCollectionIdsRequest prototype)
Parameter
Name Description
prototype ListCollectionIdsRequest
Returns
Type Description
ListCollectionIdsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListCollectionIdsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCollectionIdsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCollectionIdsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListCollectionIdsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListCollectionIdsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCollectionIdsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListCollectionIdsRequest> parser()
Returns
Type Description
Parser<ListCollectionIdsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConsistencySelectorCase()

public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
ListCollectionIdsRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public ListCollectionIdsRequest getDefaultInstanceForType()
Returns
Type Description
ListCollectionIdsRequest

getPageSize()

public int getPageSize()

The maximum number of results to return.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListCollectionIdsRequest> getParserForType()
Returns
Type Description
Parser<ListCollectionIdsRequest>
Overrides

getReadTime()

public Timestamp getReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadTime()

public boolean hasReadTime()

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
boolean

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListCollectionIdsRequest.Builder newBuilderForType()
Returns
Type Description
ListCollectionIdsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListCollectionIdsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListCollectionIdsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListCollectionIdsRequest.Builder toBuilder()
Returns
Type Description
ListCollectionIdsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException