Class: GetStream::Generated::Models::CreatePredefinedFilterRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/create_predefined_filter_request.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 = {}) ⇒ CreatePredefinedFilterRequest

Initialize with attributes



29
30
31
32
33
34
35
36
 
# File 'lib/getstream_ruby/generated/models/create_predefined_filter_request.rb', line 29

def initialize(attributes = {})
  super(attributes)
  @name = attributes[:name] || attributes['name']
  @operation = attributes[:operation] || attributes['operation']
  @filter = attributes[:filter] || attributes['filter']
  @description = attributes[:description] || attributes['description'] || nil
  @sort = attributes[:sort] || attributes['sort'] || nil
end

Instance Attribute Details

#description ⇒ String

Returns The description of the predefined filter.

Returns:

  • (String) —

    The description of the predefined filter



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

def description
  @description
end

#filter ⇒ Object

Returns Filter to apply to the query.

Returns:

  • (Object) —

    Filter to apply to the query



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

def filter
  @filter
end

#name ⇒ String

Returns The unique name of the predefined filter (alphanumeric, _, - only).

Returns:

  • (String) —

    The unique name of the predefined filter (alphanumeric, _, - only)



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

def name
  @name
end

#operation ⇒ String

Returns The operation this filter is for (e.g., QueryChannels).

Returns:

  • (String) —

    The operation this filter is for (e.g., QueryChannels)



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

def operation
  @operation
end

#sort ⇒ Array<Object>

Returns:

  • (Array<Object>) 


26
27
28
 
# File 'lib/getstream_ruby/generated/models/create_predefined_filter_request.rb', line 26

def sort
  @sort
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



39
40
41
42
43
44
45
46
47
 
# File 'lib/getstream_ruby/generated/models/create_predefined_filter_request.rb', line 39

def self.json_field_mappings
  {
    name: 'name',
    operation: 'operation',
    filter: 'filter',
    description: 'description',
    sort: 'sort'
  }
end