Google Cloud Workflows V1 Client - Class ListWorkflowsRequest (0.4.2)

Reference documentation and code samples for the Google Cloud Workflows V1 Client class ListWorkflowsRequest.

Request for the ListWorkflows method.

Generated from protobuf message google.cloud.workflows.v1.ListWorkflowsRequest

Namespace

Google \ Cloud \ Workflows \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

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.

↳ page_token string

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.

↳ filter string

Filter to restrict results to specific workflows.

↳ order_by string

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.

getParent

Required. Project and location from which the workflows should be listed.

Format: projects/{project}/locations/{location}

Returns
TypeDescription
string

setParent

Required. Project and location from which the workflows should be listed.

Format: projects/{project}/locations/{location}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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.

Returns
TypeDescription
int

setPageSize

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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.

Returns
TypeDescription
string

setPageToken

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Filter to restrict results to specific workflows.

Returns
TypeDescription
string

setFilter

Filter to restrict results to specific workflows.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

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.

Returns
TypeDescription
string

setOrderBy

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} Please see Google\Cloud\Workflows\V1\WorkflowsClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Workflows\V1\ListWorkflowsRequest