Class: Google::Apis::TranscoderV1beta1::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/transcoder_v1beta1/classes.rb,
lib/google/apis/transcoder_v1beta1/representations.rb,
lib/google/apis/transcoder_v1beta1/representations.rb

Overview

Transcoding job resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



808
809
810
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 808

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#config ⇒ Google::Apis::TranscoderV1beta1::JobConfig

Job configuration Corresponds to the JSON property config

Returns:



722
723
724
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 722

def config
  @config
end

#create_time ⇒ String

Output only. The time the job was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


727
728
729
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 727

def create_time
  @create_time
end

#end_time ⇒ String

Output only. The time the transcoding finished. Corresponds to the JSON property endTime

Returns:

  • (String) 


732
733
734
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 732

def end_time
  @end_time
end

#failure_details ⇒ Array<Google::Apis::TranscoderV1beta1::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. Corresponds to the JSON property failureDetails

Returns:



739
740
741
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 739

def failure_details
  @failure_details
end

#failure_reason ⇒ String

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

Returns:

  • (String) 


745
746
747
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 745

def failure_reason
  @failure_reason
end

#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). Corresponds to the JSON property inputUri

Returns:

  • (String) 


753
754
755
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 753

def input_uri
  @input_uri
end

#name ⇒ String

The resource name of the job. Format: projects/project/locations/location/ jobs/job`` Corresponds to the JSON property name

Returns:

  • (String) 


759
760
761
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 759

def name
  @name
end

#origin_uri ⇒ Google::Apis::TranscoderV1beta1::OriginUri

The origin URI. Corresponds to the JSON property originUri

Returns:



764
765
766
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 764

def origin_uri
  @origin_uri
end

#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/. Corresponds to the JSON property outputUri

Returns:

  • (String) 


771
772
773
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 771

def output_uri
  @output_uri
end

#priority ⇒ Fixnum

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. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


777
778
779
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 777

def priority
  @priority
end

#progress ⇒ Google::Apis::TranscoderV1beta1::Progress

Estimated fractional progress for each step, from 0 to 1. Corresponds to the JSON property progress

Returns:



782
783
784
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 782

def progress
  @progress
end

#start_time ⇒ String

Output only. The time the transcoding started. Corresponds to the JSON property startTime

Returns:

  • (String) 


787
788
789
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 787

def start_time
  @start_time
end

#state ⇒ String

Output only. The current state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


792
793
794
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 792

def state
  @state
end

#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`` Corresponds to the JSON property templateId

Returns:

  • (String) 


799
800
801
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 799

def template_id
  @template_id
end

#ttl_after_completion_days ⇒ Fixnum

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. Corresponds to the JSON property ttlAfterCompletionDays

Returns:

  • (Fixnum) 


806
807
808
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 806

def ttl_after_completion_days
  @ttl_after_completion_days
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 813

def update!(**args)
  @config = args[:config] if args.key?(:config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @failure_details = args[:failure_details] if args.key?(:failure_details)
  @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
  @input_uri = args[:input_uri] if args.key?(:input_uri)
  @name = args[:name] if args.key?(:name)
  @origin_uri = args[:origin_uri] if args.key?(:origin_uri)
  @output_uri = args[:output_uri] if args.key?(:output_uri)
  @priority = args[:priority] if args.key?(:priority)
  @progress = args[:progress] if args.key?(:progress)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @template_id = args[:template_id] if args.key?(:template_id)
  @ttl_after_completion_days = args[:ttl_after_completion_days] if args.key?(:ttl_after_completion_days)
end