Retail V2 API - Class Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest (v2.0.0)

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

Request message for ProductService.AddFulfillmentPlaces method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#add_time

def add_time() -> ::Google::Protobuf::Timestamp
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.

#add_time=

def add_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.
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.

#allow_missing

def allow_missing() -> ::Boolean
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.

#allow_missing=

def allow_missing=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#place_ids

def place_ids() -> ::Array<::String>
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.

#place_ids=

def place_ids=(value) -> ::Array<::String>
Parameter
  • value (::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.

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.

#product

def product() -> ::String
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.

#product=

def product=(value) -> ::String
Parameter
  • value (::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.

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.

#type

def type() -> ::String
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.

#type=

def type=(value) -> ::String
Parameter
  • value (::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.

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.