Struct googapis::google::cloud::retail::v2beta::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,
}

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

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][google.cloud.retail.v2beta.ImportMetadata].

Only supported when [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2beta.ImportProductsRequest.reconciliation_mode] is set to FULL.

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, will by default update all fields.

reconciliation_mode: i32

The mode of reconciliation between existing products and the products to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2beta.ImportProductsRequest.ReconciliationMode.INCREMENTAL].

notification_pubsub_topic: 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][google.longrunning.Operation]. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

Only supported when [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2beta.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 encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<ImportProductsRequest> 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: &ImportProductsRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for ImportProductsRequest