Google Cloud Video Live Stream V1 Client - Class UpdateChannelRequest (0.2.6)

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

Request message for "LivestreamService.UpdateChannel".

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ update_mask`	`Google\Protobuf\FieldMask` Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields: * `inputAttachments` * `output` * `elementaryStreams` * `muxStreams` * `manifests` * `spritesheets` The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
`↳ channel`	`Google\Cloud\Video\LiveStream\V1\Channel` Required. The channel resource to be updated.
`↳ 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)`.

getUpdateMask

Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

inputAttachments
output
elementaryStreams
muxStreams
manifests
spritesheets The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

inputAttachments
output
elementaryStreams
muxStreams
manifests
spritesheets The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getChannel

Required. The channel resource to be updated.

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

hasChannel

clearChannel

setChannel

Required. The channel resource to be updated.

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

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`