public static final class ListCollectionIdsRequest.Builder extends GeneratedMessageV3.Builder<ListCollectionIdsRequest.Builder> implements ListCollectionIdsRequestOrBuilderThe request for Firestore.ListCollectionIds.
Protobuf type google.firestore.v1.ListCollectionIdsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListCollectionIdsRequest.BuilderImplements
ListCollectionIdsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
build()
public ListCollectionIdsRequest build()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest |
|
buildPartial()
public ListCollectionIdsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest |
|
clear()
public ListCollectionIdsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
clearConsistencySelector()
public ListCollectionIdsRequest.Builder clearConsistencySelector()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListCollectionIdsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ListCollectionIdsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
clearPageSize()
public ListCollectionIdsRequest.Builder clearPageSize()The maximum number of results to return.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
clone()
public ListCollectionIdsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
getConsistencySelectorCase()
public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.ConsistencySelectorCase |
|
getDefaultInstanceForType()
public ListCollectionIdsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the readTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListCollectionIdsRequest other)
public ListCollectionIdsRequest.Builder mergeFrom(ListCollectionIdsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListCollectionIdsRequest |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListCollectionIdsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListCollectionIdsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
setPageSize(int value)
public ListCollectionIdsRequest.Builder setPageSize(int value)The maximum number of results to return.
int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListCollectionIdsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListCollectionIdsRequest.Builder |
|