Google Cloud Dataform V1beta1 Client - Class ListWorkflowInvocationsRequest (0.4.5)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class ListWorkflowInvocationsRequest.

ListWorkflowInvocations request message.

Generated from protobuf message google.cloud.dataform.v1beta1.ListWorkflowInvocationsRequest

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects//locations//repositories/*`.
`↳ page_size`	`int` Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
`↳ page_token`	`string` Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations` must match the call that provided the page token.
`↳ order_by`	`string` Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
`↳ filter`	`string` Optional. Filter for the returned list.

getParent

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

Returns
Type	Description
`string`

setParent

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

Returns
Type	Description
`int`

setPageSize

Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

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

Returns
Type	Description
`string`

setPageToken

Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

Returns
Type	Description
`string`

setOrderBy

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Filter for the returned list.

Returns
Type	Description
`string`

setFilter

Optional. Filter for the returned list.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects//locations//repositories/*`. Please see Google\Cloud\Dataform\V1beta1\DataformClient::repositoryName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Dataform\V1beta1\ListWorkflowInvocationsRequest`