Request message for Import methods.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#errors_config
def errors_config() -> ::Google::Cloud::Retail::V2::ImportErrorsConfig
Returns
- (::Google::Cloud::Retail::V2::ImportErrorsConfig) — The desired location of errors incurred during the Import.
#errors_config=
def errors_config=(value) -> ::Google::Cloud::Retail::V2::ImportErrorsConfig
Parameter
- value (::Google::Cloud::Retail::V2::ImportErrorsConfig) — The desired location of errors incurred during the Import.
Returns
- (::Google::Cloud::Retail::V2::ImportErrorsConfig) — The desired location of errors incurred during the Import.
#input_config
def input_config() -> ::Google::Cloud::Retail::V2::ProductInputConfig
Returns
- (::Google::Cloud::Retail::V2::ProductInputConfig) — Required. The desired input location of the data.
#input_config=
def input_config=(value) -> ::Google::Cloud::Retail::V2::ProductInputConfig
Parameter
- value (::Google::Cloud::Retail::V2::ProductInputConfig) — Required. The desired input location of the data.
Returns
- (::Google::Cloud::Retail::V2::ProductInputConfig) — Required. The desired input location of the data.
#notification_pubsub_topic
def notification_pubsub_topic() -> ::String
Returns
-
(::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 to
FULL.
#notification_pubsub_topic=
def notification_pubsub_topic=(value) -> ::String
Parameter
-
value (::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 to
FULL.
Returns
-
(::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 to
FULL.
#parent
def parent() -> ::String
Returns
-
(::String) — Required.
projects/1234/locations/global/catalogs/default_catalog/branches/default_branchIf no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required.
projects/1234/locations/global/catalogs/default_catalog/branches/default_branchIf 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_branchIf no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.
#reconciliation_mode
def reconciliation_mode() -> ::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode
Returns
- (::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode) — The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
#reconciliation_mode=
def reconciliation_mode=(value) -> ::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode
Parameter
- value (::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode) — The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
Returns
- (::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode) — The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
#request_id
def request_id() -> ::String
Returns
-
(::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.
#request_id=
def request_id=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#update_mask
def update_mask() -> ::Google::Protobuf::FieldMask
Returns
- (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.
#update_mask=
def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
- value (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.
Returns
- (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.