Google Cloud Discovery Engine V1 Client - Class ImportDocumentsRequest (1.3.2)

Version latest

• 1.3.2 (latest)
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ImportDocumentsRequest.

Request message for Import methods.

Generated from protobuf message google.cloud.discoveryengine.v1.ImportDocumentsRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ inline_source	ImportDocumentsRequest\InlineSource The Inline source for the input content for documents.
↳ gcs_source	GcsSource Cloud Storage location for the input content.
↳ bigquery_source	BigQuerySource BigQuery input source.
↳ fhir_store_source	FhirStoreSource FhirStore input source.
↳ spanner_source	SpannerSource Spanner input source.
↳ cloud_sql_source	CloudSqlSource Cloud SQL input source.
↳ firestore_source	FirestoreSource Firestore input source.
↳ alloy_db_source	AlloyDbSource AlloyDB input source.
↳ bigtable_source	BigtableSource Cloud Bigtable input source.
↳ parent	string Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.
↳ error_config	ImportErrorConfig The desired location of errors incurred during the Import.
↳ reconciliation_mode	int The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
↳ update_mask	Google\Protobuf\FieldMask Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
↳ auto_generate_ids	bool Whether to automatically generate IDs for the documents if absent. If set to true, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to false, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * * GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown. * * BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown. * * SpannerSource. * * CloudSqlSource. * * FirestoreSource. * * BigtableSource.
↳ id_field	string The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, my_id for JSON {"my_id": "some_uuid"}. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as false. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value _id is used when importing from the allowed data sources. Supported data sources: * * GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown. * * BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown. * * SpannerSource. * * CloudSqlSource. * * FirestoreSource. * * BigtableSource.

getInlineSource

The Inline source for the input content for documents.

Returns
Type	Description
ImportDocumentsRequest\InlineSource|null

hasInlineSource

setInlineSource

The Inline source for the input content for documents.

Parameter
Name	Description
var	ImportDocumentsRequest\InlineSource

Returns
Type	Description
$this

getGcsSource

Cloud Storage location for the input content.

Returns
Type	Description
GcsSource|null

hasGcsSource

setGcsSource

Cloud Storage location for the input content.

Parameter
Name	Description
var	GcsSource

Returns
Type	Description
$this

getBigquerySource

BigQuery input source.

Returns
Type	Description
BigQuerySource|null

hasBigquerySource

setBigquerySource

BigQuery input source.

Parameter
Name	Description
var	BigQuerySource

Returns
Type	Description
$this

getFhirStoreSource

FhirStore input source.

Returns
Type	Description
FhirStoreSource|null

hasFhirStoreSource

setFhirStoreSource

FhirStore input source.

Parameter
Name	Description
var	FhirStoreSource

Returns
Type	Description
$this

getSpannerSource

Spanner input source.

Returns
Type	Description
SpannerSource|null

hasSpannerSource

setSpannerSource

Spanner input source.

Parameter
Name	Description
var	SpannerSource

Returns
Type	Description
$this

getCloudSqlSource

Cloud SQL input source.

Returns
Type	Description
CloudSqlSource|null

hasCloudSqlSource

setCloudSqlSource

Cloud SQL input source.

Parameter
Name	Description
var	CloudSqlSource

Returns
Type	Description
$this

getFirestoreSource

Firestore input source.

Returns
Type	Description
FirestoreSource|null

hasFirestoreSource

setFirestoreSource

Firestore input source.

Parameter
Name	Description
var	FirestoreSource

Returns
Type	Description
$this

getAlloyDbSource

AlloyDB input source.

Returns
Type	Description
AlloyDbSource|null

hasAlloyDbSource

setAlloyDbSource

AlloyDB input source.

Parameter
Name	Description
var	AlloyDbSource

Returns
Type	Description
$this

getBigtableSource

Cloud Bigtable input source.

Returns
Type	Description
BigtableSource|null

hasBigtableSource

setBigtableSource

Cloud Bigtable input source.

Parameter
Name	Description
var	BigtableSource

Returns
Type	Description
$this

getParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Requires create/update permission.

Returns
Type	Description
string

setParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Requires create/update permission.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getErrorConfig

The desired location of errors incurred during the Import.

Returns
Type	Description
ImportErrorConfig|null

hasErrorConfig

clearErrorConfig

setErrorConfig

The desired location of errors incurred during the Import.

Parameter
Name	Description
var	ImportErrorConfig

Returns
Type	Description
$this

getReconciliationMode

The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns
Type	Description
int

setReconciliationMode

The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getUpdateMask

Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getAutoGenerateIds

Whether to automatically generate IDs for the documents if absent.

If set to true, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to false, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources:

• GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• SpannerSource.
• CloudSqlSource.
• FirestoreSource.
• BigtableSource.

Returns
Type	Description
bool

setAutoGenerateIds

Whether to automatically generate IDs for the documents if absent.

If set to true, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to false, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources:

• GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• SpannerSource.
• CloudSqlSource.
• FirestoreSource.
• BigtableSource.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getIdField

The field indicates the ID field or column to be used as unique IDs of the documents.

For GcsSource it is the key of the JSON field. For instance, my_id for JSON {"my_id": "some_uuid"}. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as false. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value _id is used when importing from the allowed data sources. Supported data sources:

• GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• SpannerSource.
• CloudSqlSource.
• FirestoreSource.
• BigtableSource.

Returns
Type	Description
string

setIdField

The field indicates the ID field or column to be used as unique IDs of the documents.

For GcsSource it is the key of the JSON field. For instance, my_id for JSON {"my_id": "some_uuid"}. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as false. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value _id is used when importing from the allowed data sources. Supported data sources:

• GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• SpannerSource.
• CloudSqlSource.
• FirestoreSource.
• BigtableSource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSource

Returns
Type	Description
string