Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest

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

Overview

Request message for Import methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.



7250
7251
7252
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7250

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

Instance Attribute Details

#alloy_db_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAlloyDbSource

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

Returns:



7157
7158
7159
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7157

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) 


7171
7172
7173
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7171

def auto_generate_ids
  @auto_generate_ids
end

#bigquery_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource

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

Returns:



7177
7178
7179
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7177

def bigquery_source
  @bigquery_source
end

#bigtable_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableSource

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

Returns:



7182
7183
7184
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7182

def bigtable_source
  @bigtable_source
end

#cloud_sql_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCloudSqlSource

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

Returns:



7187
7188
7189
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7187

def cloud_sql_source
  @cloud_sql_source
end

#error_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig

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

Returns:



7192
7193
7194
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7192

def error_config
  @error_config
end

#fhir_store_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFhirStoreSource

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

Returns:



7197
7198
7199
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7197

def fhir_store_source
  @fhir_store_source
end

#firestore_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFirestoreSource

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

Returns:



7202
7203
7204
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7202

def firestore_source
  @firestore_source
end

#gcs_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource

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

Returns:



7207
7208
7209
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7207

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) 


7226
7227
7228
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7226

def id_field
  @id_field
end

#inline_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource

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

Returns:



7231
7232
7233
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7231

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) 


7237
7238
7239
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7237

def reconciliation_mode
  @reconciliation_mode
end

#spanner_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSpannerSource

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

Returns:



7242
7243
7244
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7242

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) 


7248
7249
7250
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7248

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7255

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