Class: Google::Cloud::Retail::V2::ImportProductsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/import_config.rb

Overview

Request message for Import methods.

Defined Under Namespace

Modules: ReconciliationMode

Instance Attribute Summary collapse

Instance Attribute Details

#errors_config ⇒ ::Google::Cloud::Retail::V2::ImportErrorsConfig

Returns The desired location of errors incurred during the Import.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#input_config ⇒ ::Google::Cloud::Retail::V2::ProductInputConfig

Returns Required. The desired input location of the data.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#notification_pubsub_topic ⇒ ::String

Returns 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 [email protected] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic.

Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

Returns:

  • (::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 [email protected] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic.

    Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#parent ⇒ ::String

Returns Required. projects/1234/locations/global/catalogs/default_catalog/branches/default_branch

If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

Returns:

  • (::String) —

    Required. projects/1234/locations/global/catalogs/default_catalog/branches/default_branch

    If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#reconciliation_mode ⇒ ::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode

Returns The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#request_id ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. This field has no effect.

Returns:

  • (::String) —

    Deprecated. This field has no effect.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.

Returns:

  • (::Google::Protobuf::FieldMask) —

    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.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'proto_docs/google/cloud/retail/v2/import_config.rb', line 204

class ImportProductsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates how imported products are reconciled with the existing products
  # created or imported before.
  module ReconciliationMode
    # Defaults to INCREMENTAL.
    RECONCILIATION_MODE_UNSPECIFIED = 0

    # Inserts new products or updates existing products.
    INCREMENTAL = 1

    # Calculates diff and replaces the entire product dataset. Existing
    # products may be deleted if they are not present in the source location.
    FULL = 2
  end
end