Class: Aws::Deadline::Types::ListStepConsumersRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::ListStepConsumersRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #farm_id ⇒ String

  The farm ID for the list of step consumers.

• #job_id ⇒ String

  The job ID for the step consumer.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  The token for the next set of results, or null to start from the beginning.

• #queue_id ⇒ String

  The queue ID for the step consumer.

• #step_id ⇒ String

  The step ID to include on the list.

Instance Attribute Details

#farm_id ⇒ String

The farm ID for the list of step consumers.

Returns:

• (String)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID for the step consumer.

Returns:

• (String)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

• (Integer)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results, or null to start from the beginning.

Returns:

• (String)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end

#queue_id ⇒ String

The queue ID for the step consumer.

Returns:

• (String)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end

#step_id ⇒ String

The step ID to include on the list.

Returns:

• (String)

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

class ListStepConsumersRequest < Struct.new(
  :farm_id,
  :job_id,
  :max_results,
  :next_token,
  :queue_id,
  :step_id)
  SENSITIVE = []
  include Aws::Structure
end