Google Cloud Video Live Stream V1 Client - Class CreateDvrSessionRequest (1.2.0)

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

Request message for "LivestreamService.CreateDvrSession".

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/channels/{channelId} .

↳ dvr_session_id
string

Required. Id of the requesting object in the following form: 1. 1 character minimum, 63 characters maximum 2. Only contains letters, digits, underscores, and hyphens

↳ dvr_session
DvrSession

Required. The resource being created

↳ request_id
string

Optional. An optional 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 parent resource name, in the following form: projects/{project}/locations/{location}/channels/{channelId} .

Returns
Type
Description
string

setParent

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/channels/{channelId} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDvrSessionId

Required. Id of the requesting object in the following form:

  1. 1 character minimum, 63 characters maximum
  2. Only contains letters, digits, underscores, and hyphens
Returns
Type
Description
string

setDvrSessionId

Required. Id of the requesting object in the following form:

  1. 1 character minimum, 63 characters maximum
  2. Only contains letters, digits, underscores, and hyphens
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDvrSession

Required. The resource being created

Returns
Type
Description
DvrSession |null

hasDvrSession

clearDvrSession

setDvrSession

Required. The resource being created

Parameter
Name
Description
Returns
Type
Description
$this

getRequestId

Optional. An optional 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

Optional. An optional 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
parent
string

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/channels/{channelId} . Please see LivestreamServiceClient::channelName() for help formatting this field.

dvrSession
DvrSession

Required. The resource being created

dvrSessionId
string

Required. Id of the requesting object in the following form:

  1. 1 character minimum, 63 characters maximum
  2. Only contains letters, digits, underscores, and hyphens
Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: