Method: projects.locations.channels.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
Try it!

List channels.

HTTP request

GET https://eventarc.googleapis.com/v1/{parent=projects/*/locations/*}/channels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

parent

string

Required. The parent collection to list channels on.

Authorization requires the following IAM permission on the specified resource parent :

eventarc.channels.list

Query parameters

Parameters

Parameters
`pageSize`	`integer` The maximum number of channels to return on each page. Note: The service may send fewer.
`pageToken`	`string` The page token; provide the value from the `nextPageToken` field in a previous `channels.list` call to retrieve the subsequent page. When paginating, all other parameters provided to `channels.list` must match the call that provided the page token.
`orderBy`	`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, channelId` .

pageSize

integer

The maximum number of channels to return on each page.

Note: The service may send fewer.

pageToken

string

The page token; provide the value from the nextPageToken field in a previous channels.list call to retrieve the subsequent page.

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

orderBy

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

Request body

The request body must be empty.

Response body

The response message for the channels.list method.

If successful, the response body contains data with the following structure:

JSON representation
{ "channels" : [ { object ( `Channel` ) } ] , "nextPageToken" : string , "unreachable" : [ string ] }

Fields

Fields
`channels[]`	`object ( Channel )` The requested channels, up to the number specified in `pageSize` .
`nextPageToken`	`string` A page token that can be sent to `channels.list` to request the next page. If this is empty, then there are no more pages.
`unreachable[]`	`string` Unreachable resources, if any.

channels[]

object ( Channel )

The requested channels, up to the number specified in pageSize .

nextPageToken

string

A page token that can be sent to channels.list to request the next page. If this is empty, then there are no more pages.

unreachable[]

string

Unreachable resources, if any.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .