Generated from protobuf messagegoogle.cloud.workflows.v1.ListWorkflowsRequest
Namespace
Google \ Cloud \ Workflows \ V1
Methods
__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 might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.
↳ page_token
string
A page token, received from a previousListWorkflowscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListWorkflowsmust match the call that provided the page token.
↳ filter
string
Filter to restrict results to specific workflows. For details, seeAIP-160. For example, if you are using the Google APIs Explorer:state="SUCCEEDED"orcreateTime>"2023-08-01" AND state="FAILED"
↳ order_by
string
Comma-separated list of fields 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 are 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 might return
fewer than this value even if not at the end of the collection. If a value
is not specified, a default value of 500 is used. The maximum permitted
value is 1000 and values greater than 1000 are coerced down to 1000.
Returns
Type
Description
int
setPageSize
Maximum number of workflows to return per call. The service might return
fewer than this value even if not at the end of the collection. If a value
is not specified, a default value of 500 is used. The maximum permitted
value is 1000 and values greater than 1000 are coerced down to 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A page token, received from a previousListWorkflowscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListWorkflowsmust
match the call that provided the page token.
Returns
Type
Description
string
setPageToken
A page token, received from a previousListWorkflowscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListWorkflowsmust
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.
For details, seeAIP-160.
For example, if you are using the Google APIs Explorer:state="SUCCEEDED"orcreateTime>"2023-08-01" AND state="FAILED"
Returns
Type
Description
string
setFilter
Filter to restrict results to specific workflows.
For details, seeAIP-160.
For example, if you are using the Google APIs Explorer:state="SUCCEEDED"orcreateTime>"2023-08-01" AND state="FAILED"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Comma-separated list of fields 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 are returned in an unspecified order.
Returns
Type
Description
string
setOrderBy
Comma-separated list of fields 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 are 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 seeWorkflowsClient::locationName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Workflows V1 Client - Class ListWorkflowsRequest (1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/php/docs/reference/cloud-workflows/latest/V1.ListWorkflowsRequest)\n- [1.1.0](/php/docs/reference/cloud-workflows/1.1.0/V1.ListWorkflowsRequest)\n- [1.0.3](/php/docs/reference/cloud-workflows/1.0.3/V1.ListWorkflowsRequest)\n- [0.5.5](/php/docs/reference/cloud-workflows/0.5.5/V1.ListWorkflowsRequest)\n- [0.4.2](/php/docs/reference/cloud-workflows/0.4.2/V1.ListWorkflowsRequest)\n- [0.3.0](/php/docs/reference/cloud-workflows/0.3.0/V1.ListWorkflowsRequest)\n- [0.2.17](/php/docs/reference/cloud-workflows/0.2.17/V1.ListWorkflowsRequest) \nReference documentation and code samples for the Google Cloud Workflows V1 Client class ListWorkflowsRequest.\n\nRequest for the\n[ListWorkflows](/php/docs/reference/cloud-workflows/latest/V1.Client.WorkflowsClient#_Google_Cloud_Workflows_V1_Client_WorkflowsClient__listWorkflows__)\nmethod.\n\nGenerated from protobuf message `google.cloud.workflows.v1.ListWorkflowsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Workflows \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Project and location from which the workflows should be listed.\n\nFormat: projects/{project}/locations/{location}\n\n### setParent\n\nRequired. Project and location from which the workflows should be listed.\n\nFormat: projects/{project}/locations/{location}\n\n### getPageSize\n\nMaximum number of workflows to return per call. The service might return\nfewer than this value even if not at the end of the collection. If a value\nis not specified, a default value of 500 is used. The maximum permitted\nvalue is 1000 and values greater than 1000 are coerced down to 1000.\n\n### setPageSize\n\nMaximum number of workflows to return per call. The service might return\nfewer than this value even if not at the end of the collection. If a value\nis not specified, a default value of 500 is used. The maximum permitted\nvalue is 1000 and values greater than 1000 are coerced down to 1000.\n\n### getPageToken\n\nA page token, received from a previous `ListWorkflows` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListWorkflows` must\nmatch the call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous `ListWorkflows` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListWorkflows` must\nmatch the call that provided the page token.\n\n### getFilter\n\nFilter to restrict results to specific workflows.\n\nFor details, see [AIP-160](https://google.aip.dev/160).\nFor example, if you are using the Google APIs Explorer:\n`state=\"SUCCEEDED\"`\nor\n`createTime\u003e\"2023-08-01\" AND state=\"FAILED\"`\n\n### setFilter\n\nFilter to restrict results to specific workflows.\n\nFor details, see [AIP-160](https://google.aip.dev/160).\nFor example, if you are using the Google APIs Explorer:\n`state=\"SUCCEEDED\"`\nor\n`createTime\u003e\"2023-08-01\" AND state=\"FAILED\"`\n\n### getOrderBy\n\nComma-separated list of fields that specify the order of the results.\n\nDefault sorting order for a field is ascending. To specify descending order\nfor a field, append a \"desc\" suffix.\nIf not specified, the results are returned in an unspecified order.\n\n### setOrderBy\n\nComma-separated list of fields that specify the order of the results.\n\nDefault sorting order for a field is ascending. To specify descending order\nfor a field, append a \"desc\" suffix.\nIf not specified, the results are returned in an unspecified order.\n\n### static::build"]]
