Reference documentation and code samples for the Google Cloud Workflows V1beta Client class ListExecutionsRequest.
Request for the ListExecutions method.
Generated from protobuf message google.cloud.workflows.executions.v1beta.ListExecutionsRequest
Namespace
Google \ Cloud \ Workflows \ Executions \ V1betaMethods
__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 10000 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. |
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 10000 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 10000 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.
| 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.
| 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 | |