Workflow Executions v1 API - Class ListExecutionsRequest (2.3.0)

public sealed class ListExecutionsRequest : IMessage<ListExecutionsRequest>, IEquatable<ListExecutionsRequest>, IDeepCloneable<ListExecutionsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Workflow Executions v1 API class ListExecutionsRequest.

Request for the [ListExecutions][] method.

Inheritance

object > ListExecutionsRequest

Implements

IMessage ListExecutionsRequest, IEquatable ListExecutionsRequest, IDeepCloneable ListExecutionsRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Workflows.Executions.V1

Assembly

Google.Cloud.Workflows.Executions.V1.dll

Constructors

ListExecutionsRequest()

public ListExecutionsRequest()

ListExecutionsRequest(ListExecutionsRequest)

public ListExecutionsRequest(ListExecutionsRequest other)

Parameter
Name	Description
`other`	`ListExecutionsRequest`

Properties

Filter

public string Filter { get; set; }

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

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.

Property Value
Type	Description
`string`

PageSize

public int PageSize { get; set; }

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.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

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.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

Property Value
Type	Description
`string`

ParentAsWorkflowName

public WorkflowName ParentAsWorkflowName { get; set; }

WorkflowName-typed view over the Parent resource name property.

Property Value
Type	Description
`WorkflowName`

View

public ExecutionView View { get; set; }

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

Property Value
Type	Description
`ExecutionView`