Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequest

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

Overview

Request message for Import methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1ImportDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1ImportDocumentsRequest.



3886
3887
3888
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3886

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


3807
3808
3809
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3807

def auto_generate_ids
  @auto_generate_ids
end

#bigquery_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigQuerySource

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

Returns:



3813
3814
3815
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3813

def bigquery_source
  @bigquery_source
end

#bigtable_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigtableSource

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

Returns:



3818
3819
3820
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3818

def bigtable_source
  @bigtable_source
end

#cloud_sql_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CloudSqlSource

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

Returns:



3823
3824
3825
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3823

def cloud_sql_source
  @cloud_sql_source
end

#error_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportErrorConfig

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

Returns:



3828
3829
3830
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3828

def error_config
  @error_config
end

#fhir_store_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FhirStoreSource

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

Returns:



3833
3834
3835
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3833

def fhir_store_source
  @fhir_store_source
end

#firestore_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FirestoreSource

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

Returns:



3838
3839
3840
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3838

def firestore_source
  @firestore_source
end

#gcs_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource

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

Returns:



3843
3844
3845
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3843

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) 


3862
3863
3864
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3862

def id_field
  @id_field
end

#inline_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource

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

Returns:



3867
3868
3869
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3867

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) 


3873
3874
3875
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3873

def reconciliation_mode
  @reconciliation_mode
end

#spanner_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SpannerSource

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

Returns:



3878
3879
3880
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3878

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) 


3884
3885
3886
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3884

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3891

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)
  @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