Google Cloud Video Transcoder V1 Client - Class Job (0.6.0)

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
NameDescription
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. Preset Transcoder templates: - preset/{preset_id} - User defined JobTemplate: {job_template_id}

↳ 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 state is FAILED.

getName

The resource name of the job.

Format: projects/{project_number}/locations/{location}/jobs/{job}

Returns
TypeDescription
string

setName

The resource name of the job.

Format: projects/{project_number}/locations/{location}/jobs/{job}

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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}
Returns
TypeDescription
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}
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConfig

The configuration for this job.

Returns
TypeDescription
Google\Cloud\Video\Transcoder\V1\JobConfig|null

hasConfig

setConfig

The configuration for this job.

Parameter
NameDescription
var Google\Cloud\Video\Transcoder\V1\JobConfig
Returns
TypeDescription
$this

getState

Output only. The current state of the job.

Returns
TypeDescription
int

setState

Output only. The current state of the job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. The time the job was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the job was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getStartTime

Output only. The time the transcoding started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. The time the transcoding started.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

Output only. The time the transcoding finished.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time the transcoding finished.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getLabels

The labels associated with this job. You can use these to organize and group your jobs.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

The labels associated with this job. You can use these to organize and group your jobs.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getError

Output only. An error object that describes the reason for the failure.

This property is always present when state is FAILED.

Returns
TypeDescription
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
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getJobConfig

Returns
TypeDescription
string