Google Cloud Video Live Stream V1 Client - Class CreateChannelRequest (0.5.0)

Version 0.5.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.7.5
• 0.6.2
• 0.5.0
• 0.4.2
• 0.3.2
• 0.2.6

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

Request message for "LivestreamService.CreateChannel".

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__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: projects/{project}/locations/{location}.
↳ channel	Google\Cloud\Video\LiveStream\V1\Channel Required. The channel resource to be created.
↳ channel_id	string Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.
↳ request_id	string A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

getChannel

Required. The channel resource to be created.

Returns
Type	Description
Google\Cloud\Video\LiveStream\V1\Channel|null

hasChannel

clearChannel

setChannel

Required. The channel resource to be created.

Parameter
Name	Description
var	Google\Cloud\Video\LiveStream\V1\Channel

Returns
Type	Description
$this

getChannelId

Required. The ID of the channel resource to be created.

This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

Returns
Type	Description
string

setChannelId

Required. The ID of the channel resource to be created.

This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRequestId

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type	Description
string

setRequestId

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}. Please see Google\Cloud\Video\LiveStream\V1\LivestreamServiceClient::locationName() for help formatting this field.
channel	Google\Cloud\Video\LiveStream\V1\Channel Required. The channel resource to be created.
channelId	string Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

Returns
Type	Description
Google\Cloud\Video\LiveStream\V1\CreateChannelRequest