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.
data
array
Optional. Data for populating the Message object.
↳ name
string
The resource name of the job. Format: projects/{project_number}/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
). See Supported input and output formats
.
↳ 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/
. See Supported input and output formats
.
↳ template_id
string
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}
↳ config
↳ state
int
Output only. The current state of the job.
↳ 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.
↳ 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 state
is FAILED
.
↳ mode
int
The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE
.
getName
The resource name of the job.
Format: projects/{project_number}/locations/{location}/jobs/{job}
string
setName
The resource name of the job.
Format: projects/{project_number}/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
). See Supported input and output
formats
.
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
.
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/
. See Supported input and output
formats
.
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
.
var
string
$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}
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}
var
string
$this
getConfig
The configuration for this job.
hasConfig
setConfig
The configuration for this job.
$this
getState
Output only. The current state of the job.
int
setState
Output only. The current state of the job.
var
int
$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
getLabels
The labels associated with this job. You can use these to organize and group your jobs.
setLabels
The labels associated with this job. You can use these to organize and group your jobs.
$this
getError
Output only. An error object that describes the reason for the failure.
This property is always present when state
is FAILED
.
hasError
clearError
setError
Output only. An error object that describes the reason for the failure.
This property is always present when state
is FAILED
.
$this
getMode
The processing mode of the job.
The default is PROCESSING_MODE_INTERACTIVE
.
int
setMode
The processing mode of the job.
The default is PROCESSING_MODE_INTERACTIVE
.
var
int
$this
getJobConfig
string
