Class: Comet::WindowsCodeSignProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeWindowsCodeSignProperties

Returns a new instance of WindowsCodeSignProperties.



71
72
73
# File 'lib/comet/models/windows_code_sign_properties.rb', line 71

def initialize
  clear
end

Instance Attribute Details

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



69
70
71
# File 'lib/comet/models/windows_code_sign_properties.rb', line 69

def unknown_json_fields
  @unknown_json_fields
end

#windows_code_sign_azure_app_idObject

Returns the value of attribute windows_code_sign_azure_app_id.



56
57
58
# File 'lib/comet/models/windows_code_sign_properties.rb', line 56

def windows_code_sign_azure_app_id
  @windows_code_sign_azure_app_id
end

#windows_code_sign_azure_app_secretObject

Returns the value of attribute windows_code_sign_azure_app_secret.



63
64
65
# File 'lib/comet/models/windows_code_sign_properties.rb', line 63

def windows_code_sign_azure_app_secret
  @windows_code_sign_azure_app_secret
end

#windows_code_sign_azure_app_secret_formatObject

One of the ENCRYPTIONMETHOD_ constants



60
61
62
# File 'lib/comet/models/windows_code_sign_properties.rb', line 60

def windows_code_sign_azure_app_secret_format
  @windows_code_sign_azure_app_secret_format
end

#windows_code_sign_azure_cert_nameObject

Returns the value of attribute windows_code_sign_azure_cert_name.



53
54
55
# File 'lib/comet/models/windows_code_sign_properties.rb', line 53

def windows_code_sign_azure_cert_name
  @windows_code_sign_azure_cert_name
end

#windows_code_sign_azure_tenant_idObject

Returns the value of attribute windows_code_sign_azure_tenant_id.



66
67
68
# File 'lib/comet/models/windows_code_sign_properties.rb', line 66

def windows_code_sign_azure_tenant_id
  @windows_code_sign_azure_tenant_id
end

#windows_code_sign_azure_vault_nameObject

Returns the value of attribute windows_code_sign_azure_vault_name.



50
51
52
# File 'lib/comet/models/windows_code_sign_properties.rb', line 50

def windows_code_sign_azure_vault_name
  @windows_code_sign_azure_vault_name
end

#windows_code_sign_methodObject

One of the WINDOWSCODESIGN_METHOD_ constants



17
18
19
# File 'lib/comet/models/windows_code_sign_properties.rb', line 17

def windows_code_sign_method
  @windows_code_sign_method
end

#windows_code_sign_pkcs11certfileObject

This field was deprecated between 23.3.0 and 23.6.x, but is now used again.



37
38
39
# File 'lib/comet/models/windows_code_sign_properties.rb', line 37

def windows_code_sign_pkcs11certfile
  @windows_code_sign_pkcs11certfile
end

#windows_code_sign_pkcs11engineObject

Returns the value of attribute windows_code_sign_pkcs11engine.



30
31
32
# File 'lib/comet/models/windows_code_sign_properties.rb', line 30

def windows_code_sign_pkcs11engine
  @windows_code_sign_pkcs11engine
end

#windows_code_sign_pkcs11key_idObject

Returns the value of attribute windows_code_sign_pkcs11key_id.



40
41
42
# File 'lib/comet/models/windows_code_sign_properties.rb', line 40

def windows_code_sign_pkcs11key_id
  @windows_code_sign_pkcs11key_id
end

#windows_code_sign_pkcs11moduleObject

Returns the value of attribute windows_code_sign_pkcs11module.



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

def windows_code_sign_pkcs11module
  @windows_code_sign_pkcs11module
end

#windows_code_sign_pkcs11passwordObject

Returns the value of attribute windows_code_sign_pkcs11password.



47
48
49
# File 'lib/comet/models/windows_code_sign_properties.rb', line 47

def windows_code_sign_pkcs11password
  @windows_code_sign_pkcs11password
end

#windows_code_sign_pkcs11password_formatObject

One of the ENCRYPTIONMETHOD_ constants



44
45
46
# File 'lib/comet/models/windows_code_sign_properties.rb', line 44

def windows_code_sign_pkcs11password_format
  @windows_code_sign_pkcs11password_format
end

#windows_code_sign_pkcs12file_pathObject

Returns the value of attribute windows_code_sign_pkcs12file_path.



20
21
22
# File 'lib/comet/models/windows_code_sign_properties.rb', line 20

def windows_code_sign_pkcs12file_path
  @windows_code_sign_pkcs12file_path
end

#windows_code_sign_pkcs12passwordObject

Returns the value of attribute windows_code_sign_pkcs12password.



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

def windows_code_sign_pkcs12password
  @windows_code_sign_pkcs12password
end

#windows_code_sign_pkcs12password_formatObject

One of the ENCRYPTIONMETHOD_ constants



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

def windows_code_sign_pkcs12password_format
  @windows_code_sign_pkcs12password_format
end

Instance Method Details

#clearObject



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/comet/models/windows_code_sign_properties.rb', line 75

def clear
  @windows_code_sign_method = 0
  @windows_code_sign_pkcs12file_path = ''
  @windows_code_sign_pkcs12password_format = 0
  @windows_code_sign_pkcs12password = ''
  @windows_code_sign_pkcs11engine = ''
  @windows_code_sign_pkcs11module = ''
  @windows_code_sign_pkcs11certfile = ''
  @windows_code_sign_pkcs11key_id = ''
  @windows_code_sign_pkcs11password_format = 0
  @windows_code_sign_pkcs11password = ''
  @windows_code_sign_azure_vault_name = ''
  @windows_code_sign_azure_cert_name = ''
  @windows_code_sign_azure_app_id = ''
  @windows_code_sign_azure_app_secret_format = 0
  @windows_code_sign_azure_app_secret = ''
  @windows_code_sign_azure_tenant_id = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/comet/models/windows_code_sign_properties.rb', line 103

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 'WindowsCodeSignMethod'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @windows_code_sign_method = v
    when 'WindowsCodeSignPKCS12FilePath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs12file_path = v
    when 'WindowsCodeSignPKCS12PasswordFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @windows_code_sign_pkcs12password_format = v
    when 'WindowsCodeSignPKCS12Password'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs12password = v
    when 'WindowsCodeSignPKCS11Engine'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs11engine = v
    when 'WindowsCodeSignPKCS11Module'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs11module = v
    when 'WindowsCodeSignPKCS11Certfile'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs11certfile = v
    when 'WindowsCodeSignPKCS11KeyID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs11key_id = v
    when 'WindowsCodeSignPKCS11PasswordFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @windows_code_sign_pkcs11password_format = v
    when 'WindowsCodeSignPKCS11Password'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_pkcs11password = v
    when 'WindowsCodeSignAzureVaultName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_azure_vault_name = v
    when 'WindowsCodeSignAzureCertName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_azure_cert_name = v
    when 'WindowsCodeSignAzureAppID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_azure_app_id = v
    when 'WindowsCodeSignAzureAppSecretFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @windows_code_sign_azure_app_secret_format = v
    when 'WindowsCodeSignAzureAppSecret'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_azure_app_secret = v
    when 'WindowsCodeSignAzureTenantID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @windows_code_sign_azure_tenant_id = 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)


96
97
98
99
100
# File 'lib/comet/models/windows_code_sign_properties.rb', line 96

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



204
205
206
# File 'lib/comet/models/windows_code_sign_properties.rb', line 204

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/comet/models/windows_code_sign_properties.rb', line 179

def to_hash
  ret = {}
  ret['WindowsCodeSignMethod'] = @windows_code_sign_method
  ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
  ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
  ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
  ret['WindowsCodeSignPKCS11Engine'] = @windows_code_sign_pkcs11engine
  ret['WindowsCodeSignPKCS11Module'] = @windows_code_sign_pkcs11module
  ret['WindowsCodeSignPKCS11Certfile'] = @windows_code_sign_pkcs11certfile
  ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
  ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
  ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
  ret['WindowsCodeSignAzureVaultName'] = @windows_code_sign_azure_vault_name
  ret['WindowsCodeSignAzureCertName'] = @windows_code_sign_azure_cert_name
  ret['WindowsCodeSignAzureAppID'] = @windows_code_sign_azure_app_id
  ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
  ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
  ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
  @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



209
210
211
# File 'lib/comet/models/windows_code_sign_properties.rb', line 209

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