Class ListCollectionIdsResponse (3.1.0)

public final class ListCollectionIdsResponse extends GeneratedMessageV3 implements ListCollectionIdsResponseOrBuilder

The response from Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsResponse

Static Fields

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListCollectionIdsResponse getDefaultInstance()
Returns
TypeDescription
ListCollectionIdsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListCollectionIdsResponse.Builder newBuilder()
Returns
TypeDescription
ListCollectionIdsResponse.Builder

newBuilder(ListCollectionIdsResponse prototype)

public static ListCollectionIdsResponse.Builder newBuilder(ListCollectionIdsResponse prototype)
Parameter
NameDescription
prototypeListCollectionIdsResponse
Returns
TypeDescription
ListCollectionIdsResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListCollectionIdsResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListCollectionIdsResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCollectionIdsResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCollectionIdsResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListCollectionIdsResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListCollectionIdsResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCollectionIdsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCollectionIdsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListCollectionIdsResponse> parser()
Returns
TypeDescription
Parser<ListCollectionIdsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCollectionIds(int index)

public String getCollectionIds(int index)

The collection ids.

repeated string collection_ids = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The collectionIds at the given index.

getCollectionIdsBytes(int index)

public ByteString getCollectionIdsBytes(int index)

The collection ids.

repeated string collection_ids = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public int getCollectionIdsCount()

The collection ids.

repeated string collection_ids = 1;

Returns
TypeDescription
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

The collection ids.

repeated string collection_ids = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ListCollectionIdsResponse getDefaultInstanceForType()
Returns
TypeDescription
ListCollectionIdsResponse

getNextPageToken()

public String getNextPageToken()

A page token that may be used to continue the list.

string next_page_token = 2;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

A page token that may be used to continue the list.

string next_page_token = 2;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<ListCollectionIdsResponse> getParserForType()
Returns
TypeDescription
Parser<ListCollectionIdsResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListCollectionIdsResponse.Builder newBuilderForType()
Returns
TypeDescription
ListCollectionIdsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListCollectionIdsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListCollectionIdsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListCollectionIdsResponse.Builder toBuilder()
Returns
TypeDescription
ListCollectionIdsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException