Google Cloud Discovery Engine V1 Client - Class FirestoreSource (0.11.3)

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.

Parameter
Name Description
var string
Returns
Type Description
$this