Reference documentation and code samples for the Google Cloud Video Transcoder V1beta1 Client class Job.
Transcoding job resource.
Generated from protobuf message google.cloud.video.transcoder.v1beta1.Job
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The resource name of the job. Format: projects/{project}/locations/{location}/jobs/{job}
↳ input_uri
string
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
).
↳ output_uri
string
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/
.
↳ template_id
string
Input only. Specify the template_id
to use for populating Job.config
. The default is preset/web-hd
. Preset Transcoder templates: - preset/{preset_id}
- User defined JobTemplate: {job_template_id}
↳ config
↳ priority
int
Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
↳ origin_uri
↳ state
int
Output only. The current state of the job.
↳ progress
Google\Cloud\Video\Transcoder\V1beta1\Progress
Output only. Estimated fractional progress, from 0
to 1
for each step.
↳ failure_reason
string
Output only. A description of the reason for the failure. This property is always present when state
is FAILED
.
↳ failure_details
array< Google\Cloud\Video\Transcoder\V1beta1\FailureDetail
>
Output only. List of failure details. This property may contain additional information about the failure when failure_reason
is present.
↳ create_time
↳ start_time
↳ end_time
↳ 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.
getName
The resource name of the job.
Format: projects/{project}/locations/{location}/jobs/{job}
string
setName
The resource name of the job.
Format: projects/{project}/locations/{location}/jobs/{job}
var
string
$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
).
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
).
var
string
$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/
.
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/
.
var
string
$this
getTemplateId
Input only. Specify the template_id
to use for populating Job.config
. The default
is preset/web-hd
.
Preset Transcoder templates:
-
preset/{preset_id} - User defined JobTemplate:
{job_template_id}
string
hasTemplateId
setTemplateId
Input only. Specify the template_id
to use for populating Job.config
. The default
is preset/web-hd
.
Preset Transcoder templates:
-
preset/{preset_id} - User defined JobTemplate:
{job_template_id}
var
string
$this
getConfig
The configuration for this job.
hasConfig
setConfig
The configuration for this job.
$this
getPriority
Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
int
setPriority
Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
var
int
$this
getOriginUri
Output only. The origin URI.
hasOriginUri
clearOriginUri
setOriginUri
Output only. The origin URI.
$this
getState
Output only. The current state of the job.
int
setState
Output only. The current state of the job.
var
int
$this
getProgress
Output only. Estimated fractional progress, from 0
to 1
for each
step.
hasProgress
clearProgress
setProgress
Output only. Estimated fractional progress, from 0
to 1
for each
step.
$this
getFailureReason
Output only. A description of the reason for the failure. This property is
always present when state
is FAILED
.
string
setFailureReason
Output only. A description of the reason for the failure. This property is
always present when state
is FAILED
.
var
string
$this
getFailureDetails
Output only. List of failure details. This property may contain additional
information about the failure when failure_reason
is present.
setFailureDetails
Output only. List of failure details. This property may contain additional
information about the failure when failure_reason
is present.
$this
getCreateTime
Output only. The time the job was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the job was created.
$this
getStartTime
Output only. The time the transcoding started.
hasStartTime
clearStartTime
setStartTime
Output only. The time the transcoding started.
$this
getEndTime
Output only. The time the transcoding finished.
hasEndTime
clearEndTime
setEndTime
Output only. The time the transcoding finished.
$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.
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.
var
int
$this
getJobConfig
string
