Workflows v1 API - Class ListWorkflowsRequest (2.6.0) 

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

Reference documentation and code samples for the Workflows v1 API class ListWorkflowsRequest.

Request for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method.

Inheritance

object > ListWorkflowsRequest

Namespace

Google.Cloud.Workflows.V1

Assembly

Google.Cloud.Workflows.V1.dll

Constructors

ListWorkflowsRequest()

public ListWorkflowsRequest()

ListWorkflowsRequest(ListWorkflowsRequest)

public ListWorkflowsRequest(ListWorkflowsRequest other)
Parameter
Name Description
other ListWorkflowsRequest

Properties

Filter

public string Filter { get; set; }

Filter to restrict results to specific workflows. For details, see <a href="https://google.aip.dev/160" class="external">AIP-160</a>.

For example, if you are using the Google APIs Explorer:

state="SUCCEEDED"

or

createTime>"2023-08-01" AND state="FAILED"

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token, received from a previous ListWorkflows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkflows must match the call that provided the page token.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName