Reference documentation and code samples for the Google Cloud Workflows V1 Client class ListExecutionsRequest.
Request for the ListExecutions method.
Generated from protobuf message google.cloud.workflows.executions.v1.ListExecutionsRequest
Namespace
Google \ Cloud \ Workflows \ Executions \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} |
↳ page_size |
int
Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it. |
↳ page_token |
string
A page token, received from a previous |
↳ view |
int
Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view. |
↳ filter |
string
Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label. |
↳ order_by |
string
Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID. |
getParent
Required. Name of the workflow for which the executions should be listed.
Format: projects/{project}/locations/{location}/workflows/{workflow}
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Name of the workflow for which the executions should be listed.
Format: projects/{project}/locations/{location}/workflows/{workflow}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of executions to return per call.
Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of executions to return per call.
Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token, received from a previous ListExecutions call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListExecutions must
match the call that provided the page token.
Note that pagination is applied to dynamic data. The list of executions
returned can change between page requests.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token, received from a previous ListExecutions call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListExecutions must
match the call that provided the page token.
Note that pagination is applied to dynamic data. The list of executions
returned can change between page requests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getView
Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
| Returns | |
|---|---|
| Type | Description |
int | |
setView
Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. Filters applied to the [Executions.ListExecutions] results.
The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. Filters applied to the [Executions.ListExecutions] results.
The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Optional. The ordering applied to the [Executions.ListExecutions] results.
By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. The ordering applied to the [Executions.ListExecutions] results.
By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} Please see Google\Cloud\Workflows\Executions\V1\ExecutionsClient::workflowName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Workflows\Executions\V1\ListExecutionsRequest | |