- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
Returns a list of all events in the specified channel.
HTTP request
GET https://livestream.googleapis.com/v1/{parent=projects/*/locations/*/channels/*}/events
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent channel for the resource, in the form of: |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's |
pageToken |
The nextPageToken value returned from a previous List request, if any. |
filter |
The filter to apply to list results. |
orderBy |
Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. |
Request body
The request body must be empty.
Response body
Response message for "LivestreamService.ListEvents".
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"events": [
{
object ( |
Fields | |
---|---|
events[] |
A list of events. |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[] |
Locations that could not be reached. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
livestream.events.list
For more information, see the IAM documentation.