Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class CreateSlateRequest.
Request message for VideoStitcherService.createSlate.
Generated from protobuf message google.cloud.video.stitcher.v1.CreateSlateRequest
Namespace
Google \ Cloud \ Video \ Stitcher \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The project in which the slate should be created, in the form of |
↳ slate_id |
string
Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
↳ slate |
Slate
Required. The slate 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 |
getParent
Required. The project in which the slate should be created, in the form of
projects/{project_number}/locations/{location}
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The project in which the slate should be created, in the form of
projects/{project_number}/locations/{location}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSlateId
Required. The unique identifier for the slate.
This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
Returns | |
---|---|
Type | Description |
string |
setSlateId
Required. The unique identifier for the slate.
This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSlate
Required. The slate to create.
Returns | |
---|---|
Type | Description |
Slate|null |
hasSlate
clearSlate
setSlate
Required. The slate to create.
Parameter | |
---|---|
Name | Description |
var |
Slate
|
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 project in which the slate should be created, in the form of
|
slate |
Slate
Required. The slate to create. |
slateId |
string
Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
Returns | |
---|---|
Type | Description |
CreateSlateRequest |