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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ inline_source | Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSourceThe Inline source for the input content for documents. |
↳ gcs_source | Google\Cloud\DiscoveryEngine\V1\GcsSourceCloud Storage location for the input content. |
↳ bigquery_source | Google\Cloud\DiscoveryEngine\V1\BigQuerySourceBigQuery input source. |
↳ parent | stringRequired. The parent branch resource name, such as |
↳ error_config | Google\Cloud\DiscoveryEngine\V1\ImportErrorConfigThe desired location of errors incurred during the Import. |
↳ reconciliation_mode | intThe mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. |
↳ auto_generate_ids | boolWhether to automatically generate IDs for the documents if absent. If set to |
↳ id_field | stringThe field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, |
getInlineSource
The Inline source for the input content for documents.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource|null | |
hasInlineSource
setInlineSource
The Inline source for the input content for documents.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource |
| Returns | |
|---|---|
| Type | Description |
$this | |
getGcsSource
Cloud Storage location for the input content.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\GcsSource|null | |
hasGcsSource
setGcsSource
Cloud Storage location for the input content.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1\GcsSource |
| Returns | |
|---|---|
| Type | Description |
$this | |
getBigquerySource
BigQuery input source.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\BigQuerySource|null | |
hasBigquerySource
setBigquerySource
BigQuery input source.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1\BigQuerySource |
| 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 |
Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig|null | |
hasErrorConfig
clearErrorConfig
setErrorConfig
The desired location of errors incurred during the Import.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1\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 | |
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, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown.
| 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, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getIdField
The field in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be used as the Document.ids. The JSON field or the BigQuery 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setIdField
The field in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be used as the Document.ids. The JSON field or the BigQuery 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |