Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest (v0.18.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest.

Request message for Import methods.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#alloy_db_source

def alloy_db_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource) — AlloyDB input source.

Note: The following fields are mutually exclusive: alloy_db_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#alloy_db_source=

def alloy_db_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource) — AlloyDB input source.

Note: The following fields are mutually exclusive: alloy_db_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::AlloyDbSource) — AlloyDB input source.

Note: The following fields are mutually exclusive: alloy_db_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#auto_generate_ids

def auto_generate_ids() -> ::Boolean

Returns

(::Boolean) —
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.

#auto_generate_ids=

def auto_generate_ids=(value) -> ::Boolean

Parameter

value (::Boolean) —
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

(::Boolean) —
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.

#bigquery_source

def bigquery_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource) — BigQuery input source.

Note: The following fields are mutually exclusive: bigquery_source, inline_source, gcs_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bigquery_source=

def bigquery_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource) — BigQuery input source.

Note: The following fields are mutually exclusive: bigquery_source, inline_source, gcs_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource) — BigQuery input source.

Note: The following fields are mutually exclusive: bigquery_source, inline_source, gcs_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bigtable_source

def bigtable_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource) — Cloud Bigtable input source.

Note: The following fields are mutually exclusive: bigtable_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bigtable_source=

def bigtable_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource) — Cloud Bigtable input source.

Note: The following fields are mutually exclusive: bigtable_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::BigtableSource) — Cloud Bigtable input source.

Note: The following fields are mutually exclusive: bigtable_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_sql_source

def cloud_sql_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource) — Cloud SQL input source.

Note: The following fields are mutually exclusive: cloud_sql_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_sql_source=

def cloud_sql_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource) — Cloud SQL input source.

Note: The following fields are mutually exclusive: cloud_sql_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::CloudSqlSource) — Cloud SQL input source.

Note: The following fields are mutually exclusive: cloud_sql_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#error_config

def error_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig) — The desired location of errors incurred during the Import.

#error_config=

def error_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig) — The desired location of errors incurred during the Import.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig) — The desired location of errors incurred during the Import.

#fhir_store_source

def fhir_store_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource) — FhirStore input source.

Note: The following fields are mutually exclusive: fhir_store_source, inline_source, gcs_source, bigquery_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#fhir_store_source=

def fhir_store_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource) — FhirStore input source.

Note: The following fields are mutually exclusive: fhir_store_source, inline_source, gcs_source, bigquery_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::FhirStoreSource) — FhirStore input source.

Note: The following fields are mutually exclusive: fhir_store_source, inline_source, gcs_source, bigquery_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#firestore_source

def firestore_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource) — Firestore input source.

Note: The following fields are mutually exclusive: firestore_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#firestore_source=

def firestore_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource) — Firestore input source.

Note: The following fields are mutually exclusive: firestore_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::FirestoreSource) — Firestore input source.

Note: The following fields are mutually exclusive: firestore_source, inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_source

def gcs_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::GcsSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::GcsSource) — Cloud Storage location for the input content.

Note: The following fields are mutually exclusive: gcs_source, inline_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_source=

def gcs_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::GcsSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::GcsSource) — Cloud Storage location for the input content.

Note: The following fields are mutually exclusive: gcs_source, inline_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::GcsSource) — Cloud Storage location for the input content.

Note: The following fields are mutually exclusive: gcs_source, inline_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#id_field

def id_field() -> ::String

Returns

(::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.

#id_field=

def id_field=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#inline_source

def inline_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource) — The Inline source for the input content for documents.

Note: The following fields are mutually exclusive: inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inline_source=

def inline_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource) — The Inline source for the input content for documents.

Note: The following fields are mutually exclusive: inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::InlineSource) — The Inline source for the input content for documents.

Note: The following fields are mutually exclusive: inline_source, gcs_source, bigquery_source, fhir_store_source, spanner_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#parent

def parent() -> ::String

Returns

(::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

Returns

(::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

#reconciliation_mode

def reconciliation_mode() -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode) — The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

#reconciliation_mode=

def reconciliation_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode) — The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode) — The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

#spanner_source

def spanner_source() -> ::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource) — Spanner input source.

Note: The following fields are mutually exclusive: spanner_source, inline_source, gcs_source, bigquery_source, fhir_store_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#spanner_source=

def spanner_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource) — Spanner input source.

Note: The following fields are mutually exclusive: spanner_source, inline_source, gcs_source, bigquery_source, fhir_store_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SpannerSource) — Spanner input source.

Note: The following fields are mutually exclusive: spanner_source, inline_source, gcs_source, bigquery_source, fhir_store_source, cloud_sql_source, firestore_source, alloy_db_source, bigtable_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask

Returns

(::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.

Returns

(::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.