Class: Google::Apis::RetailV2::GoogleCloudRetailV2ImportProductsRequest
- Inherits:
-
Object
- Object
- Google::Apis::RetailV2::GoogleCloudRetailV2ImportProductsRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb
Overview
Request message for Import methods.
Instance Attribute Summary collapse
-
#errors_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ImportErrorsConfig
Configuration of destination for Import related errors.
-
#input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ProductInputConfig
The input config source for products.
-
#notification_pubsub_topic ⇒ String
Full Pub/Sub topic name for receiving notification.
-
#reconciliation_mode ⇒ String
The mode of reconciliation between existing products and the products to be imported.
-
#request_id ⇒ String
Deprecated.
-
#update_mask ⇒ String
Indicates which fields in the provided imported
products
to update.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudRetailV2ImportProductsRequest
constructor
A new instance of GoogleCloudRetailV2ImportProductsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudRetailV2ImportProductsRequest
Returns a new instance of GoogleCloudRetailV2ImportProductsRequest.
2030 2031 2032 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2030 def initialize(**args) update!(**args) end |
Instance Attribute Details
#errors_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ImportErrorsConfig
Configuration of destination for Import related errors.
Corresponds to the JSON property errorsConfig
1992 1993 1994 |
# File 'lib/google/apis/retail_v2/classes.rb', line 1992 def errors_config @errors_config end |
#input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ProductInputConfig
The input config source for products.
Corresponds to the JSON property inputConfig
1997 1998 1999 |
# File 'lib/google/apis/retail_v2/classes.rb', line 1997 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 both
cloud-retail-customer-data-
access@system.gserviceaccount.comand
service-@gcp-sa-retail.iam.
gserviceaccount.comhave the
pubsub.topics.publishIAM permission on the
topic. Only supported when ImportProductsRequest.reconciliation_mode is set to
FULL.
Corresponds to the JSON property
notificationPubsubTopic`
2010 2011 2012 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2010 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
2016 2017 2018 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2016 def reconciliation_mode @reconciliation_mode end |
#request_id ⇒ String
Deprecated. This field has no effect.
Corresponds to the JSON property requestId
2021 2022 2023 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2021 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
2028 2029 2030 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2028 def update_mask @update_mask end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2035 2036 2037 2038 2039 2040 2041 2042 |
# File 'lib/google/apis/retail_v2/classes.rb', line 2035 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 |