Google Cloud Video Transcoder V1beta1 Client - Class Job (0.10.3)

Version 0.10.3

• 0.10.5 (latest)
• 0.10.4
• 0.9.1
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Namespace

Google \ Cloud \ Video \ Transcoder \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
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	Google\Cloud\Video\Transcoder\V1beta1\JobConfig The configuration for this job.
↳ 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	Google\Cloud\Video\Transcoder\V1beta1\Job\OriginUri Output only. The origin URI. Note: This feature is not yet available.
↳ 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. Note: This feature is not yet available.
↳ 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. Note: This feature is not yet available.
↳ 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.

getName

The resource name of the job.

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

Returns
Type	Description
string

setName

The resource name of the job.

Format: projects/{project}/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).

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).

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/.

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/.

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.

Preset Transcoder templates:

• preset/{preset_id}
• 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.

Preset Transcoder templates:

• preset/{preset_id}
• 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\V1beta1\JobConfig|null

hasConfig

setConfig

The configuration for this job.

Parameter
Name	Description
var	Google\Cloud\Video\Transcoder\V1beta1\JobConfig

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getOriginUri

Output only. The origin URI.

Note: This feature is not yet available.

Returns
Type	Description
Google\Cloud\Video\Transcoder\V1beta1\Job\OriginUri|null

hasOriginUri

clearOriginUri

setOriginUri

Output only. The origin URI.

Note: This feature is not yet available.

Parameter
Name	Description
var	Google\Cloud\Video\Transcoder\V1beta1\Job\OriginUri

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

getProgress

Output only. Estimated fractional progress, from 0 to 1 for each step.

Note: This feature is not yet available.

Returns
Type	Description
Google\Cloud\Video\Transcoder\V1beta1\Progress|null

hasProgress

clearProgress

setProgress

Output only. Estimated fractional progress, from 0 to 1 for each step.

Note: This feature is not yet available.

Parameter
Name	Description
var	Google\Cloud\Video\Transcoder\V1beta1\Progress

Returns
Type	Description
$this

getFailureReason

Output only. A description of the reason for the failure. This property is always present when state is FAILED.

Returns
Type	Description
string

setFailureReason

Output only. A description of the reason for the failure. This property is always present when state is FAILED.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFailureDetails

Output only. List of failure details. This property may contain additional information about the failure when failure_reason is present.

Note: This feature is not yet available.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setFailureDetails

Output only. List of failure details. This property may contain additional information about the failure when failure_reason is present.

Note: This feature is not yet available.

Parameter
Name	Description
var	array<Google\Cloud\Video\Transcoder\V1beta1\FailureDetail>

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

getJobConfig

Returns
Type	Description
string