Reference documentation and code samples for the Google Cloud Retail V2 Client class ImportProductsRequest.
Request message for Import methods.
Generated from protobuf message google.cloud.retail.v2.ImportProductsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
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.
↳ request_id
string
Deprecated. This field has no effect.
↳ input_config
↳ errors_config
Google\Cloud\Retail\V2\ImportErrorsConfig
The desired location of errors incurred during the Import.
↳ update_mask
Google\Protobuf\FieldMask
Indicates which fields in the provided imported products
to update. If not set, all fields are updated.
↳ reconciliation_mode
int
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL .
↳ 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 service-<project number>@gcp-sa-retail.iam.gserviceaccount.com
has the pubsub.topics.publish
IAM permission on the topic.
getParent
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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
string
setParent
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.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$this
getRequestId
Deprecated. This field has no effect.
Generated from protobuf field string request_id = 6 [deprecated = true];
string
setRequestId
Deprecated. This field has no effect.
Generated from protobuf field string request_id = 6 [deprecated = true];
var
string
$this
getInputConfig
Required. The desired input location of the data.
Generated from protobuf field .google.cloud.retail.v2.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
hasInputConfig
clearInputConfig
setInputConfig
Required. The desired input location of the data.
Generated from protobuf field .google.cloud.retail.v2.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
$this
getErrorsConfig
The desired location of errors incurred during the Import.
Generated from protobuf field .google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;
hasErrorsConfig
clearErrorsConfig
setErrorsConfig
The desired location of errors incurred during the Import.
Generated from protobuf field .google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;
$this
getUpdateMask
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 4;
Google\Protobuf\FieldMask|null
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 4;
var
Google\Protobuf\FieldMask
$this
getReconciliationMode
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL .
Generated from protobuf field .google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
int
setReconciliationMode
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL .
Generated from protobuf field .google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
var
int
$this
getNotificationPubsubTopic
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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the pubsub.topics.publish
IAM permission on the topic.
Generated from protobuf field string notification_pubsub_topic = 7;
string
setNotificationPubsubTopic
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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the pubsub.topics.publish
IAM permission on the topic.
Generated from protobuf field string notification_pubsub_topic = 7;
var
string
$this
