Package com.google.cloud.retail.v2

Interface LocalInventoryOrBuilder

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

    • Method Detail

      • getPlaceId

        String getPlaceId()
         The place ID for the current set of inventory information.
        string place_id = 1;
        Returns:
        The placeId.

      • getPlaceIdBytes

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

      • hasPriceInfo

        boolean hasPriceInfo()
         Product price and cost information.

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

      • getPriceInfo

        PriceInfo getPriceInfo()
         Product price and cost information.

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

      • getPriceInfoOrBuilder

        PriceInfoOrBuilder getPriceInfoOrBuilder()
         Product price and cost information.

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

      • getAttributesCount

        int getAttributesCount()
         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.v2.CustomAttribute> attributes = 3;

      • containsAttributes

        boolean containsAttributes​(String key)
         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.v2.CustomAttribute> attributes = 3;

      • getAttributesMap

        Map<String,​CustomAttribute> getAttributesMap()
         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.v2.CustomAttribute> attributes = 3;

      • getAttributesOrDefault

        CustomAttribute getAttributesOrDefault​(String key,
                                       CustomAttribute defaultValue)
         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.v2.CustomAttribute> attributes = 3;

      • getAttributesOrThrow

        CustomAttribute getAttributesOrThrow​(String key)
         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.v2.CustomAttribute> attributes = 3;

      • getFulfillmentTypesList

        List<String> getFulfillmentTypesList()
         Input only. 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) = INPUT_ONLY];
        Returns:
        A list containing the fulfillmentTypes.

      • getFulfillmentTypesCount

        int getFulfillmentTypesCount()
         Input only. 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) = INPUT_ONLY];
        Returns:
        The count of fulfillmentTypes.

      • getFulfillmentTypes

        String getFulfillmentTypes​(int index)
         Input only. 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) = INPUT_ONLY];
        Parameters:
        index - The index of the element to return.
        Returns:
        The fulfillmentTypes at the given index.

      • getFulfillmentTypesBytes

        com.google.protobuf.ByteString getFulfillmentTypesBytes​(int index)
         Input only. 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) = INPUT_ONLY];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fulfillmentTypes at the given index.