Google Cloud Video Stitcher V1 Client - Class CreateLiveConfigRequest (0.8.3)

Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class CreateLiveConfigRequest.

Request message for VideoStitcherService.createLiveConfig

Generated from protobuf message google.cloud.video.stitcher.v1.CreateLiveConfigRequest

Namespace

Google \ Cloud \ Video \ Stitcher \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The project in which the live config should be created, in the form of `projects/{project_number}/locations/{location}`.
`↳ live_config_id`	`string` Required. The unique identifier ID to use for the live config.
`↳ live_config`	`Google\Cloud\Video\Stitcher\V1\LiveConfig` Required. The live config resource to create.
`↳ 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)`.

getParent

Required. The project in which the live config should be created, in the form of projects/{project_number}/locations/{location}.

Returns
Type	Description
`string`

setParent

Required. The project in which the live config should be created, in the form of projects/{project_number}/locations/{location}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLiveConfigId

Required. The unique identifier ID to use for the live config.

Returns
Type	Description
`string`

setLiveConfigId

Required. The unique identifier ID to use for the live config.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLiveConfig

Required. The live config resource to create.

Returns
Type	Description
`Google\Cloud\Video\Stitcher\V1\LiveConfig\|null`

hasLiveConfig

clearLiveConfig

setLiveConfig

Required. The live config resource to create.

Parameter
Name	Description
`var`	`Google\Cloud\Video\Stitcher\V1\LiveConfig`

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`

static::build

Parameters
Name	Description
`parent`	`string` Required. The project in which the live config should be created, in the form of `projects/{project_number}/locations/{location}`. Please see Google\Cloud\Video\Stitcher\V1\VideoStitcherServiceClient::locationName() for help formatting this field.
`liveConfig`	`Google\Cloud\Video\Stitcher\V1\LiveConfig` Required. The live config resource to create.
`liveConfigId`	`string` Required. The unique identifier ID to use for the live config.

Returns
Type	Description
`Google\Cloud\Video\Stitcher\V1\CreateLiveConfigRequest`