Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class CreateClipRequest.
Request message for "LivestreamService.CreateClip".
Generated from protobuf message google.cloud.video.livestream.v1.CreateClipRequest
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 resource name, in the following form: |
↳ clip_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 |
↳ clip |
Clip
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/{channel}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource name, in the following form:
projects/{project}/locations/{location}/channels/{channel}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClipId
Required. Id of the requesting object in the following form:
- 1 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
| Returns | |
|---|---|
| Type | Description |
string |
|
setClipId
Required. Id of the requesting object in the following form:
- 1 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClip
Required. The resource being created
| Returns | |
|---|---|
| Type | Description |
Clip|null |
|
hasClip
clearClip
setClip
Required. The resource being created
| Parameter | |
|---|---|
| Name | Description |
var |
Clip
|
| 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:
|
clip |
Clip
Required. The resource being created |
clipId |
string
Required. Id of the requesting object in the following form:
|
| Returns | |
|---|---|
| Type | Description |
CreateClipRequest |
|