Class: Aws::ConnectCases::Types::SearchCasesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_id ⇒ String

The unique identifier of the Cases domain.

Returns:

  • (String) 


3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Array<Types::FieldIdentifier>

The list of field identifiers to be returned as part of the response.

Returns:



3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::CaseFilter

A list of filter objects.

Returns:



3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of cases to return. When no value is provided, 25 is the default.

Returns:

  • (Integer) 


3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  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) 


3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#search_term ⇒ String

A word or phrase used to perform a quick search.

Returns:

  • (String) 


3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end

#sorts ⇒ Array<Types::Sort>

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Returns:



3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 3128

class SearchCasesRequest < Struct.new(
  :domain_id,
  :max_results,
  :next_token,
  :search_term,
  :filter,
  :sorts,
  :fields)
  SENSITIVE = []
  include Aws::Structure
end