Google Cloud Video Live Stream V1 Client - Class StopChannelRequest (0.6.1)

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

Request message for "LivestreamService.StopChannel".

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ 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).

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the channel 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\StopChannelRequest