Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class Job.
Transcoding job resource.
Generated from protobuf message google.cloud.video.transcoder.v1.Job
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the job. Format: |
↳ input_uri |
string
Input only. Specify the |
↳ output_uri |
string
Input only. Specify the |
↳ template_id |
string
Input only. Specify the |
↳ config |
Google\Cloud\Video\Transcoder\V1\JobConfig
The configuration for this job. |
↳ state |
int
Output only. The current state of the job. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time the job was created. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The time the transcoding started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time the transcoding finished. |
↳ ttl_after_completion_days |
int
Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30. |
↳ labels |
array|Google\Protobuf\Internal\MapField
The labels associated with this job. You can use these to organize and group your jobs. |
↳ error |
Google\Rpc\Status
Output only. An error object that describes the reason for the failure. This property is always present when |
↳ mode |
int
The processing mode of the job. The default is |
getName
The resource name of the job.
Format: projects/{project_number}/locations/{location}/jobs/{job}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name of the job.
Format: projects/{project_number}/locations/{location}/jobs/{job}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputUri
Input only. Specify the input_uri to populate empty uri fields in each
element of Job.config.inputs or JobTemplate.config.inputs when using
template. URI of the media. Input files must be at least 5 seconds in
duration and stored in Cloud Storage (for example,
gs://bucket/inputs/file.mp4). See Supported input and output
formats.
| Returns | |
|---|---|
| Type | Description |
string | |
setInputUri
Input only. Specify the input_uri to populate empty uri fields in each
element of Job.config.inputs or JobTemplate.config.inputs when using
template. URI of the media. Input files must be at least 5 seconds in
duration and stored in Cloud Storage (for example,
gs://bucket/inputs/file.mp4). See Supported input and output
formats.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputUri
Input only. Specify the output_uri to populate an empty
Job.config.output.uri or JobTemplate.config.output.uri when using
template. URI for the output file(s). For example,
gs://my-bucket/outputs/. See Supported input and output
formats.
| Returns | |
|---|---|
| Type | Description |
string | |
setOutputUri
Input only. Specify the output_uri to populate an empty
Job.config.output.uri or JobTemplate.config.output.uri when using
template. URI for the output file(s). For example,
gs://my-bucket/outputs/. See Supported input and output
formats.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTemplateId
Input only. Specify the template_id to use for populating Job.config.
The default is preset/web-hd, which is the only supported preset.
User defined JobTemplate: {job_template_id}
| Returns | |
|---|---|
| Type | Description |
string | |
hasTemplateId
setTemplateId
Input only. Specify the template_id to use for populating Job.config.
The default is preset/web-hd, which is the only supported preset.
User defined JobTemplate: {job_template_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfig
The configuration for this job.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Transcoder\V1\JobConfig|null | |
hasConfig
setConfig
The configuration for this job.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Transcoder\V1\JobConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the job.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time the job was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the job was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Output only. The time the transcoding started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Output only. The time the transcoding started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. The time the transcoding finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. The time the transcoding finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTtlAfterCompletionDays
Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
| Returns | |
|---|---|
| Type | Description |
int | |
setTtlAfterCompletionDays
Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
The labels associated with this job. You can use these to organize and group your jobs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
The labels associated with this job. You can use these to organize and group your jobs.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. An error object that describes the reason for the failure.
This property is always present when state is FAILED.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. An error object that describes the reason for the failure.
This property is always present when state is FAILED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
The processing mode of the job.
The default is PROCESSING_MODE_INTERACTIVE.
| Returns | |
|---|---|
| Type | Description |
int | |
setMode
The processing mode of the job.
The default is PROCESSING_MODE_INTERACTIVE.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobConfig
| Returns | |
|---|---|
| Type | Description |
string | |