Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportProductsRequest

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

Overview

Request message for Import methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaImportProductsRequest

Returns a new instance of GoogleCloudRetailV2alphaImportProductsRequest.



2042
2043
2044
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2042

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

Instance Attribute Details

#errors_configGoogle::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportErrorsConfig

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



2009
2010
2011
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2009

def errors_config
  @errors_config
end

#input_configGoogle::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductInputConfig

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



2014
2015
2016
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2014

def input_config
  @input_config
end

#notification_pubsub_topicString

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/project/topics/topic`. Only supported when ImportProductsRequest.reconciliation_mode is set toFULL. Corresponds to the JSON propertynotificationPubsubTopic`

Returns:

  • (String)


2023
2024
2025
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2023

def notification_pubsub_topic
  @notification_pubsub_topic
end

#reconciliation_modeString

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)


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

def reconciliation_mode
  @reconciliation_mode
end

#request_idString

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

Returns:

  • (String)


2034
2035
2036
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2034

def request_id
  @request_id
end

#update_maskString

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields. Corresponds to the JSON property updateMask

Returns:

  • (String)


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

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2047
2048
2049
2050
2051
2052
2053
2054
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2047

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