com.google.cloud.retail.v2alpha.LocalInventoryOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/retail/v2alpha/common.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;
public interface LocalInventoryOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.LocalInventory)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The place ID for the current set of inventory information.
*
*
* string place_id = 1;
*
* @return The placeId.
*/
java.lang.String getPlaceId();
/**
*
*
*
* The place ID for the current set of inventory information.
*
*
* string place_id = 1;
*
* @return The bytes for placeId.
*/
com.google.protobuf.ByteString getPlaceIdBytes();
/**
*
*
*
* 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;
*
* @return Whether the priceInfo field is set.
*/
boolean hasPriceInfo();
/**
*
*
*
* 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;
*
* @return The priceInfo.
*/
com.google.cloud.retail.v2alpha.PriceInfo getPriceInfo();
/**
*
*
*
* 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;
*/
com.google.cloud.retail.v2alpha.PriceInfoOrBuilder getPriceInfoOrBuilder();
/**
*
*
*
* 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;
*/
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.v2alpha.CustomAttribute> attributes = 3;
*/
boolean containsAttributes(java.lang.String key);
/** Use {@link #getAttributesMap()} instead. */
@java.lang.Deprecated
java.util.Map getAttributes();
/**
*
*
*
* 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;
*/
java.util.Map
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.v2alpha.CustomAttribute> attributes = 3;
*/
/* nullable */
com.google.cloud.retail.v2alpha.CustomAttribute getAttributesOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.retail.v2alpha.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.v2alpha.CustomAttribute> attributes = 3;
*/
com.google.cloud.retail.v2alpha.CustomAttribute getAttributesOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
* @return A list containing the fulfillmentTypes.
*/
java.util.List 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];
*
* @return The count of fulfillmentTypes.
*/
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];
*
* @param index The index of the element to return.
* @return The fulfillmentTypes at the given index.
*/
java.lang.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];
*
* @param index The index of the value to return.
* @return The bytes of the fulfillmentTypes at the given index.
*/
com.google.protobuf.ByteString getFulfillmentTypesBytes(int index);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy