Struct google_api_proto::google::cloud::retail::v2alpha::ImportProductsRequest

pub struct ImportProductsRequest {
    pub parent: String,
    pub request_id: String,
    pub input_config: Option<ProductInputConfig>,
    pub errors_config: Option<ImportErrorsConfig>,
    pub update_mask: Option<FieldMask>,
    pub reconciliation_mode: i32,
    pub notification_pubsub_topic: String,
    pub skip_default_branch_protection: bool,
}

Request message for Import methods.

Fields

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

Deprecated. This field has no effect.

input_config: Option<ProductInputConfig>

Required. The desired input location of the data.

errors_config: Option<ImportErrorsConfig>

The desired location of errors incurred during the Import.

update_mask: Option<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.

reconciliation_mode: i32

The mode of reconciliation between existing products and the products to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2alpha.ImportProductsRequest.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][google.longrunning.Operation].

Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as [ImportProductsRequest.parent][google.cloud.retail.v2alpha.ImportProductsRequest.parent]. Make sure that both cloud-retail-customer-data-access@system.gserviceaccount.com 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][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode] is set to FULL.

skip_default_branch_protection: bool

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][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode] is set to FULL.

Implementations

impl ImportProductsRequest

pub fn reconciliation_mode(&self) -> ReconciliationMode

Returns the enum value of reconciliation_mode, or the default if the field is set to an invalid enum value.

pub fn set_reconciliation_mode(&mut self, value: ReconciliationMode)

Sets reconciliation_mode to the provided enum value.

Trait Implementations

impl Clone for ImportProductsRequest

fn clone(&self) -> ImportProductsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImportProductsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImportProductsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ImportProductsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ImportProductsRequest

fn eq(&self, other: &ImportProductsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImportProductsRequest