Google Cloud Video Live Stream V1 Client - Class UpdateInputRequest (1.1.2)

Version latest

• 1.1.2 (latest)
• 1.1.1
• 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 UpdateInputRequest.

Request message for "LivestreamService.UpdateInput".

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

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 Input resource by the update. You can only update the following fields: * * preprocessingConfig * * securityRules 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.
↳ input	Input Required. The input 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 Input resource by the update. You can only update the following fields:

• preprocessingConfig
• securityRules 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.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

• preprocessingConfig
• securityRules 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.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getInput

Required. The input resource to be updated.

Returns
Type	Description
Input|null

hasInput

clearInput

setInput

Required. The input resource to be updated.

Parameter
Name	Description
var	Input

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
input	Input Required. The input resource to be updated.
updateMask	Google\Protobuf\FieldMask Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields: preprocessingConfig securityRules 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.

Returns
Type	Description
UpdateInputRequest