Google Cloud Retail V2 Client - Class AddFulfillmentPlacesRequest (1.4.2)

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

Request message for ProductService.AddFulfillmentPlaces method.

Generated from protobuf message google.cloud.retail.v2.AddFulfillmentPlacesRequest

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ product
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
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 .

↳ place_ids
array

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.

↳ add_time
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
bool

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.

getProduct

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
Type
Description
string

setProduct

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getType

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
Type
Description
string

setType

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 .
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPlaceIds

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
Type
Description

setPlaceIds

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.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getAddTime

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
Type
Description

hasAddTime

clearAddTime

setAddTime

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.

Parameter
Name
Description
Returns
Type
Description
$this

getAllowMissing

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
Type
Description
bool

setAllowMissing

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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameter
Name
Description
product
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. Please see Google\Cloud\Retail\V2\ProductServiceClient::productName() for help formatting this field.

Design a Mobile Site
View Site in Mobile | Classic
Share by: