Retail V2 API - Class Google::Cloud::Retail::V2::UpdateProductRequest (v0.9.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::UpdateProductRequest.

Request message for [UpdateProduct][] method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_missing

def allow_missing() -> ::Boolean
Returns
  • (::Boolean) — If set to true, and the Product is not found, a new Product will be created. In this situation, update_mask is ignored.

#allow_missing=

def allow_missing=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, and the Product is not found, a new Product will be created. In this situation, update_mask is ignored.
Returns
  • (::Boolean) — If set to true, and the Product is not found, a new Product will be created. In this situation, update_mask is ignored.

#product

def product() -> ::Google::Cloud::Retail::V2::Product
Returns
  • (::Google::Cloud::Retail::V2::Product) — Required. The product to update/create.

    If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

#product=

def product=(value) -> ::Google::Cloud::Retail::V2::Product
Parameter
  • value (::Google::Cloud::Retail::V2::Product) — Required. The product to update/create.

    If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

Returns
  • (::Google::Cloud::Retail::V2::Product) — Required. The product to update/create.

    If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

    If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

    The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

    The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

Returns
  • (::Google::Protobuf::FieldMask) — Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

    If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

    The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.