Class: Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest

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.AddFulfillmentPlaces method.

Instance Attribute Summary collapse

Instance Attribute Details

#add_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.



421
422
423
424
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 421

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

#allow_missing ⇒ ::Boolean

Returns If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

Returns:

  • (::Boolean) —

    If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.



421
422
423
424
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 421

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

#place_ids ⇒ ::Array<::String>

Returns Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this type. Duplicate IDs will be automatically ignored.

At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

If the total number of place IDs exceeds 2000 for this type after adding, then the update will be rejected.

Returns:

  • (::Array<::String>) —

    Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this type. Duplicate IDs will be automatically ignored.

    At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

    If the total number of place IDs exceeds 2000 for this type after adding, then the update will be rejected.



421
422
423
424
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 421

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

#product ⇒ ::String

Returns Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

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

Returns:

  • (::String) —

    Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

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



421
422
423
424
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 421

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

#type ⇒ ::String

Returns Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

Supported values:

  • "pickup-in-store"
  • "ship-to-store"
  • "same-day-delivery"
  • "next-day-delivery"
  • "custom-type-1"
  • "custom-type-2"
  • "custom-type-3"
  • "custom-type-4"
  • "custom-type-5"

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

This field directly corresponds to Product.fulfillment_info.type.

Returns:

  • (::String) —

    Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

    Supported values:

    • "pickup-in-store"
    • "ship-to-store"
    • "same-day-delivery"
    • "next-day-delivery"
    • "custom-type-1"
    • "custom-type-2"
    • "custom-type-3"
    • "custom-type-4"
    • "custom-type-5"

    If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    This field directly corresponds to Product.fulfillment_info.type.



421
422
423
424
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 421

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