Reference documentation and code samples for the Google Cloud Private Catalog V1beta1 Client class SearchProductsRequest.
Request message for PrivateCatalog.SearchProducts.
Generated from protobuf message google.cloud.privatecatalog.v1beta1.SearchProductsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ resource |
string
Required. The name of the resource context. See SearchCatalogsRequest.resource for details. |
↳ query |
string
The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: |
↳ page_size |
int
The maximum number of entries that are requested. |
↳ page_token |
string
A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. |
getResource
Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
| Returns | |
|---|---|
| Type | Description |
string | |
setResource
Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuery
The query to filter the products.
The supported queries are:
- List products of all catalogs: empty
- List products under a catalog:
parent=catalogs/{catalog} - Get a product by name:
name=catalogs/{catalog}/products/{product}
| Returns | |
|---|---|
| Type | Description |
string | |
setQuery
The query to filter the products.
The supported queries are:
- List products of all catalogs: empty
- List products under a catalog:
parent=catalogs/{catalog} - Get a product by name:
name=catalogs/{catalog}/products/{product}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of entries that are requested.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of entries that are requested.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |