Reference documentation and code samples for the Google Cloud Workflows V1 Client class ListWorkflowsRequest.
Request for the ListWorkflows method.
Generated from protobuf message google.cloud.workflows.v1.ListWorkflowsRequest
Namespace
Google \ Cloud \ Workflows \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} |
↳ page_size |
int
Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000. |
↳ page_token |
string
A page token, received from a previous |
↳ filter |
string
Filter to restrict results to specific workflows. |
↳ order_by |
string
Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order. |
getParent
Required. Project and location from which the workflows should be listed.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Project and location from which the workflows should be listed.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token, received from a previous ListWorkflows call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListWorkflows must
match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token, received from a previous ListWorkflows call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListWorkflows must
match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Filter to restrict results to specific workflows.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Filter to restrict results to specific workflows.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Comma-separated list of fields that that specify the order of the results.
Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Comma-separated list of fields that that specify the order of the results.
Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} Please see Google\Cloud\Workflows\V1\WorkflowsClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Workflows\V1\ListWorkflowsRequest | |