public final class ListCollectionIdsRequest extends GeneratedMessageV3 implements ListCollectionIdsRequestOrBuilderThe request for Firestore.ListCollectionIds.
Protobuf type google.firestore.v1.ListCollectionIdsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListCollectionIdsRequestImplements
ListCollectionIdsRequestOrBuilderStatic Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER| Type | Description |
| int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Type | Description |
| int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Type | Description |
| int |
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static ListCollectionIdsRequest getDefaultInstance()| Type | Description |
| ListCollectionIdsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static ListCollectionIdsRequest.Builder newBuilder()| Type | Description |
| ListCollectionIdsRequest.Builder |
newBuilder(ListCollectionIdsRequest prototype)
public static ListCollectionIdsRequest.Builder newBuilder(ListCollectionIdsRequest prototype)| Name | Description |
| prototype | ListCollectionIdsRequest |
| Type | Description |
| ListCollectionIdsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ListCollectionIdsRequest parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListCollectionIdsRequest parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListCollectionIdsRequest parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ListCollectionIdsRequest parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ListCollectionIdsRequest parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListCollectionIdsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListCollectionIdsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ListCollectionIdsRequest> parser()| Type | Description |
| Parser<ListCollectionIdsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getConsistencySelectorCase()
public ListCollectionIdsRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
| ListCollectionIdsRequest.ConsistencySelectorCase |
getDefaultInstanceForType()
public ListCollectionIdsRequest getDefaultInstanceForType()| Type | Description |
| ListCollectionIdsRequest |
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. |
getParserForType()
public Parser<ListCollectionIdsRequest> getParserForType()| Type | Description |
| Parser<ListCollectionIdsRequest> |
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. |
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 |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
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. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public ListCollectionIdsRequest.Builder newBuilderForType()| Type | Description |
| ListCollectionIdsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListCollectionIdsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ListCollectionIdsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public ListCollectionIdsRequest.Builder toBuilder()| Type | Description |
| ListCollectionIdsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |