Google Cloud Video Live Stream V1 Client - Class ListEventsRequest (0.6.2)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class ListEventsRequest.

Request message for "LivestreamService.ListEvents".

Generated from protobuf message google.cloud.video.livestream.v1.ListEventsRequest

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

↳ page_size int

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 next_page_token to determine if there are more items left to be queried.

↳ page_token string

The next_page_token value returned from a previous List request, if any.

↳ filter string

The filter to apply to list results.

↳ order_by string

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

getParent

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Returns
TypeDescription
string

setParent

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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 next_page_token to determine if there are more items left to be queried.

Returns
TypeDescription
int

setPageSize

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 next_page_token to determine if there are more items left to be queried.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The next_page_token value returned from a previous List request, if any.

Returns
TypeDescription
string

setPageToken

The next_page_token value returned from a previous List request, if any.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The filter to apply to list results.

Returns
TypeDescription
string

setFilter

The filter to apply to list results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Returns
TypeDescription
string

setOrderBy

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}. Please see Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient::channelName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\ListEventsRequest