Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportProductsRequest

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

Overview

Request message for Import methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaImportProductsRequest

Returns a new instance of GoogleCloudRetailV2betaImportProductsRequest.



4317
4318
4319
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4317

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

Instance Attribute Details

#errors_config ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportErrorsConfig

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

Returns:



4279
4280
4281
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4279

def errors_config
  @errors_config
end

#input_config ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductInputConfig

The input config source for products. Corresponds to the JSON property inputConfig

Returns:



4284
4285
4286
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4284

def input_config
  @input_config
end

#notification_pubsub_topic ⇒ String

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/project/topics/topic`. It has to be within the same project as ImportProductsRequest.parent. Make sure that bothcloud-retail-customer-data- access@system.gserviceaccount.comandservice-@gcp-sa-retail.iam. gserviceaccount.comhave thepubsub.topics.publishIAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL. Corresponds to the JSON propertynotificationPubsubTopic`

Returns:

  • (String) 


4297
4298
4299
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4297

def notification_pubsub_topic
  @notification_pubsub_topic
end

#reconciliation_mode ⇒ String

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL. Corresponds to the JSON property reconciliationMode

Returns:

  • (String) 


4303
4304
4305
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4303

def reconciliation_mode
  @reconciliation_mode
end

#request_id ⇒ String

Deprecated. This field has no effect. Corresponds to the JSON property requestId

Returns:

  • (String) 


4308
4309
4310
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4308

def request_id
  @request_id
end

#update_mask ⇒ String

Indicates which fields in the provided imported products to update. If not set, all fields are updated. If provided, only the existing product fields are updated. Missing products will not be created. Corresponds to the JSON property updateMask

Returns:

  • (String) 


4315
4316
4317
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4315

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4322
4323
4324
4325
4326
4327
4328
4329
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4322

def update!(**args)
  @errors_config = args[:errors_config] if args.key?(:errors_config)
  @input_config = args[:input_config] if args.key?(:input_config)
  @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
  @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
  @request_id = args[:request_id] if args.key?(:request_id)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end