Google Cloud Private Catalog V1beta1 Client - Class SearchProductsRequest (0.2.13)

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
NameDescription
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: parent=catalogs/{catalog} * Get a product by name: name=catalogs/{catalog}/products/{product}

↳ 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
TypeDescription
string

setResource

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of entries that are requested.

Returns
TypeDescription
int

setPageSize

The maximum number of entries that are requested.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

Returns
TypeDescription
string

setPageToken

A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from.

Parameter
NameDescription
var string
Returns
TypeDescription
$this