Class: Google::Apis::RetailV2::GoogleCloudRetailV2ImportProductsRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2ImportProductsRequest

Returns a new instance of GoogleCloudRetailV2ImportProductsRequest.



1048
1049
1050
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1048

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

Returns:



1011
1012
1013
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1011

def errors_config
  @errors_config
end

#input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2ProductInputConfig

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

Returns:



1016
1017
1018
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1016

def input_config
  @input_config
end

#notification_pubsub_topic ⇒ String

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) 


1025
1026
1027
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1025

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) 


1031
1032
1033
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1031

def reconciliation_mode
  @reconciliation_mode
end

#request_id ⇒ String

Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long and must match the pattern: [a-zA-Z0- 9_]+. This is returned as Operation.name in ImportMetadata. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL. Corresponds to the JSON property requestId

Returns:

  • (String) 


1040
1041
1042
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1040

def request_id
  @request_id
end

#update_mask ⇒ String

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) 


1046
1047
1048
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1046

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1053

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