Class: Google::Cloud::Retail::V2::UpdateProductRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/product_service.rb

Overview

Request message for ProductService.UpdateProduct method.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_missing ⇒ ::Boolean

Returns 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.



110
111
112
113
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 110

class UpdateProductRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product ⇒ ::Google::Cloud::Retail::V2::Product

Returns 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.



110
111
112
113
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 110

class UpdateProductRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.



110
111
112
113
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 110

class UpdateProductRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end