Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class ListChannelsRequest.
Request message for "LivestreamService.ListChannels".
Generated from protobuf message google.cloud.video.livestream.v1.ListChannelsRequest
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent location for the resource, in the form of: |
↳ 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 location for the resource, in the form of:
projects/{project}/locations/{location}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent location for the resource, in the form of:
projects/{project}/locations/{location}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The next_page_token value returned from a previous List request, if any.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The next_page_token value returned from a previous List request, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
The filter to apply to list results.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
The filter to apply to list results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent location for the resource, in the form of:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\LiveStream\V1\ListChannelsRequest | |