ImportDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for Import methods.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
inline_source |
google.cloud.discoveryengine_v1beta.types.ImportDocumentsRequest.InlineSource
The Inline source for the input content for documents. This field is a member of oneof_ source.
|
gcs_source |
google.cloud.discoveryengine_v1beta.types.GcsSource
Cloud Storage location for the input content. This field is a member of oneof_ source.
|
bigquery_source |
google.cloud.discoveryengine_v1beta.types.BigQuerySource
BigQuery input source. This field is a member of oneof_ source.
|
fhir_store_source |
google.cloud.discoveryengine_v1beta.types.FhirStoreSource
FhirStore input source. This field is a member of oneof_ source.
|
spanner_source |
google.cloud.discoveryengine_v1beta.types.SpannerSource
Spanner input source. This field is a member of oneof_ source.
|
cloud_sql_source |
google.cloud.discoveryengine_v1beta.types.CloudSqlSource
Cloud SQL input source. This field is a member of oneof_ source.
|
firestore_source |
google.cloud.discoveryengine_v1beta.types.FirestoreSource
Firestore input source. This field is a member of oneof_ source.
|
alloy_db_source |
google.cloud.discoveryengine_v1beta.types.AlloyDbSource
AlloyDB input source. This field is a member of oneof_ source.
|
bigtable_source |
google.cloud.discoveryengine_v1beta.types.BigtableSource
Cloud Bigtable input source. This field is a member of oneof_ source.
|
parent |
str
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_v1beta.types.ImportErrorConfig
The desired location of errors incurred during the Import. |
reconciliation_mode |
google.cloud.discoveryengine_v1beta.types.ImportDocumentsRequest.ReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. |
update_mask |
google.protobuf.field_mask_pb2.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 |
str
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.
|
Classes
InlineSource
InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)The inline source for the input config for ImportDocuments method.
ReconciliationMode
ReconciliationMode(value)Indicates how imported documents are reconciled with the existing documents created or imported before.