Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest (v0.8.0)

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

Request message for Import methods.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_generate_ids

def auto_generate_ids() -> ::Boolean
Returns

#auto_generate_ids=

def auto_generate_ids=(value) -> ::Boolean
Parameter
Returns

#bigquery_source

def bigquery_source() -> ::Google::Cloud::DiscoveryEngine::V1::BigQuerySource
Returns

#bigquery_source=

def bigquery_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BigQuerySource
Parameter
Returns

#bigtable_source

def bigtable_source() -> ::Google::Cloud::DiscoveryEngine::V1::BigtableSource
Returns

#bigtable_source=

def bigtable_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BigtableSource
Parameter
Returns

#cloud_sql_source

def cloud_sql_source() -> ::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource
Returns

#cloud_sql_source=

def cloud_sql_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource
Parameter
Returns

#error_config

def error_config() -> ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig
Returns

#error_config=

def error_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig
Parameter
Returns

#fhir_store_source

def fhir_store_source() -> ::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource
Returns

#fhir_store_source=

def fhir_store_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource
Parameter
Returns

#firestore_source

def firestore_source() -> ::Google::Cloud::DiscoveryEngine::V1::FirestoreSource
Returns

#firestore_source=

def firestore_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::FirestoreSource
Parameter
Returns

#gcs_source

def gcs_source() -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource
Returns

#gcs_source=

def gcs_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource
Parameter
Returns

#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:

#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:

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:

#inline_source

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

#inline_source=

def inline_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource
Parameter
Returns

#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::V1::ImportDocumentsRequest::ReconciliationMode
Returns

#reconciliation_mode=

def reconciliation_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode
Parameter
Returns

#spanner_source

def spanner_source() -> ::Google::Cloud::DiscoveryEngine::V1::SpannerSource
Returns

#spanner_source=

def spanner_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SpannerSource
Parameter
Returns

#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.