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.



941
942
943
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 941

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, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown. Corresponds to the JSON property autoGenerateIds

Returns:

  • (Boolean) 


895
896
897
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 895

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:



901
902
903
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 901

def bigquery_source
  @bigquery_source
end

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

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

Returns:



906
907
908
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 906

def error_config
  @error_config
end

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

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

Returns:



911
912
913
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 911

def gcs_source
  @gcs_source
end

#id_field ⇒ String

The field in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be used as the Document. ids. The JSON field or the BigQuery 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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. Corresponds to the JSON property idField

Returns:

  • (String) 


928
929
930
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 928

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:



933
934
935
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 933

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) 


939
940
941
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 939

def reconciliation_mode
  @reconciliation_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



946
947
948
949
950
951
952
953
954
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 946

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)
  @error_config = args[:error_config] if args.key?(:error_config)
  @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)
end