Class: Aws::Deadline::Types::SearchJobsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::SearchJobsRequest

Defined in:

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

Overview

Shared input fields for all Search operations (filterExpressions, sortExpressions, itemOffset, pageSize).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #farm_id ⇒ String

  The farm ID of the job.

• #filter_expressions ⇒ Types::SearchGroupedFilterExpressions

  The search terms for a resource.

• #item_offset ⇒ Integer

  The offset for the search results.

• #page_size ⇒ Integer

  Specifies the number of results to return.

• #queue_ids ⇒ Array<String>

  The queue ID to use in the job search.

• #sort_expressions ⇒ Array<Types::SearchSortExpression>

  The search terms for a resource.

Instance Attribute Details

#farm_id ⇒ String

The farm ID of the job.

Returns:

• (String)

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

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

#filter_expressions ⇒ Types::SearchGroupedFilterExpressions

The search terms for a resource.

Returns:

• (Types::SearchGroupedFilterExpressions)

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

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

#item_offset ⇒ Integer

The offset for the search results.

Returns:

• (Integer)

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

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

#page_size ⇒ Integer

Specifies the number of results to return.

Returns:

• (Integer)

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

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

#queue_ids ⇒ Array<String>

The queue ID to use in the job search.

Returns:

• (Array<String>)

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

class SearchJobsRequest < Struct.new(
  :farm_id,
  :filter_expressions,
  :sort_expressions,
  :item_offset,
  :page_size,
  :queue_ids)
  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 9738

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