Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class FirestoreSource.
Firestore source import data from.
Generated from protobuf message google.cloud.discoveryengine.v1.FirestoreSource
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
โณ project_id
string
The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
โณ database_id
string
Required. The Firestore database to copy the data from with a length limit of 256 characters.
โณ collection_id
string
Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.
โณ gcs_staging_dir
string
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
getProjectId
The project ID that the Cloud SQL source is in with a length limit of 128
characters. If not specified, inherits the project ID from the parent
request.
Returns
Type
Description
string
setProjectId
The project ID that the Cloud SQL source is in with a length limit of 128
characters. If not specified, inherits the project ID from the parent
request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDatabaseId
Required. The Firestore database to copy the data from with a length limit
of 256 characters.
Returns
Type
Description
string
setDatabaseId
Required. The Firestore database to copy the data from with a length limit
of 256 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCollectionId
Required. The Firestore collection (or entity) to copy the data from with a
length limit of 1,500 characters.
Returns
Type
Description
string
setCollectionId
Required. The Firestore collection (or entity) to copy the data from with a
length limit of 1,500 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getGcsStagingDir
Intermediate Cloud Storage directory used for the import with a length
limit of 2,000 characters. Can be specified if one wants to have the
Firestore export to a specific Cloud Storage directory.
Ensure that the Firestore service account has the necessary Cloud
Storage Admin permissions to access the specified Cloud Storage directory.
Returns
Type
Description
string
setGcsStagingDir
Intermediate Cloud Storage directory used for the import with a length
limit of 2,000 characters. Can be specified if one wants to have the
Firestore export to a specific Cloud Storage directory.
Ensure that the Firestore service account has the necessary Cloud
Storage Admin permissions to access the specified Cloud Storage directory.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class FirestoreSource (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.FirestoreSource)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.FirestoreSource)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.FirestoreSource)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.FirestoreSource)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.FirestoreSource)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.FirestoreSource)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.FirestoreSource)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.FirestoreSource)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.FirestoreSource)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.FirestoreSource)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.FirestoreSource)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.FirestoreSource)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.FirestoreSource)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.FirestoreSource)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.FirestoreSource)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.FirestoreSource)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.FirestoreSource) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class FirestoreSource.\n\nFirestore source import data from.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.FirestoreSource`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProjectId\n\nThe project ID that the Cloud SQL source is in with a length limit of 128\ncharacters. If not specified, inherits the project ID from the parent\nrequest.\n\n### setProjectId\n\nThe project ID that the Cloud SQL source is in with a length limit of 128\ncharacters. If not specified, inherits the project ID from the parent\nrequest.\n\n### getDatabaseId\n\nRequired. The Firestore database to copy the data from with a length limit\nof 256 characters.\n\n### setDatabaseId\n\nRequired. The Firestore database to copy the data from with a length limit\nof 256 characters.\n\n### getCollectionId\n\nRequired. The Firestore collection (or entity) to copy the data from with a\nlength limit of 1,500 characters.\n\n### setCollectionId\n\nRequired. The Firestore collection (or entity) to copy the data from with a\nlength limit of 1,500 characters.\n\n### getGcsStagingDir\n\nIntermediate Cloud Storage directory used for the import with a length\nlimit of 2,000 characters. Can be specified if one wants to have the\nFirestore export to a specific Cloud Storage directory.\n\nEnsure that the Firestore service account has the necessary Cloud\nStorage Admin permissions to access the specified Cloud Storage directory.\n\n### setGcsStagingDir\n\nIntermediate Cloud Storage directory used for the import with a length\nlimit of 2,000 characters. Can be specified if one wants to have the\nFirestore export to a specific Cloud Storage directory.\n\nEnsure that the Firestore service account has the necessary Cloud\nStorage Admin permissions to access the specified Cloud Storage directory."]]
