Class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListExecutionsResponse>
WorkflowExecutionsBaseServiceRequest<ListExecutionsResponse>
ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.WorkflowExecutions.v1
Assembly: Google.Apis.WorkflowExecutions.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest : WorkflowExecutionsBaseServiceRequest<ListExecutionsResponse>, IClientServiceRequest<ListExecutionsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionId, state, createTime, startTime, endTime, duration, workflowRevisionId, stepName, label, and disableConcurrencyQuotaOverflowBuffering. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: state="SUCCEEDED" or startTime&gt;"2023-08-01" AND state="FAILED"

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Optional. Comma-separated list of fields that specify the ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending createTime. The following fields are supported for ordering: executionId, state, createTime, startTime, endTime, duration, and workflowRevisionId. For details, see AIP-132.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

View

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

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest.ViewEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements