Send feedback
Class ListProductsRequest (2.49.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.49.0 keyboard_arrow_down
public final class ListProductsRequest extends GeneratedMessageV3 implements ListProductsRequestOrBuilder
Request message for
ProductService.ListProducts
method.
Protobuf type google.cloud.retail.v2alpha.ListProductsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type
Description
int
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
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Type
Description
int
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
Type
Description
int
REQUIRE_TOTAL_SIZE_FIELD_NUMBER
public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static ListProductsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListProductsRequest . Builder newBuilder ()
newBuilder(ListProductsRequest prototype)
public static ListProductsRequest . Builder newBuilder ( ListProductsRequest prototype )
public static ListProductsRequest parseDelimitedFrom ( InputStream input )
public static ListProductsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListProductsRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListProductsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListProductsRequest parseFrom ( CodedInputStream input )
public static ListProductsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListProductsRequest parseFrom ( InputStream input )
public static ListProductsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListProductsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListProductsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public ListProductsRequest getDefaultInstanceForType ()
getFilter()
public String getFilter ()
A filter to apply on the list results. Supported features:
List all the products under the parent branch if
filter is unset.
List
Product.Type.VARIANT
Product s sharing the same
Product.Type.PRIMARY
Product . For example:
primary_product_id = "some_product_id"
List Product s bundled in a
Product.Type.COLLECTION
Product .
For example:
collection_product_id = "some_product_id"
List Product s with a partibular
type. For example:
type = "PRIMARY"
type = "VARIANT"
type = "COLLECTION"
If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
If the specified
Product.Type.PRIMARY
Product or
Product.Type.COLLECTION
Product does not exist, a NOT_FOUND
error is returned.
string filter = 4;
Returns
Type
Description
String
The filter.
getFilterBytes()
public ByteString getFilterBytes ()
A filter to apply on the list results. Supported features:
List all the products under the parent branch if
filter is unset.
List
Product.Type.VARIANT
Product s sharing the same
Product.Type.PRIMARY
Product . For example:
primary_product_id = "some_product_id"
List Product s bundled in a
Product.Type.COLLECTION
Product .
For example:
collection_product_id = "some_product_id"
List Product s with a partibular
type. For example:
type = "PRIMARY"
type = "VARIANT"
type = "COLLECTION"
If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
If the specified
Product.Type.PRIMARY
Product or
Product.Type.COLLECTION
Product does not exist, a NOT_FOUND
error is returned.
string filter = 4;
Returns
Type
Description
ByteString
The bytes for filter.
getPageSize()
Maximum number of Product s to
return. If unspecified, defaults to 100. The maximum allowed value is 1000.
Values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
int32 page_size = 2;
Returns
Type
Description
int
The pageSize.
getPageToken()
public String getPageToken ()
A page token
ListProductsResponse.next_page_token ,
received from a previous
ProductService.ListProducts
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ProductService.ListProducts
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
Returns
Type
Description
String
The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
A page token
ListProductsResponse.next_page_token ,
received from a previous
ProductService.ListProducts
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ProductService.ListProducts
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
Returns
Type
Description
ByteString
The bytes for pageToken.
getParent()
public String getParent ()
Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0
. Use
default_branch
as the branch ID, to list products under the default
branch.
If the caller does not have permission to list
Product s under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED error
is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type
Description
String
The parent.
getParentBytes()
public ByteString getParentBytes ()
Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0
. Use
default_branch
as the branch ID, to list products under the default
branch.
If the caller does not have permission to list
Product s under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED error
is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type
Description
ByteString
The bytes for parent.
getParserForType()
public Parser<ListProductsRequest> getParserForType ()
Overrides
getReadMask()
public FieldMask getReadMask ()
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
If "*" is provided, all fields are returned.
Product.name is always returned
no matter what mask is set.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
.google.protobuf.FieldMask read_mask = 5;
Returns
Type
Description
FieldMask
The readMask.
getReadMaskOrBuilder()
public FieldMaskOrBuilder getReadMaskOrBuilder ()
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
If "*" is provided, all fields are returned.
Product.name is always returned
no matter what mask is set.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
.google.protobuf.FieldMask read_mask = 5;
getRequireTotalSize()
public boolean getRequireTotalSize ()
If true and
page_token is
empty,
ListProductsResponse.total_size
is set to the total count of matched items irrespective of pagination.
Notice that setting this field to true affects the performance.
bool require_total_size = 6;
Returns
Type
Description
boolean
The requireTotalSize.
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hasReadMask()
public boolean hasReadMask ()
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
If "*" is provided, all fields are returned.
Product.name is always returned
no matter what mask is set.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
is returned.
.google.protobuf.FieldMask read_mask = 5;
Returns
Type
Description
boolean
Whether the readMask field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListProductsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListProductsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public ListProductsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]