Google Cloud Design Center V1 Client - Class ListCatalogTemplatesRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Design Center V1 Client class ListCatalogTemplatesRequest.

Message for requesting a list of catalog templates.

Generated from protobuf message google.cloud.designcenter.v1.ListCatalogTemplatesRequest

Namespace

Google \ Cloud \ DesignCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

↳ page_size int

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

↳ page_token string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

↳ filter string

Optional. A filter that chooses the catalog templates to return.

↳ order_by string

Optional. How the results should be sorted.

getParent

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

Returns
Type Description
string

setParent

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Returns
Type Description
int

setPageSize

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Returns
Type Description
string

setPageToken

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A filter that chooses the catalog templates to return.

Returns
Type Description
string

setFilter

Optional. A filter that chooses the catalog templates to return.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. How the results should be sorted.

Returns
Type Description
string

setOrderBy

Optional. How the results should be sorted.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog Please see DesignCenterClient::catalogName() for help formatting this field.

Returns
Type Description
ListCatalogTemplatesRequest