Class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.StepEntriesResource.ListRequest

Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListStepEntriesResponse>
WorkflowExecutionsBaseServiceRequest<ListStepEntriesResponse>
ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.StepEntriesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.WorkflowExecutions.v1
Assembly: Google.Apis.WorkflowExecutions.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.StepEntriesResource.ListRequest : WorkflowExecutionsBaseServiceRequest<ListStepEntriesResponse>, IClientServiceRequest<ListStepEntriesResponse>, 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 [StepEntries.ListStepEntries] results. The following fields are supported for filtering: entryId, createTime, updateTime, routine, step, stepType, parent, state. For details, see AIP-160. For example, if you are using the Google APIs Explorer: state="SUCCEEDED" or createTime&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 [StepEntries.ListStepEntries] results. By default the ordering is based on ascending entryId. The following fields are supported for ordering: entryId, createTime, updateTime, routine, step, stepType, state. For details, see AIP-132.

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

PageSize

Optional. Number of step entries to return per call. The default max is 1000.

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

PageToken

Optional. A page token, received from a previous ListStepEntries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListStepEntries must match the call that provided the page token.

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

Parent

Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

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

Skip

Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.

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

View

Deprecated field.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements