Class ListCollectionIdsRequest.Builder (3.10.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListCollectionIdsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

build()

public ListCollectionIdsRequest build()
Returns
TypeDescription
ListCollectionIdsRequest

buildPartial()

public ListCollectionIdsRequest buildPartial()
Returns
TypeDescription
ListCollectionIdsRequest

clear()

public ListCollectionIdsRequest.Builder clear()
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

clearConsistencySelector()

public ListCollectionIdsRequest.Builder clearConsistencySelector()
Returns
TypeDescription
ListCollectionIdsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ListCollectionIdsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListCollectionIdsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

clearPageSize()

public ListCollectionIdsRequest.Builder clearPageSize()

The maximum number of results to return.

int32 page_size = 2;

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

clearPageToken()

public ListCollectionIdsRequest.Builder clearPageToken()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

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
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

clearReadTime()

public ListCollectionIdsRequest.Builder clearReadTime()

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

.google.protobuf.Timestamp read_time = 4;

Returns
TypeDescription
ListCollectionIdsRequest.Builder

clone()

public ListCollectionIdsRequest.Builder clone()
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

getConsistencySelectorCase()

public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
ListCollectionIdsRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public ListCollectionIdsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListCollectionIdsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

The maximum number of results to return.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getReadTime()

public 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
TypeDescription
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

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

.google.protobuf.Timestamp read_time = 4;

Returns
TypeDescription
Builder

getReadTimeOrBuilder()

public 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;

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
boolean

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListCollectionIdsRequest other)

public ListCollectionIdsRequest.Builder mergeFrom(ListCollectionIdsRequest other)
Parameter
NameDescription
otherListCollectionIdsRequest
Returns
TypeDescription
ListCollectionIdsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListCollectionIdsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListCollectionIdsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

mergeReadTime(Timestamp value)

public ListCollectionIdsRequest.Builder mergeReadTime(Timestamp value)

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

.google.protobuf.Timestamp read_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ListCollectionIdsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListCollectionIdsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListCollectionIdsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

setPageSize(int value)

public ListCollectionIdsRequest.Builder setPageSize(int value)

The maximum number of results to return.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCollectionIdsRequest.Builder setPageToken(String value)

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCollectionIdsRequest.Builder setPageTokenBytes(ByteString value)

A page token. Must be a value from ListCollectionIdsResponse.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListCollectionIdsRequest.Builder

This builder for chaining.

setReadTime(Timestamp value)

public ListCollectionIdsRequest.Builder setReadTime(Timestamp value)

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

.google.protobuf.Timestamp read_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ListCollectionIdsRequest.Builder

setReadTime(Timestamp.Builder builderForValue)

public ListCollectionIdsRequest.Builder setReadTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp read_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListCollectionIdsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListCollectionIdsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListCollectionIdsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCollectionIdsRequest.Builder
Overrides