Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class CreateEventRequest.
Request message for "LivestreamService.CreateEvent".
Generated from protobuf message google.cloud.video.livestream.v1.CreateEventRequest
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent channel for the resource, in the form of: |
↳ event |
Event
Required. The event resource to be created. |
↳ event_id |
string
Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with |
↳ 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 |
getParent
Required. The parent channel for the resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent channel for the resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvent
Required. The event resource to be created.
| Returns | |
|---|---|
| Type | Description |
Event|null |
|
hasEvent
clearEvent
setEvent
Required. The event resource to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
Event
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventId
Required. The ID of the event resource to be created.
This value must be 1-63 characters, begin and end with [a-z0-9],
could contain dashes (-) in between.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEventId
Required. The ID of the event resource to be created.
This value must be 1-63 characters, begin and end with [a-z0-9],
could contain dashes (-) in between.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 |
parent |
string
Required. The parent channel for the resource, in the form of:
|
event |
Event
Required. The event resource to be created. |
eventId |
string
Required. The ID of the event resource to be created.
This value must be 1-63 characters, begin and end with |
| Returns | |
|---|---|
| Type | Description |
CreateEventRequest |
|