Reference documentation and code samples for the Google Cloud Eventarc V1 Client class ListChannelsRequest.
The request message for the ListChannels method.
Generated from protobuf messagegoogle.cloud.eventarc.v1.ListChannelsRequest
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 channels on.
↳ page_size
int
The maximum number of channels to return on each page. Note: The service may send fewer.
↳ page_token
string
The page token; provide the value from thenext_page_tokenfield in a previousListChannelscall to retrieve the subsequent page. When paginating, all other parameters provided toListChannelsmust 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 adescsuffix; for example:name desc, channel_id.
getParent
Required. The parent collection to list channels on.
Returns
Type
Description
string
setParent
Required. The parent collection to list channels on.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of channels to return on each page.
Note: The service may send fewer.
Returns
Type
Description
int
setPageSize
The maximum number of channels 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 thenext_page_tokenfield in a
previousListChannelscall to retrieve the subsequent page.
When paginating, all other parameters provided toListChannelsmust
match the call that provided the page token.
Returns
Type
Description
string
setPageToken
The page token; provide the value from thenext_page_tokenfield in a
previousListChannelscall to retrieve the subsequent page.
When paginating, all other parameters provided toListChannelsmust
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 adescsuffix; for example:name desc, channel_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 adescsuffix; for example:name desc, channel_id.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent collection to list channels on. Please seeEventarcClient::locationName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Eventarc V1 Client - Class ListChannelsRequest (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-eventarc/latest/V1.ListChannelsRequest)\n- [2.1.4](/php/docs/reference/cloud-eventarc/2.1.4/V1.ListChannelsRequest)\n- [2.0.1](/php/docs/reference/cloud-eventarc/2.0.1/V1.ListChannelsRequest)\n- [1.3.5](/php/docs/reference/cloud-eventarc/1.3.5/V1.ListChannelsRequest)\n- [1.2.2](/php/docs/reference/cloud-eventarc/1.2.2/V1.ListChannelsRequest)\n- [1.1.1](/php/docs/reference/cloud-eventarc/1.1.1/V1.ListChannelsRequest)\n- [1.0.5](/php/docs/reference/cloud-eventarc/1.0.5/V1.ListChannelsRequest) \nReference documentation and code samples for the Google Cloud Eventarc V1 Client class ListChannelsRequest.\n\nThe request message for the ListChannels method.\n\nGenerated from protobuf message `google.cloud.eventarc.v1.ListChannelsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Eventarc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent collection to list channels on.\n\n### setParent\n\nRequired. The parent collection to list channels on.\n\n### getPageSize\n\nThe maximum number of channels to return on each page.\n\nNote: The service may send fewer.\n\n### setPageSize\n\nThe maximum number of channels to return on each page.\n\nNote: The service may send fewer.\n\n### getPageToken\n\nThe page token; provide the value from the `next_page_token` field in a\nprevious `ListChannels` call to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListChannels` must\nmatch the call that provided the page token.\n\n### setPageToken\n\nThe page token; provide the value from the `next_page_token` field in a\nprevious `ListChannels` call to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListChannels` must\nmatch the call that provided the page token.\n\n### getOrderBy\n\nThe sorting order of the resources returned. Value should be a\ncomma-separated list of fields. The default sorting order is ascending. To\nspecify descending order for a field, append a `desc` suffix; for example:\n`name desc, channel_id`.\n\n### setOrderBy\n\nThe sorting order of the resources returned. Value should be a\ncomma-separated list of fields. The default sorting order is ascending. To\nspecify descending order for a field, append a `desc` suffix; for example:\n`name desc, channel_id`.\n\n### static::build"]]
