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.
data
array
Optional. Data for populating the Message object.
↳ inline_source
Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource
The Inline source for the input content for documents.
↳ gcs_source
↳ bigquery_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
Google\Cloud\DiscoveryEngine\V1\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 .
↳ auto_generate_ids
bool
Whether to automatically generate IDs for the documents if absent. If set to true
, Document.id
s 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.id
s 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.
↳ id_field
string
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.id
s. 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.
getInlineSource
The Inline source for the input content for documents.
hasInlineSource
setInlineSource
The Inline source for the input content for documents.
$this
getGcsSource
Cloud Storage location for the input content.
hasGcsSource
setGcsSource
Cloud Storage location for the input content.
$this
getBigquerySource
BigQuery input source.
hasBigquerySource
setBigquerySource
BigQuery input source.
$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.
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.
var
string
$this
getErrorConfig
The desired location of errors incurred during the Import.
hasErrorConfig
clearErrorConfig
setErrorConfig
The desired location of errors incurred during the Import.
$this
getReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL .
int
setReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL .
var
int
$this
getAutoGenerateIds
Whether to automatically generate IDs for the documents if absent.
If set to true
, Document.id
s 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.id
s 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.
bool
setAutoGenerateIds
Whether to automatically generate IDs for the documents if absent.
If set to true
, Document.id
s 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.id
s 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.
var
bool
$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.id
s. 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.
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.id
s. 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.
var
string
$this
getSource
string
