Google Cloud Eventarc V1 Client - Class ListPipelinesRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class ListPipelinesRequest.

The request message for the ListPipelines method.

Generated from protobuf message google.cloud.eventarc.v1.ListPipelinesRequest

Namespace

Google \ Cloud \ Eventarc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent collection to list pipelines on.

↳ page_size int

Optional. The maximum number of results to return on each page. Note: The service may send fewer.

↳ page_token string

Optional. The page token; provide the value from the next_page_token field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.

↳ order_by string

Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, update_time.

↳ filter string

Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.

getParent

Required. The parent collection to list pipelines on.

Returns
Type Description
string

setParent

Required. The parent collection to list pipelines on.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of results to return on each page.

Note: The service may send fewer.

Returns
Type Description
int

setPageSize

Optional. The maximum number of results to return on each page.

Note: The service may send fewer.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The page token; provide the value from the next_page_token field in a previous call to retrieve the subsequent page.

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

Returns
Type Description
string

setPageToken

Optional. The page token; provide the value from the next_page_token field in a previous call to retrieve the subsequent page.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, update_time.

Returns
Type Description
string

setOrderBy

Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, update_time.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. The filter field that the list request will filter on.

Possible filters are described in https://google.aip.dev/160.

Returns
Type Description
string

setFilter

Optional. The filter field that the list request will filter on.

Possible filters are described in https://google.aip.dev/160.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent collection to list pipelines on. Please see Google\Cloud\Eventarc\V1\EventarcClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\Eventarc\V1\ListPipelinesRequest