Send feedback
Class ListCollectionIdsRequest.Builder (3.0.21)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.0.21keyboard_arrow_down
public static final class ListCollectionIdsRequest . Builder extends GeneratedMessageV3 . Builder<ListCollectionIdsRequest . Builder > implements ListCollectionIdsRequestOrBuilder
The request for Firestore.ListCollectionIds .
Protobuf type google.firestore.v1.ListCollectionIdsRequest
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
build()
public ListCollectionIdsRequest build ()
Returns
buildPartial()
public ListCollectionIdsRequest buildPartial ()
Returns
clear()
public ListCollectionIdsRequest . Builder clear ()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public ListCollectionIdsRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ListCollectionIdsRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Parameter
Returns
Overrides
clearPageSize()
public ListCollectionIdsRequest . Builder clearPageSize ()
The maximum number of results to return.
int32 page_size = 2;
Returns
clearPageToken()
public ListCollectionIdsRequest . Builder clearPageToken ()
A page token. Must be a value from
ListCollectionIdsResponse .
string page_token = 3;
Returns
clearParent()
public ListCollectionIdsRequest . Builder clearParent ()
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
clone()
public ListCollectionIdsRequest . Builder clone ()
Returns
Overrides
getDefaultInstanceForType()
public ListCollectionIdsRequest getDefaultInstanceForType ()
Returns
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Returns
Overrides
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
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
mergeFrom(ListCollectionIdsRequest other)
public ListCollectionIdsRequest . Builder mergeFrom ( ListCollectionIdsRequest other )
Parameter
Returns
public ListCollectionIdsRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ListCollectionIdsRequest . Builder mergeFrom ( Message other )
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
setPageSize(int value)
public ListCollectionIdsRequest . Builder setPageSize ( int value )
The maximum number of results to return.
int32 page_size = 2;
Parameter
Name Description
value int The pageSize to set.
Returns
setPageToken(String value)
public ListCollectionIdsRequest . Builder setPageToken ( String value )
A page token. Must be a value from
ListCollectionIdsResponse .
string page_token = 3;
Parameter
Name Description
value String The pageToken to set.
Returns
setPageTokenBytes(ByteString value)
public ListCollectionIdsRequest . Builder setPageTokenBytes ( ByteString value )
A page token. Must be a value from
ListCollectionIdsResponse .
string page_token = 3;
Parameter
Name Description
value ByteString The bytes for pageToken to set.
Returns
setParent(String value)
public ListCollectionIdsRequest . Builder setParent ( String value )
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];
Parameter
Name Description
value String The parent to set.
Returns
setParentBytes(ByteString value)
public ListCollectionIdsRequest . Builder setParentBytes ( ByteString value )
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];
Parameter
Name Description
value ByteString The bytes for parent to set.
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListCollectionIdsRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[],[]]
