Class: Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/import_config.rb

Overview

Request message for Import methods.

Defined Under Namespace

Modules: ReconciliationMode Classes: InlineSource

Instance Attribute Summary collapse

Instance Attribute Details

#alloy_db_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::AlloyDbSource

Returns AlloyDB input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#auto_generate_ids ⇒ ::Boolean

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

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#bigquery_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::BigQuerySource

Returns BigQuery input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#bigtable_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::BigtableSource

Returns Cloud Bigtable input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#cloud_sql_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource

Returns Cloud SQL input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#error_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig

Returns The desired location of errors incurred during the Import.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#fhir_store_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource

Returns FhirStore input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#firestore_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::FirestoreSource

Returns Firestore input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#gcs_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GcsSource

Returns Cloud Storage location for the input content.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#id_field ⇒ ::String

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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#inline_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource

Returns The Inline source for the input content for documents.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#parent ⇒ ::String

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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#reconciliation_mode ⇒ ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode

Returns The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#spanner_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::SpannerSource

Returns Spanner input source.

Returns:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 626

class ImportDocumentsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The inline source for the input config for ImportDocuments method.
  # @!attribute [rw] documents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document>]
  #     Required. A list of documents to update/create. Each document must have a
  #     valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
  #     Recommended max of 100 items.
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates how imported documents are reconciled with the existing documents
  # created or imported before.
  module ReconciliationMode
    # Defaults to `INCREMENTAL`.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new documents or updates existing documents.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire document dataset. Existing
    # documents may be deleted if they are not present in the source location.
    FULL = 2
  end
end