public final class ListProductsRequest extends GeneratedMessageV3 implements ListProductsRequestOrBuilder
Request message for
ProductService.ListProducts
method.
Protobuf type google.cloud.retail.v2alpha.ListProductsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
REQUIRE_TOTAL_SIZE_FIELD_NUMBER
public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListProductsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListProductsRequest.Builder newBuilder()
Returns
newBuilder(ListProductsRequest prototype)
public static ListProductsRequest.Builder newBuilder(ListProductsRequest prototype)
Parameter
Returns
public static ListProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListProductsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListProductsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListProductsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListProductsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListProductsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListProductsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListProductsRequest getDefaultInstanceForType()
Returns
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
Products sharing the same
Product.Type.PRIMARY
Product. For example:
primary_product_id = "some_product_id"
- List Products bundled in a
Product.Type.COLLECTION
Product.
For example:
collection_product_id = "some_product_id"
- List Products 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;
| 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
Products sharing the same
Product.Type.PRIMARY
Product. For example:
primary_product_id = "some_product_id"
- List Products bundled in a
Product.Type.COLLECTION
Product.
For example:
collection_product_id = "some_product_id"
- List Products 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;
getPageSize()
Maximum number of Products 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;
| 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;
| 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;
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
Products 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) = { ... }
| 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
Products 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) = { ... }
getParserForType()
public Parser<ListProductsRequest> getParserForType()
Returns
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;
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;
| Type | Description |
| boolean | The requireTotalSize.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| Type | Description |
| boolean | Whether the readMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListProductsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListProductsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
