Reference documentation and code samples for the Google Cloud Design Center V1 Client class ListCatalogsRequest.
Message for requesting a list of catalogs.
Generated from protobuf message google.cloud.designcenter.v1.ListCatalogsRequest
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent space from which catalogs are listed. Format: |
↳ 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, 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 which catalogs to return. |
↳ order_by |
string
Optional. How the results should be sorted. |
getParent
Required. The parent space from which catalogs are listed.
Format: projects/$project/locations/$location/spaces/$space
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent space from which catalogs are listed.
Format: projects/$project/locations/$location/spaces/$space
| 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, 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, 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 which catalogs to return.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. A filter that chooses which catalogs 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 space from which catalogs are listed.
Format: |
| Returns | |
|---|---|
| Type | Description |
ListCatalogsRequest |
|