Package com.google.cloud.retail.v2alpha

Interface LocalInventoryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LocalInventory, LocalInventory.Builder
@Generated public interface LocalInventoryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getPlaceId

      String getPlaceId()
       Optional. The place ID for the current set of inventory information.
      string place_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The placeId.

    • getPlaceIdBytes

      com.google.protobuf.ByteString getPlaceIdBytes()
       Optional. The place ID for the current set of inventory information.
      string place_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for placeId.

    • hasPriceInfo

      boolean hasPriceInfo()
       Optional. Product price and cost information.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371).
      .google.cloud.retail.v2alpha.PriceInfo price_info = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the priceInfo field is set.

    • getPriceInfo

      PriceInfo getPriceInfo()
       Optional. Product price and cost information.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371).
      .google.cloud.retail.v2alpha.PriceInfo price_info = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The priceInfo.

    • getPriceInfoOrBuilder

      PriceInfoOrBuilder getPriceInfoOrBuilder()
       Optional. Product price and cost information.

 Google Merchant Center property
 [price](https://support.google.com/merchants/answer/6324371).
      .google.cloud.retail.v2alpha.PriceInfo price_info = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getAvailabilityValue

      int getAvailabilityValue()
       Optional. The availability of the
 [Product][google.cloud.retail.v2alpha.Product] at this place_id. Default to
 [Availability.IN_STOCK][google.cloud.retail.v2alpha.LocalInventory.Availability.IN_STOCK].

 For primary products with variants set the availability of the primary as
 [Availability.OUT_OF_STOCK][google.cloud.retail.v2alpha.LocalInventory.Availability.OUT_OF_STOCK]
 and set the true availability at the variant level. This way the primary
 product will be considered "in stock" as long as it has at least one
 variant in stock.

 For primary products with no variants set the true availability at the
 primary level.

 Corresponding properties: Google Merchant Center property
 [availability](https://support.google.com/merchants/answer/6324448).
 Schema.org property [Offer.availability](https://schema.org/availability).

 This field is currently only used by the Recommendations API. For Search,
 please make use of
 [fulfillment_types][google.cloud.retail.v2alpha.LocalInventory.fulfillment_types]
 or custom attributes for similar behaviour. See [here](
 https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods)
 for more details.
      .google.cloud.retail.v2alpha.LocalInventory.Availability availability = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for availability.

    • getAvailability

      LocalInventory.Availability getAvailability()
       Optional. The availability of the
 [Product][google.cloud.retail.v2alpha.Product] at this place_id. Default to
 [Availability.IN_STOCK][google.cloud.retail.v2alpha.LocalInventory.Availability.IN_STOCK].

 For primary products with variants set the availability of the primary as
 [Availability.OUT_OF_STOCK][google.cloud.retail.v2alpha.LocalInventory.Availability.OUT_OF_STOCK]
 and set the true availability at the variant level. This way the primary
 product will be considered "in stock" as long as it has at least one
 variant in stock.

 For primary products with no variants set the true availability at the
 primary level.

 Corresponding properties: Google Merchant Center property
 [availability](https://support.google.com/merchants/answer/6324448).
 Schema.org property [Offer.availability](https://schema.org/availability).

 This field is currently only used by the Recommendations API. For Search,
 please make use of
 [fulfillment_types][google.cloud.retail.v2alpha.LocalInventory.fulfillment_types]
 or custom attributes for similar behaviour. See [here](
 https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods)
 for more details.
      .google.cloud.retail.v2alpha.LocalInventory.Availability availability = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The availability.

    • getAttributesCount

      int getAttributesCount()
       Optional. Additional local inventory attributes, for example, store name,
 promotion tags, etc.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * At most 30 attributes are allowed.
 * The key must be a UTF-8 encoded string with a length limit of 32
 characters.
 * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
 key0LikeThis or KEY_1_LIKE_THIS.
 * The attribute values must be of the same type (text or number).
 * Only 1 value is allowed for each attribute.
 * For text values, the length limit is 256 UTF-8 characters.
 * The attribute does not support search. The `searchable` field should be
 unset or set to false.
 * The max summed total bytes of custom attribute keys and values per
 product is 5MiB.
      map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

    • containsAttributes

      boolean containsAttributes(String key)
       Optional. Additional local inventory attributes, for example, store name,
 promotion tags, etc.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * At most 30 attributes are allowed.
 * The key must be a UTF-8 encoded string with a length limit of 32
 characters.
 * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
 key0LikeThis or KEY_1_LIKE_THIS.
 * The attribute values must be of the same type (text or number).
 * Only 1 value is allowed for each attribute.
 * For text values, the length limit is 256 UTF-8 characters.
 * The attribute does not support search. The `searchable` field should be
 unset or set to false.
 * The max summed total bytes of custom attribute keys and values per
 product is 5MiB.
      map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getAttributes

      @Deprecated Map<String,CustomAttribute> getAttributes()
      Deprecated.
      Use getAttributesMap() instead.

    • getAttributesMap

      Map<String,CustomAttribute> getAttributesMap()
       Optional. Additional local inventory attributes, for example, store name,
 promotion tags, etc.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * At most 30 attributes are allowed.
 * The key must be a UTF-8 encoded string with a length limit of 32
 characters.
 * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
 key0LikeThis or KEY_1_LIKE_THIS.
 * The attribute values must be of the same type (text or number).
 * Only 1 value is allowed for each attribute.
 * For text values, the length limit is 256 UTF-8 characters.
 * The attribute does not support search. The `searchable` field should be
 unset or set to false.
 * The max summed total bytes of custom attribute keys and values per
 product is 5MiB.
      map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getAttributesOrDefault

      CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)
       Optional. Additional local inventory attributes, for example, store name,
 promotion tags, etc.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * At most 30 attributes are allowed.
 * The key must be a UTF-8 encoded string with a length limit of 32
 characters.
 * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
 key0LikeThis or KEY_1_LIKE_THIS.
 * The attribute values must be of the same type (text or number).
 * Only 1 value is allowed for each attribute.
 * For text values, the length limit is 256 UTF-8 characters.
 * The attribute does not support search. The `searchable` field should be
 unset or set to false.
 * The max summed total bytes of custom attribute keys and values per
 product is 5MiB.
      map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getAttributesOrThrow

      CustomAttribute getAttributesOrThrow(String key)
       Optional. Additional local inventory attributes, for example, store name,
 promotion tags, etc.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * At most 30 attributes are allowed.
 * The key must be a UTF-8 encoded string with a length limit of 32
 characters.
 * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
 key0LikeThis or KEY_1_LIKE_THIS.
 * The attribute values must be of the same type (text or number).
 * Only 1 value is allowed for each attribute.
 * For text values, the length limit is 256 UTF-8 characters.
 * The attribute does not support search. The `searchable` field should be
 unset or set to false.
 * The max summed total bytes of custom attribute keys and values per
 product is 5MiB.
      map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getFulfillmentTypesList

      List<String> getFulfillmentTypesList()
       Optional. Supported fulfillment types. Valid fulfillment type values
 include commonly used types (such as pickup in store and same day
 delivery), and custom types. Customers have to map custom types to their
 display names before rendering UI.

 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.

 All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
 returned.
      repeated string fulfillment_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the fulfillmentTypes.

    • getFulfillmentTypesCount

      int getFulfillmentTypesCount()
       Optional. Supported fulfillment types. Valid fulfillment type values
 include commonly used types (such as pickup in store and same day
 delivery), and custom types. Customers have to map custom types to their
 display names before rendering UI.

 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.

 All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
 returned.
      repeated string fulfillment_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of fulfillmentTypes.

    • getFulfillmentTypes

      String getFulfillmentTypes(int index)
       Optional. Supported fulfillment types. Valid fulfillment type values
 include commonly used types (such as pickup in store and same day
 delivery), and custom types. Customers have to map custom types to their
 display names before rendering UI.

 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.

 All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
 returned.
      repeated string fulfillment_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The fulfillmentTypes at the given index.

    • getFulfillmentTypesBytes

      com.google.protobuf.ByteString getFulfillmentTypesBytes(int index)
       Optional. Supported fulfillment types. Valid fulfillment type values
 include commonly used types (such as pickup in store and same day
 delivery), and custom types. Customers have to map custom types to their
 display names before rendering UI.

 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.

 All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
 returned.
      repeated string fulfillment_types = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the fulfillmentTypes at the given index.