Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class FirestoreDatabaseReference.
Message representing a reference to a single Firestore database.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.FirestoreDatabaseReference
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. Project the firestore database belongs to. |
↳ database_id |
string
Required. The database id. |
↳ collection_ids |
string[]
Optional. The collection ids. Denotes all collections if unset. |
↳ database_table_references |
array<DatabaseTableReference>
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. |
getProjectId
Required. Project the firestore database belongs to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
Required. Project the firestore database belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
Required. The database id.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
Required. The database id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollectionIds
Optional. The collection ids. Denotes all collections if unset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setCollectionIds
Optional. The collection ids. Denotes all collections if unset.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseTableReferences
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<DatabaseTableReference> |
|
setDatabaseTableReferences
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DatabaseTableReference>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|