Google Cloud Eventarc V1 Client - Class ListTriggersRequest (2.1.0)

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

The request message for the ListTriggers method.

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

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 triggers on.
↳ page_size int

The maximum number of triggers to return on each page. Note: The service may send fewer.
↳ page_token string

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

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, trigger_id.
↳ filter string

Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.

getParent

Required. The parent collection to list triggers on.

Returns
Type Description
string

setParent

Required. The parent collection to list triggers on.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of triggers to return on each page.

Note: The service may send fewer.

Returns
Type Description
int

setPageSize

The maximum number of triggers to return on each page.

Note: The service may send fewer.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

Returns
Type Description
string

setPageToken

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

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, trigger_id.

Returns
Type Description
string

setOrderBy

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, trigger_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.

Returns
Type Description
string

setFilter

Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

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