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.



1135
1136
1137
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1135

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

Instance Attribute Details

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

Job configuration Corresponds to the JSON property config

Returns:



1053
1054
1055
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1053

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


1058
1059
1060
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1058

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


1063
1064
1065
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1063

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:



1073
1074
1075
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1073

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) 


1083
1084
1085
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1083

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


1089
1090
1091
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1089

def labels
  @labels
end

#mode ⇒ String

The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE. Corresponds to the JSON property mode

Returns:

  • (String) 


1094
1095
1096
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1094

def mode
  @mode
end

#name ⇒ String

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

Returns:

  • (String) 


1100
1101
1102
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1100

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) 


1109
1110
1111
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1109

def output_uri
  @output_uri
end

#start_time ⇒ String

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

Returns:

  • (String) 


1114
1115
1116
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1114

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1119
1120
1121
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1119

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, which is the only supported preset. User defined JobTemplate: job_template_id Corresponds to the JSON property templateId

Returns:

  • (String) 


1126
1127
1128
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1126

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) 


1133
1134
1135
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1133

def ttl_after_completion_days
  @ttl_after_completion_days
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1140

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)
  @mode = args[:mode] if args.key?(:mode)
  @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