- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ListProductsRequest.Builder extends GeneratedMessageV3.Builder<ListProductsRequest.Builder> implements ListProductsRequestOrBuilder
Request message for ProductService.ListProducts method.
Protobuf type google.cloud.retail.v2.ListProductsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListProductsRequest.BuilderImplements
ListProductsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
build()
public ListProductsRequest build()
Returns | |
---|---|
Type | Description |
ListProductsRequest |
buildPartial()
public ListProductsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListProductsRequest |
clear()
public ListProductsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
clearFilter()
public ListProductsRequest.Builder clearFilter()
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;
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
clearPageSize()
public ListProductsRequest.Builder clearPageSize()
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;
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListProductsRequest.Builder clearPageToken()
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 |
ListProductsRequest.Builder | This builder for chaining. |
clearParent()
public ListProductsRequest.Builder clearParent()
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) = { ... }
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
clearReadMask()
public ListProductsRequest.Builder clearReadMask()
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 |
ListProductsRequest.Builder |
clone()
public ListProductsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
getDefaultInstanceForType()
public ListProductsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListProductsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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;
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
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;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getPageSize()
public int 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;
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 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) = { ... }
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 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for parent. |
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. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()
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 |
Builder |
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;
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListProductsRequest other)
public ListProductsRequest.Builder mergeFrom(ListProductsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListProductsRequest |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListProductsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
mergeReadMask(FieldMask value)
public ListProductsRequest.Builder mergeReadMask(FieldMask value)
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;
Parameter | |
---|---|
Name | Description |
value | FieldMask |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
setFilter(String value)
public ListProductsRequest.Builder setFilter(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListProductsRequest.Builder setFilterBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListProductsRequest.Builder setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListProductsRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListProductsRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListProductsRequest.Builder setParent(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The parent to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListProductsRequest.Builder setParentBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder | This builder for chaining. |
setReadMask(FieldMask value)
public ListProductsRequest.Builder setReadMask(FieldMask value)
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;
Parameter | |
---|---|
Name | Description |
value | FieldMask |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
setReadMask(FieldMask.Builder builderForValue)
public ListProductsRequest.Builder setReadMask(FieldMask.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListProductsRequest.Builder |