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.



3046
3047
3048
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3046

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

Instance Attribute Details

#errors_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportErrorsConfig

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

Returns:



2999
3000
3001
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2999

def errors_config
  @errors_config
end

#input_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductInputConfig

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

Returns:



3004
3005
3006
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3004

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) 


3017
3018
3019
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3017

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) 


3023
3024
3025
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3023

def reconciliation_mode
  @reconciliation_mode
end

#request_id ⇒ String

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

Returns:

  • (String) 


3028
3029
3030
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3028

def request_id
  @request_id
end

#skip_default_branch_protection ⇒ Boolean Also known as: skip_default_branch_protection?

If true, this performs the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL. Corresponds to the JSON property skipDefaultBranchProtection

Returns:

  • (Boolean) 


3036
3037
3038
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3036

def skip_default_branch_protection
  @skip_default_branch_protection
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) 


3044
3045
3046
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3044

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3051
3052
3053
3054
3055
3056
3057
3058
3059
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3051

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)
  @skip_default_branch_protection = args[:skip_default_branch_protection] if args.key?(:skip_default_branch_protection)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end