Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Request message for Import methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaImportDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1betaImportDocumentsRequest.



16740
16741
16742
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16740

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#alloy_db_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAlloyDbSource

AlloyDB source import data from. Corresponds to the JSON property alloyDbSource

Returns:



16647
16648
16649
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16647

def alloy_db_source
  @alloy_db_source
end

#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. 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. Corresponds to the JSON property autoGenerateIds

Returns:

  • (Boolean) 


16661
16662
16663
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16661

def auto_generate_ids
  @auto_generate_ids
end

#bigquery_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource

BigQuery source import data from. Corresponds to the JSON property bigquerySource

Returns:



16667
16668
16669
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16667

def bigquery_source
  @bigquery_source
end

#bigtable_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigtableSource

The Cloud Bigtable source for importing data. Corresponds to the JSON property bigtableSource

Returns:



16672
16673
16674
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16672

def bigtable_source
  @bigtable_source
end

#cloud_sql_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCloudSqlSource

Cloud SQL source import data from. Corresponds to the JSON property cloudSqlSource

Returns:



16677
16678
16679
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16677

def cloud_sql_source
  @cloud_sql_source
end

#error_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig

Configuration of destination for Import related errors. Corresponds to the JSON property errorConfig

Returns:



16682
16683
16684
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16682

def error_config
  @error_config
end

#fhir_store_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFhirStoreSource

Cloud FhirStore source import data from. Corresponds to the JSON property fhirStoreSource

Returns:



16687
16688
16689
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16687

def fhir_store_source
  @fhir_store_source
end

#firestore_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFirestoreSource

Firestore source import data from. Corresponds to the JSON property firestoreSource

Returns:



16692
16693
16694
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16692

def firestore_source
  @firestore_source
end

#gcs_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource

Cloud Storage location for input content. Corresponds to the JSON property gcsSource

Returns:



16697
16698
16699
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16697

def gcs_source
  @gcs_source
end

#id_field ⇒ 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. Corresponds to the JSON property idField

Returns:

  • (String) 


16716
16717
16718
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16716

def id_field
  @id_field
end

#inline_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource

The inline source for the input config for ImportDocuments method. Corresponds to the JSON property inlineSource

Returns:



16721
16722
16723
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16721

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

Returns:

  • (String) 


16727
16728
16729
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16727

def reconciliation_mode
  @reconciliation_mode
end

#spanner_source ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSpannerSource

The Spanner source for importing data Corresponds to the JSON property spannerSource

Returns:



16732
16733
16734
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16732

def spanner_source
  @spanner_source
end

#update_mask ⇒ String

Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. Corresponds to the JSON property updateMask

Returns:

  • (String) 


16738
16739
16740
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16738

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16745

def update!(**args)
  @alloy_db_source = args[:alloy_db_source] if args.key?(:alloy_db_source)
  @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
  @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
  @bigtable_source = args[:bigtable_source] if args.key?(:bigtable_source)
  @cloud_sql_source = args[:cloud_sql_source] if args.key?(:cloud_sql_source)
  @error_config = args[:error_config] if args.key?(:error_config)
  @fhir_store_source = args[:fhir_store_source] if args.key?(:fhir_store_source)
  @firestore_source = args[:firestore_source] if args.key?(:firestore_source)
  @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)
  @spanner_source = args[:spanner_source] if args.key?(:spanner_source)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end