Class: Aws::Deadline::Types::CreateJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Deadline::Types::CreateJobRequest
- Defined in:
- gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:parameters, :template]
Instance Attribute Summary collapse
-
#attachments ⇒ Types::Attachments
The attachments for the job.
-
#client_token ⇒ String
The unique token which the server uses to recognize retries of the same request.
-
#farm_id ⇒ String
The farm ID of the farm to connect to the job.
-
#max_failed_tasks_count ⇒ Integer
The number of task failures before the job stops running and is marked as
FAILED
. -
#max_retries_per_task ⇒ Integer
The maximum number of retries for a job.
-
#parameters ⇒ Hash<String,Types::JobParameter>
The parameters for the job.
-
#priority ⇒ Integer
The priority of the job on a scale of 1 to 100.
-
#queue_id ⇒ String
The ID of the queue that the job is submitted to.
-
#storage_profile_id ⇒ String
The storage profile ID for the storage profile to connect to the job.
-
#target_task_run_status ⇒ String
The initial status of the job's tasks when they are created.
-
#template ⇒ String
The job template to use for this job.
-
#template_type ⇒ String
The file type for the job template.
Instance Attribute Details
#attachments ⇒ Types::Attachments
The attachments for the job. Attach files required for the job to run to a render job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#client_token ⇒ String
The unique token which the server uses to recognize retries of the same request.
A suitable default value is auto-generated. You should normally not need to pass this option.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#farm_id ⇒ String
The farm ID of the farm to connect to the job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#max_failed_tasks_count ⇒ Integer
The number of task failures before the job stops running and is
marked as FAILED
.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#max_retries_per_task ⇒ Integer
The maximum number of retries for a job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#parameters ⇒ Hash<String,Types::JobParameter>
The parameters for the job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#priority ⇒ Integer
The priority of the job on a scale of 1 to 100. The highest priority is 1.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#queue_id ⇒ String
The ID of the queue that the job is submitted to.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#storage_profile_id ⇒ String
The storage profile ID for the storage profile to connect to the job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#target_task_run_status ⇒ String
The initial status of the job's tasks when they are created. Tasks
that are created with a SUSPENDED
status will not run until you
update their status.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#template ⇒ String
The job template to use for this job.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |
#template_type ⇒ String
The file type for the job template.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1116 class CreateJobRequest < Struct.new( :attachments, :client_token, :farm_id, :max_failed_tasks_count, :max_retries_per_task, :parameters, :priority, :queue_id, :storage_profile_id, :target_task_run_status, :template, :template_type) SENSITIVE = [:parameters, :template] include Aws::Structure end |