Class: Aws::Deadline::Types::StepSearchSummary

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::StepSearchSummary

Defined in:

gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb

Overview

The details of a step search.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The date and time the resource was created.

• #created_by ⇒ String

  The user or system that created this resource.

• #ended_at ⇒ Time

  The date and time the resource ended running.

• #job_id ⇒ String

  The job ID.

• #lifecycle_status ⇒ String

  The life cycle status.

• #lifecycle_status_message ⇒ String

  The life cycle status message.

• #name ⇒ String

  The step name.

• #parameter_space ⇒ Types::ParameterSpace

  The parameters and combination expressions for the search.

• #queue_id ⇒ String

  The queue ID.

• #started_at ⇒ Time

  The date and time the resource started running.

• #step_id ⇒ String

  The step ID.

• #target_task_run_status ⇒ String

  The task status to update the job's tasks to.

• #task_failure_retry_count ⇒ Integer

  The total number of times tasks from the step failed and were retried.

• #task_run_status ⇒ String

  The task run status for the job.

• #task_run_status_counts ⇒ Hash<String,Integer>

  The number of tasks running on the job.

• #updated_at ⇒ Time

  The date and time the resource was updated.

• #updated_by ⇒ String

  The user or system that updated this resource.

Instance Attribute Details

#created_at ⇒ Time

The date and time the resource was created.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ String

The user or system that created this resource.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#ended_at ⇒ Time

The date and time the resource ended running.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_status ⇒ String

The life cycle status.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_status_message ⇒ String

The life cycle status message.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The step name.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_space ⇒ Types::ParameterSpace

The parameters and combination expressions for the search.

Returns:

• (Types::ParameterSpace)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#queue_id ⇒ String

The queue ID.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Time

The date and time the resource started running.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#step_id ⇒ String

The step ID.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#target_task_run_status ⇒ String

The task status to update the job's tasks to.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#task_failure_retry_count ⇒ Integer

The total number of times tasks from the step failed and were retried.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#task_run_status ⇒ String

The task run status for the job.

• PENDING–pending and waiting for resources.

• READY–ready to be processed.

• ASSIGNED–assigned and will run next on a worker.

• SCHEDULED–scheduled to be run on a worker.

• INTERRUPTING–being interrupted.

• RUNNING–running on a worker.

• SUSPENDED–the task is suspended.

• CANCELED–the task has been canceled.

• FAILED–the task has failed.

• SUCCEEDED–the task has succeeded.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#task_run_status_counts ⇒ Hash<String,Integer>

The number of tasks running on the job.

Returns:

• (Hash<String,Integer>)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the resource was updated.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end

#updated_by ⇒ String

The user or system that updated this resource.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 8975

class StepSearchSummary < Struct.new(
  :step_id,
  :job_id,
  :queue_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :created_at,
  :created_by,
  :started_at,
  :ended_at,
  :updated_at,
  :updated_by,
  :parameter_space)
  SENSITIVE = []
  include Aws::Structure
end