Class: GetStream::Generated::Models::CreateCommandRequest

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

Overview

Create a new command

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 = {}) ⇒ CreateCommandRequest

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @description = attributes[:description] || attributes['description']
  @name = attributes[:name] || attributes['name']
  @args = attributes[:args] || attributes['args'] || nil
  @set = attributes[:set] || attributes['set'] || nil
end

Instance Attribute Details

#args ⇒ String

Returns Arguments help text, shown in commands auto-completion.

Returns:

  • (String) —

    Arguments help text, shown in commands auto-completion



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

def args
  @args
end

#description ⇒ String

Returns Description, shown in commands auto-completion.

Returns:

  • (String) —

    Description, shown in commands auto-completion



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

def description
  @description
end

#name ⇒ String

Returns Unique command name.

Returns:

  • (String) —

    Unique command name



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

def name
  @name
end

#set ⇒ String

Returns Set name used for grouping commands.

Returns:

  • (String) —

    Set name used for grouping commands



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

def set
  @set
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/create_command_request.rb', line 35

def self.json_field_mappings
  {
    description: 'description',
    name: 'name',
    args: 'args',
    set: 'set'
  }
end