Class: Aws::Deadline::Types::SearchTasksRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::SearchTasksRequest

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 of the task.

• #filter_expressions ⇒ Types::SearchGroupedFilterExpressions

  The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

• #item_offset ⇒ Integer

  Defines how far into the scrollable list to start the return of results.

• #job_id ⇒ String

  The job ID for the task search.

• #page_size ⇒ Integer

  Specifies the number of items per page for the resource.

• #queue_ids ⇒ Array<String>

  The queue IDs to include in the search.

• #sort_expressions ⇒ Array<Types::SearchSortExpression>

  The search terms for a resource.

Instance Attribute Details

#farm_id ⇒ String

The farm ID of the task.

Returns:

• (String)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#filter_expressions ⇒ Types::SearchGroupedFilterExpressions

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

Returns:

• (Types::SearchGroupedFilterExpressions)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#item_offset ⇒ Integer

Defines how far into the scrollable list to start the return of results.

Returns:

• (Integer)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID for the task search.

Returns:

• (String)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#page_size ⇒ Integer

Specifies the number of items per page for the resource.

Returns:

• (Integer)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#queue_ids ⇒ Array<String>

The queue IDs to include in the search.

Returns:

• (Array<String>)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end

#sort_expressions ⇒ Array<Types::SearchSortExpression>

The search terms for a resource.

Returns:

• (Array<Types::SearchSortExpression>)

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

class SearchTasksRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :item_offset,
  :job_id,
  :page_size,
  :queue_ids,
  :sort_expressions)
  SENSITIVE = []
  include Aws::Structure
end