Transcoder V1 API - Class Google::Cloud::Video::Transcoder::V1::Job (v0.9.0)

Version 0.9.0

• 1.1.0 (latest)
• 1.0.1
• 0.13.0
• 0.12.2
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.2

Reference documentation and code samples for the Transcoder V1 API class Google::Cloud::Video::Transcoder::V1::Job.

Transcoding job resource.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#config

def config() -> ::Google::Cloud::Video::Transcoder::V1::JobConfig

Returns

• (::Google::Cloud::Video::Transcoder::V1::JobConfig) — The configuration for this job.

#config=

def config=(value) -> ::Google::Cloud::Video::Transcoder::V1::JobConfig

Parameter

• value (::Google::Cloud::Video::Transcoder::V1::JobConfig) — The configuration for this job.

Returns

• (::Google::Cloud::Video::Transcoder::V1::JobConfig) — The configuration for this job.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time the job was created.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time the transcoding finished.

#error

def error() -> ::Google::Rpc::Status

Returns

• (::Google::Rpc::Status) — Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

#input_uri

def input_uri() -> ::String

Returns

• (::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.

#input_uri=

def input_uri=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — The labels associated with this job. You can use these to organize and group your jobs.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — The labels associated with this job. You can use these to organize and group your jobs.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — The labels associated with this job. You can use these to organize and group your jobs.

#mode

def mode() -> ::Google::Cloud::Video::Transcoder::V1::Job::ProcessingMode

Returns

• (::Google::Cloud::Video::Transcoder::V1::Job::ProcessingMode) — The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.

#mode=

def mode=(value) -> ::Google::Cloud::Video::Transcoder::V1::Job::ProcessingMode

Parameter

• value (::Google::Cloud::Video::Transcoder::V1::Job::ProcessingMode) — The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.

Returns

• (::Google::Cloud::Video::Transcoder::V1::Job::ProcessingMode) — The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.

#name

def name() -> ::String

Returns

• (::String) — The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}

#name=

def name=(value) -> ::String

Parameter

• value (::String) — The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}

Returns

• (::String) — The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}

#output_uri

def output_uri() -> ::String

Returns

• (::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.

#output_uri=

def output_uri=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time the transcoding started.

#state

def state() -> ::Google::Cloud::Video::Transcoder::V1::Job::ProcessingState

Returns

• (::Google::Cloud::Video::Transcoder::V1::Job::ProcessingState) — Output only. The current state of the job.

#template_id

def template_id() -> ::String

Returns

• (::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}

#template_id=

def template_id=(value) -> ::String

Parameter

• value (::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}

Returns

• (::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}

#ttl_after_completion_days

def ttl_after_completion_days() -> ::Integer

Returns

• (::Integer) — 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.

#ttl_after_completion_days=

def ttl_after_completion_days=(value) -> ::Integer

Parameter

• value (::Integer) — 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

• (::Integer) — 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.