Method: projects.locations.channels.patch

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions

Updates the specified channel.

HTTP request

PATCH https://livestream.googleapis.com/v1/{channel.name=projects/*/locations/*/channels/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

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

channel.name

string

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

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` 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 updateMask 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 is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.
`requestId`	`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)`.

updateMask

string (FieldMask format)

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 updateMask 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 is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

requestId

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

Request body

The request body contains an instance of Channel.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

livestream.channels.update

For more information, see the IAM documentation.