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()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListCollectionIdsRequest.Builder |
build()
public ListCollectionIdsRequest build()| Type | Description |
| ListCollectionIdsRequest |
buildPartial()
public ListCollectionIdsRequest buildPartial()| Type | Description |
| ListCollectionIdsRequest |
clear()
public ListCollectionIdsRequest.Builder clear()| Type | Description |
| ListCollectionIdsRequest.Builder |
clearConsistencySelector()
public ListCollectionIdsRequest.Builder clearConsistencySelector()| Type | Description |
| ListCollectionIdsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListCollectionIdsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ListCollectionIdsRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListCollectionIdsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ListCollectionIdsRequest.Builder |
clearPageSize()
public ListCollectionIdsRequest.Builder clearPageSize()The maximum number of results to return.
int32 page_size = 2;
| 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;
| 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];
| 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;
| Type | Description |
| ListCollectionIdsRequest.Builder |
clone()
public ListCollectionIdsRequest.Builder clone()| Type | Description |
| ListCollectionIdsRequest.Builder |
getConsistencySelectorCase()
public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
| ListCollectionIdsRequest.ConsistencySelectorCase |
getDefaultInstanceForType()
public ListCollectionIdsRequest getDefaultInstanceForType()| Type | Description |
| ListCollectionIdsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getPageSize()
public int getPageSize()The maximum number of results to return.
int32 page_size = 2;
| Type | Description |
| int | The pageSize. |
getPageToken()
public String getPageToken()A page token. Must be a value from ListCollectionIdsResponse.
string page_token = 3;
| Type | Description |
| String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()A page token. Must be a value from ListCollectionIdsResponse.
string page_token = 3;
| 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];
| 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];
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the readTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(ListCollectionIdsRequest other)
public ListCollectionIdsRequest.Builder mergeFrom(ListCollectionIdsRequest other)| Name | Description |
| other | ListCollectionIdsRequest |
| Type | Description |
| ListCollectionIdsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListCollectionIdsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ListCollectionIdsRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| 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;
| Name | Description |
| value | Timestamp |
| Type | Description |
| ListCollectionIdsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListCollectionIdsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListCollectionIdsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListCollectionIdsRequest.Builder |
setPageSize(int value)
public ListCollectionIdsRequest.Builder setPageSize(int value)The maximum number of results to return.
int32 page_size = 2;
| Name | Description |
| value | intThe pageSize to set. |
| 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;
| Name | Description |
| value | StringThe pageToken to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| 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];
| Name | Description |
| value | StringThe parent to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| 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;
| Name | Description |
| value | Timestamp |
| 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;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| ListCollectionIdsRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListCollectionIdsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ListCollectionIdsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListCollectionIdsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListCollectionIdsRequest.Builder |