Class: Akeyless::GatewayCreateProducerGithub

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gateway_create_producer_github.rb

Overview

gatewayCreateProducerGithub is a command that creates github producer

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateProducerGithub

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



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
177
178
179
180
181
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayCreateProducerGithub` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::GatewayCreateProducerGithub`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'delete_protection')
    self.delete_protection = attributes[:'delete_protection']
  end

  if attributes.key?(:'github_app_id')
    self.github_app_id = attributes[:'github_app_id']
  end

  if attributes.key?(:'github_app_private_key')
    self.github_app_private_key = attributes[:'github_app_private_key']
  end

  if attributes.key?(:'github_base_url')
    self.github_base_url = attributes[:'github_base_url']
  else
    self.github_base_url = 'https://api.github.com/'
  end

  if attributes.key?(:'installation_id')
    self.installation_id = attributes[:'installation_id']
  end

  if attributes.key?(:'installation_repository')
    self.installation_repository = attributes[:'installation_repository']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'target_name')
    self.target_name = attributes[:'target_name']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'token_permissions')
    if (value = attributes[:'token_permissions']).is_a?(Array)
      self.token_permissions = value
    end
  end

  if attributes.key?(:'token_repositories')
    if (value = attributes[:'token_repositories']).is_a?(Array)
      self.token_repositories = value
    end
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end
end

Instance Attribute Details

#delete_protectionObject

Protection from accidental deletion of this item [true/false]



20
21
22
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 20

def delete_protection
  @delete_protection
end

#github_app_idObject

Github app id



23
24
25
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 23

def github_app_id
  @github_app_id
end

#github_app_private_keyObject

App private key



26
27
28
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 26

def github_app_private_key
  @github_app_private_key
end

#github_base_urlObject

Base URL



29
30
31
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 29

def github_base_url
  @github_base_url
end

#installation_idObject

Github app installation id



32
33
34
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 32

def installation_id
  @installation_id
end

#installation_repositoryObject

Repository that the app installation has access to



35
36
37
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 35

def installation_repository
  @installation_repository
end

#jsonObject

Set output format to JSON



38
39
40
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 38

def json
  @json
end

#nameObject

Producer name



41
42
43
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 41

def name
  @name
end

#target_nameObject

Target name



44
45
46
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 44

def target_name
  @target_name
end

#tokenObject

Authentication token (see ‘/auth` and `/configure`)



47
48
49
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 47

def token
  @token
end

#token_permissionsObject

Optional - installation token’s allowed permissions



50
51
52
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 50

def token_permissions
  @token_permissions
end

#token_repositoriesObject

Optional - installation token’s allowed repositories



53
54
55
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 53

def token_repositories
  @token_repositories
end

#uid_tokenObject

The universal identity token, Required only for universal_identity authentication



56
57
58
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 56

def uid_token
  @uid_token
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



78
79
80
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 59

def self.attribute_map
  {
    :'delete_protection' => :'delete_protection',
    :'github_app_id' => :'github-app-id',
    :'github_app_private_key' => :'github-app-private-key',
    :'github_base_url' => :'github-base-url',
    :'installation_id' => :'installation-id',
    :'installation_repository' => :'installation-repository',
    :'json' => :'json',
    :'name' => :'name',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'token_permissions' => :'token-permissions',
    :'token_repositories' => :'token-repositories',
    :'uid_token' => :'uid-token'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



236
237
238
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 236

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



102
103
104
105
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 102

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 83

def self.openapi_types
  {
    :'delete_protection' => :'String',
    :'github_app_id' => :'Integer',
    :'github_app_private_key' => :'String',
    :'github_base_url' => :'String',
    :'installation_id' => :'Integer',
    :'installation_repository' => :'String',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'target_name' => :'String',
    :'token' => :'String',
    :'token_permissions' => :'Array<String>',
    :'token_repositories' => :'Array<String>',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      delete_protection == o.delete_protection &&
      github_app_id == o.github_app_id &&
      github_app_private_key == o.github_app_private_key &&
      github_base_url == o.github_base_url &&
      installation_id == o.installation_id &&
      installation_repository == o.installation_repository &&
      json == o.json &&
      name == o.name &&
      target_name == o.target_name &&
      token == o.token &&
      token_permissions == o.token_permissions &&
      token_repositories == o.token_repositories &&
      uid_token == o.uid_token
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 267

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 338

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 223

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



229
230
231
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 229

def hash
  [delete_protection, github_app_id, github_app_private_key, github_base_url, installation_id, installation_repository, json, name, target_name, token, token_permissions, token_repositories, uid_token].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



185
186
187
188
189
190
191
192
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 185

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



314
315
316
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 314

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 320

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



308
309
310
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 308

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



196
197
198
199
# File 'lib/akeyless/models/gateway_create_producer_github.rb', line 196

def valid?
  return false if @name.nil?
  true
end