Class FirestoreDatabaseReference (0.27.0)

public final class FirestoreDatabaseReference extends GeneratedMessage implements FirestoreDatabaseReferenceOrBuilder

Message representing a reference to a single Firestore database.

Protobuf type google.cloud.geminidataanalytics.v1beta.FirestoreDatabaseReference

Static Fields

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_TABLE_REFERENCES_FIELD_NUMBER

public static final int DATABASE_TABLE_REFERENCES_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FirestoreDatabaseReference getDefaultInstance()
Returns
Type Description
FirestoreDatabaseReference

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FirestoreDatabaseReference.Builder newBuilder()
Returns
Type Description
FirestoreDatabaseReference.Builder

newBuilder(FirestoreDatabaseReference prototype)

public static FirestoreDatabaseReference.Builder newBuilder(FirestoreDatabaseReference prototype)
Parameter
Name Description
prototype FirestoreDatabaseReference
Returns
Type Description
FirestoreDatabaseReference.Builder

parseDelimitedFrom(InputStream input)

public static FirestoreDatabaseReference parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FirestoreDatabaseReference parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirestoreDatabaseReference parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirestoreDatabaseReference parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FirestoreDatabaseReference parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FirestoreDatabaseReference parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirestoreDatabaseReference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreDatabaseReference
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FirestoreDatabaseReference> parser()
Returns
Type Description
Parser<FirestoreDatabaseReference>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollectionIds(int index)

public String getCollectionIds(int index)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The collectionIds at the given index.

getCollectionIdsBytes(int index)

public ByteString getCollectionIdsBytes(int index)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public int getCollectionIdsCount()

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the collectionIds.

getDatabaseId()

public String getDatabaseId()

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for databaseId.

getDatabaseTableReferences(int index)

public DatabaseTableReference getDatabaseTableReferences(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReference

getDatabaseTableReferencesCount()

public int getDatabaseTableReferencesCount()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDatabaseTableReferencesList()

public List<DatabaseTableReference> getDatabaseTableReferencesList()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DatabaseTableReference>

getDatabaseTableReferencesOrBuilder(int index)

public DatabaseTableReferenceOrBuilder getDatabaseTableReferencesOrBuilder(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReferenceOrBuilder

getDatabaseTableReferencesOrBuilderList()

public List<? extends DatabaseTableReferenceOrBuilder> getDatabaseTableReferencesOrBuilderList()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.DatabaseTableReferenceOrBuilder>

getDefaultInstanceForType()

public FirestoreDatabaseReference getDefaultInstanceForType()
Returns
Type Description
FirestoreDatabaseReference

getParserForType()

public Parser<FirestoreDatabaseReference> getParserForType()
Returns
Type Description
Parser<FirestoreDatabaseReference>
Overrides

getProjectId()

public String getProjectId()

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FirestoreDatabaseReference.Builder newBuilderForType()
Returns
Type Description
FirestoreDatabaseReference.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected FirestoreDatabaseReference.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FirestoreDatabaseReference.Builder
Overrides

toBuilder()

public FirestoreDatabaseReference.Builder toBuilder()
Returns
Type Description
FirestoreDatabaseReference.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException