Class: GetStream::Generated::Models::SearchWarning

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/search_warning.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ SearchWarning

Initialize with attributes



26
27
28
29
30
31
32
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 26

def initialize(attributes = {})
  super(attributes)
  @warning_code = attributes[:warning_code] || attributes['warning_code']
  @warning_description = attributes[:warning_description] || attributes['warning_description']
  @channel_search_count = attributes[:channel_search_count] || attributes['channel_search_count'] || nil
  @channel_search_cids = attributes[:channel_search_cids] || attributes['channel_search_cids'] || nil
end

Instance Attribute Details

#channel_search_cids ⇒ Array<String>

Returns Channel CIDs for the searched channels.

Returns:

  • (Array<String>) —

    Channel CIDs for the searched channels



23
24
25
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 23

def channel_search_cids
  @channel_search_cids
end

#channel_search_count ⇒ Integer

Returns Number of channels searched.

Returns:

  • (Integer) —

    Number of channels searched



20
21
22
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 20

def channel_search_count
  @channel_search_count
end

#warning_code ⇒ Integer

Returns Code corresponding to the warning.

Returns:

  • (Integer) —

    Code corresponding to the warning



14
15
16
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 14

def warning_code
  @warning_code
end

#warning_description ⇒ String

Returns Description of the warning.

Returns:

  • (String) —

    Description of the warning



17
18
19
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 17

def warning_description
  @warning_description
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



35
36
37
38
39
40
41
42
 
# File 'lib/getstream_ruby/generated/models/search_warning.rb', line 35

def self.json_field_mappings
  {
    warning_code: 'warning_code',
    warning_description: 'warning_description',
    channel_search_count: 'channel_search_count',
    channel_search_cids: 'channel_search_cids'
  }
end