Class: Google::Apis::TranscoderV1::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/transcoder_v1/classes.rb,
lib/google/apis/transcoder_v1/representations.rb,
lib/google/apis/transcoder_v1/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.



1036
1037
1038
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1036

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

Instance Attribute Details

#config ⇒ Google::Apis::TranscoderV1::JobConfig

Job configuration Corresponds to the JSON property config

Returns:



959
960
961
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 959

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


964
965
966
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 964

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


969
970
971
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 969

def end_time
  @end_time
end

#error ⇒ Google::Apis::TranscoderV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



979
980
981
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 979

def error
  @error
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). See Supported input and output formats. Corresponds to the JSON property inputUri

Returns:

  • (String) 


989
990
991
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 989

def input_uri
  @input_uri
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


995
996
997
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 995

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1001
1002
1003
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1001

def name
  @name
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/. See Supported input and output formats. Corresponds to the JSON property outputUri

Returns:

  • (String) 


1010
1011
1012
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1010

def output_uri
  @output_uri
end

#start_time ⇒ String

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

Returns:

  • (String) 


1015
1016
1017
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1015

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1020
1021
1022
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1020

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) 


1027
1028
1029
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1027

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) 


1034
1035
1036
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1034

def ttl_after_completion_days
  @ttl_after_completion_days
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1041

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)
  @error = args[:error] if args.key?(:error)
  @input_uri = args[:input_uri] if args.key?(:input_uri)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @output_uri = args[:output_uri] if args.key?(:output_uri)
  @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