Class: Aws::ConnectCases::Types::SearchAllRelatedItemsRequest

Inherits:

Struct

• Object
• Struct
• Aws::ConnectCases::Types::SearchAllRelatedItemsRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain_id ⇒ String

  The unique identifier of the Cases domain.

• #filters ⇒ Array<Types::RelatedItemTypeFilter>

  The list of types of related items and their parameters to use for filtering.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #next_token ⇒ String

  The token for the next set of results.

• #sorts ⇒ Array<Types::SearchAllRelatedItemsSort>

  A structured set of sort terms to specify the order in which related items should be returned.

Instance Attribute Details

#domain_id ⇒ String

The unique identifier of the Cases domain.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3057

class SearchAllRelatedItemsRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :filters,
  :sorts)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::RelatedItemTypeFilter>

The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.

Returns:

• (Array<Types::RelatedItemTypeFilter>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3057

class SearchAllRelatedItemsRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :filters,
  :sorts)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

• (Integer)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3057

class SearchAllRelatedItemsRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :filters,
  :sorts)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3057

class SearchAllRelatedItemsRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :filters,
  :sorts)
  SENSITIVE = []
  include Aws::Structure
end

#sorts ⇒ Array<Types::SearchAllRelatedItemsSort>

A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.

Returns:

• (Array<Types::SearchAllRelatedItemsSort>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3057

class SearchAllRelatedItemsRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :filters,
  :sorts)
  SENSITIVE = []
  include Aws::Structure
end