Class: Comet::SoftwareBuildRoleOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/software_build_role_options.rb

Overview

SoftwareBuildRoleOptions is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SoftwareBuildRoleOptions

Returns a new instance of SoftwareBuildRoleOptions.



29
30
31
 
# File 'lib/comet/models/software_build_role_options.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#allow_unauthenticated_downloads ⇒ Object

Returns the value of attribute allow_unauthenticated_downloads.



19
20
21
 
# File 'lib/comet/models/software_build_role_options.rb', line 19

def allow_unauthenticated_downloads
  @allow_unauthenticated_downloads
end

#max_builders ⇒ Object

0 will default to CPU core count - 2 This field is available in Comet 24.3.8 and later.



24
25
26
 
# File 'lib/comet/models/software_build_role_options.rb', line 24

def max_builders
  @max_builders
end

#role_enabled ⇒ Object

Returns the value of attribute role_enabled.



16
17
18
 
# File 'lib/comet/models/software_build_role_options.rb', line 16

def role_enabled
  @role_enabled
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



27
28
29
 
# File 'lib/comet/models/software_build_role_options.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



33
34
35
36
 
# File 'lib/comet/models/software_build_role_options.rb', line 33

def clear
  @max_builders = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/comet/models/software_build_role_options.rb', line 46

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'RoleEnabled'
      @role_enabled = v
    when 'AllowUnauthenticatedDownloads'
      @allow_unauthenticated_downloads = v
    when 'MaxBuilders'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @max_builders = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


39
40
41
42
43
 
# File 'lib/comet/models/software_build_role_options.rb', line 39

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



78
79
80
 
# File 'lib/comet/models/software_build_role_options.rb', line 78

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/comet/models/software_build_role_options.rb', line 66

def to_hash
  ret = {}
  ret['RoleEnabled'] = @role_enabled
  ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
  ret['MaxBuilders'] = @max_builders
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



83
84
85
 
# File 'lib/comet/models/software_build_role_options.rb', line 83

def to_json(options = {})
  to_hash.to_json(options)
end