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.



1410
1411
1412
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1410

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

Instance Attribute Details

#batch_mode_priority ⇒ Fixnum

The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job. Corresponds to the JSON property batchModePriority

Returns:

  • (Fixnum) 


1318
1319
1320
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1318

def batch_mode_priority
  @batch_mode_priority
end

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

Job configuration Corresponds to the JSON property config

Returns:



1323
1324
1325
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1323

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


1328
1329
1330
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1328

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


1333
1334
1335
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1333

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:



1343
1344
1345
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1343

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) 


1353
1354
1355
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1353

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


1359
1360
1361
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1359

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) 


1364
1365
1366
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1364

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) 


1370
1371
1372
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1370

def name
  @name
end

#optimization ⇒ String

Optional. The optimization strategy of the job. The default is AUTODETECT. Corresponds to the JSON property optimization

Returns:

  • (String) 


1375
1376
1377
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1375

def optimization
  @optimization
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) 


1384
1385
1386
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1384

def output_uri
  @output_uri
end

#start_time ⇒ String

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

Returns:

  • (String) 


1389
1390
1391
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1389

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1394
1395
1396
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1394

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) 


1401
1402
1403
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1401

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) 


1408
1409
1410
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1408

def ttl_after_completion_days
  @ttl_after_completion_days
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1415

def update!(**args)
  @batch_mode_priority = args[:batch_mode_priority] if args.key?(:batch_mode_priority)
  @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)
  @optimization = args[:optimization] if args.key?(:optimization)
  @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