Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Request message for Import methods.
Instance Attribute Summary collapse
-
#auto_generate_ids ⇒ Boolean
(also: #auto_generate_ids?)
Whether to automatically generate IDs for the documents if absent.
-
#bigquery_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource
BigQuery source import data from.
-
#error_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig
Configuration of destination for Import related errors.
-
#gcs_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource
Cloud Storage location for input content.
-
#id_field ⇒ String
The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents.
-
#inline_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource
The inline source for the input config for ImportDocuments method.
-
#reconciliation_mode ⇒ String
The mode of reconciliation between existing documents and the documents to be imported.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest
Returns a new instance of GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.
1623 1624 1625 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1623 def initialize(**args) update!(**args) end |
Instance Attribute Details
#auto_generate_ids ⇒ Boolean Also known as: auto_generate_ids?
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. Only set this field when
using GcsSource or BigQuerySource, and when GcsSource.data_schema or
BigQuerySource.data_schema is custom
or csv
. Otherwise, an
INVALID_ARGUMENT error is thrown.
Corresponds to the JSON property autoGenerateIds
1577 1578 1579 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1577 def auto_generate_ids @auto_generate_ids end |
#bigquery_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource
BigQuery source import data from.
Corresponds to the JSON property bigquerySource
1583 1584 1585 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1583 def bigquery_source @bigquery_source end |
#error_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig
Configuration of destination for Import related errors.
Corresponds to the JSON property errorConfig
1588 1589 1590 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1588 def error_config @error_config end |
#gcs_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource
Cloud Storage location for input content.
Corresponds to the JSON property gcsSource
1593 1594 1595 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1593 def gcs_source @gcs_source end |
#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 are 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 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.
Corresponds to the JSON property idField
1610 1611 1612 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1610 def id_field @id_field end |
#inline_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource
The inline source for the input config for ImportDocuments method.
Corresponds to the JSON property inlineSource
1615 1616 1617 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1615 def inline_source @inline_source end |
#reconciliation_mode ⇒ String
The mode of reconciliation between existing documents and the documents to be
imported. Defaults to ReconciliationMode.INCREMENTAL.
Corresponds to the JSON property reconciliationMode
1621 1622 1623 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1621 def reconciliation_mode @reconciliation_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1628 1629 1630 1631 1632 1633 1634 1635 1636 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1628 def update!(**args) @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids) @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source) @error_config = args[:error_config] if args.key?(:error_config) @gcs_source = args[:gcs_source] if args.key?(:gcs_source) @id_field = args[:id_field] if args.key?(:id_field) @inline_source = args[:inline_source] if args.key?(:inline_source) @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode) end |