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.



2075
2076
2077
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2075

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. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown. Corresponds to the JSON property autoGenerateIds

Returns:

  • (Boolean) 


2029
2030
2031
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2029

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:



2035
2036
2037
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2035

def bigquery_source
  @bigquery_source
end

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

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

Returns:



2040
2041
2042
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2040

def error_config
  @error_config
end

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

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

Returns:



2045
2046
2047
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2045

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


2062
2063
2064
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2062

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:



2067
2068
2069
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2067

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) 


2073
2074
2075
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2073

def reconciliation_mode
  @reconciliation_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2080
2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2080

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