public final class ListLocalInventoriesRequest extends GeneratedMessage implements ListLocalInventoriesRequestOrBuilder
Request message for the ListLocalInventories method.
Protobuf type google.shopping.merchant.inventories.v1.ListLocalInventoriesRequest
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListLocalInventoriesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListLocalInventoriesRequest.Builder newBuilder()
public static ListLocalInventoriesRequest.Builder newBuilder(ListLocalInventoriesRequest prototype)
public static ListLocalInventoriesRequest parseDelimitedFrom(InputStream input)
public static ListLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListLocalInventoriesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListLocalInventoriesRequest parseFrom(ByteString data)
public static ListLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListLocalInventoriesRequest parseFrom(CodedInputStream input)
public static ListLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListLocalInventoriesRequest parseFrom(InputStream input)
public static ListLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListLocalInventoriesRequest parseFrom(ByteBuffer data)
public static ListLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListLocalInventoriesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListLocalInventoriesRequest getDefaultInstanceForType()
getPageSize()
The maximum number of LocalInventory resources for the given
product to return. The service returns fewer than this value if the number
of inventories for the given product is less that than the pageSize. The
default value is 25000. The maximum value is 25000; If a value higher than
the maximum is specified, then the pageSize will default to the maximum
int32 page_size = 2;
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
A page token, received from a previous ListLocalInventories call.
Provide the page token to retrieve the subsequent page.
When paginating, all other parameters provided to ListLocalInventories
must match the call that provided the page token. The token returned as
nextPageToken
in the response to the previous request.
string page_token = 3;
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous ListLocalInventories call.
Provide the page token to retrieve the subsequent page.
When paginating, all other parameters provided to ListLocalInventories
must match the call that provided the page token. The token returned as
nextPageToken
in the response to the previous request.
string page_token = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
public String getParent()
Required. The name of the parent product to list local inventories for.
Format:
accounts/{account}/products/{product}
The {product} segment is a unique identifier for the product.
This identifier must be unique within a merchant account and generally
follows the structure: content_language~feed_label~offer_id. Example:
en~US~sku123 For legacy local products, the structure is:
local~content_language~feed_label~offer_id. Example: local~en~US~sku123
The format of the {product} segment in the URL is automatically detected
by the server, supporting two options:
- Encoded Format: The
{product} segment is an unpadded base64url
encoded string (RFC 4648 Section 5). The decoded string must result
in the content_language~feed_label~offer_id structure. This encoding
MUST be used if any part of the product identifier (like offer_id)
contains characters such as /, %, or ~.
Example: To represent the product ID en~US~sku/123, the
{product} segment must be the unpadded base64url encoding of this
string, which is ZW5-VVN-c2t1LzEyMw. The full resource name
for the product would be
accounts/123/products/ZW5-VVN-c2t1LzEyMw.
Plain Format: The {product} segment is the tilde-separated string
content_language~feed_label~offer_id. This format is suitable only
when content_language, feed_label, and offer_id do not contain
URL-problematic characters like /, %, or ~.
We recommend using the Encoded Format for all product IDs to ensure
correct parsing, especially those containing special characters. The
presence of tilde (~) characters in the {product} segment is used to
differentiate between the two formats.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
public ByteString getParentBytes()
Required. The name of the parent product to list local inventories for.
Format:
accounts/{account}/products/{product}
The {product} segment is a unique identifier for the product.
This identifier must be unique within a merchant account and generally
follows the structure: content_language~feed_label~offer_id. Example:
en~US~sku123 For legacy local products, the structure is:
local~content_language~feed_label~offer_id. Example: local~en~US~sku123
The format of the {product} segment in the URL is automatically detected
by the server, supporting two options:
- Encoded Format: The
{product} segment is an unpadded base64url
encoded string (RFC 4648 Section 5). The decoded string must result
in the content_language~feed_label~offer_id structure. This encoding
MUST be used if any part of the product identifier (like offer_id)
contains characters such as /, %, or ~.
Example: To represent the product ID en~US~sku/123, the
{product} segment must be the unpadded base64url encoding of this
string, which is ZW5-VVN-c2t1LzEyMw. The full resource name
for the product would be
accounts/123/products/ZW5-VVN-c2t1LzEyMw.
Plain Format: The {product} segment is the tilde-separated string
content_language~feed_label~offer_id. This format is suitable only
when content_language, feed_label, and offer_id do not contain
URL-problematic characters like /, %, or ~.
We recommend using the Encoded Format for all product IDs to ensure
correct parsing, especially those containing special characters. The
presence of tilde (~) characters in the {product} segment is used to
differentiate between the two formats.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
public Parser<ListLocalInventoriesRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListLocalInventoriesRequest.Builder newBuilderForType()
protected ListLocalInventoriesRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public ListLocalInventoriesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
