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
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
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
* * inputConfig
* * output
* * elementaryStreams
* * muxStreams
* * manifests
* * spriteSheets
* * logConfig
* * timecodeConfig
* * encryptions
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. If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.
↳ channel
↳ 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 -
inputConfig -
output -
elementaryStreams -
muxStreams -
manifests -
spriteSheets -
logConfig -
timecodeConfig -
encryptionsThe 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.
If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.
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 -
inputConfig -
output -
elementaryStreams -
muxStreams -
manifests -
spriteSheets -
logConfig -
timecodeConfig -
encryptionsThe 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.
If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.
$this
getChannel
Required. The channel resource to be updated.
hasChannel
clearChannel
setChannel
Required. The channel resource to be updated.
$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)
.
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)
.
var
string
$this
static::build
channel
updateMask
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:
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.
If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.
