Class: CloudsmithApi::ProviderSettingsWrite

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/models/provider_settings_write.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProviderSettingsWrite

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'claims')
    self.claims = attributes[:'claims']
  end

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

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.has_key?(:'mapping_claim')
    self.mapping_claim = attributes[:'mapping_claim']
  end

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

  if attributes.has_key?(:'provider_url')
    self.provider_url = attributes[:'provider_url']
  end

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

  if attributes.has_key?(:'slug')
    self.slug = attributes[:'slug']
  end

  if attributes.has_key?(:'slug_perm')
    self.slug_perm = attributes[:'slug_perm']
  end
end

Instance Attribute Details

#claims ⇒ Object

The set of claims that any received tokens from the provider must contain to authenticate as the configured service account.



18
19
20
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 18

def claims
  @claims
end

#dynamic_mappings ⇒ Object

The dynamic mappings of ‘mapping_claim` values to service accounts. Cannot be provided if `service_accounts` is also set. Note: This field and the dynamic mappings feature are still in early access. Breaking changes are possible as we receive feedback on this feature.



21
22
23
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 21

def dynamic_mappings
  @dynamic_mappings
end

#enabled ⇒ Object

Whether the provider settings should be used for incoming OIDC requests.



24
25
26
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 24

def enabled
  @enabled
end

#mapping_claim ⇒ Object

The OIDC claim to use for mapping to service accounts in dynamic_mappings. Cannot be provided if ‘service_accounts` is also set. Note: This field and the dynamic mappings feature are still in early access. Breaking changes are possible as we receive feedback on this feature.



27
28
29
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 27

def mapping_claim
  @mapping_claim
end

#name ⇒ Object

The name of the provider settings are being configured for



30
31
32
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 30

def name
  @name
end

#provider_url ⇒ Object

The URL from the provider that serves as the base for the OpenID configuration. For example, if the OpenID configuration is available at token.actions.githubusercontent.com/.well-known/openid-configuration, the provider URL would be token.actions.githubusercontent.com/



33
34
35
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 33

def provider_url
  @provider_url
end

#service_accounts ⇒ Object

The service accounts associated with these provider settings. Cannot be provided if ‘mapping_claim` or `dynamic_mappings` are specified.



36
37
38
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 36

def service_accounts
  @service_accounts
end

#slug ⇒ Object

The slug of the provider settings



39
40
41
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 39

def slug
  @slug
end

#slug_perm ⇒ Object

The unique, immutable identifier of the provider settings.



42
43
44
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 42

def slug_perm
  @slug_perm
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 45

def self.attribute_map
  {
    :'claims' => :'claims',
    :'dynamic_mappings' => :'dynamic_mappings',
    :'enabled' => :'enabled',
    :'mapping_claim' => :'mapping_claim',
    :'name' => :'name',
    :'provider_url' => :'provider_url',
    :'service_accounts' => :'service_accounts',
    :'slug' => :'slug',
    :'slug_perm' => :'slug_perm'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 60

def self.swagger_types
  {
    :'claims' => :'Object',
    :'dynamic_mappings' => :'Array<DynamicMapping>',
    :'enabled' => :'BOOLEAN',
    :'mapping_claim' => :'String',
    :'name' => :'String',
    :'provider_url' => :'String',
    :'service_accounts' => :'Array<String>',
    :'slug' => :'String',
    :'slug_perm' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      claims == o.claims &&
      dynamic_mappings == o.dynamic_mappings &&
      enabled == o.enabled &&
      mapping_claim == o.mapping_claim &&
      name == o.name &&
      provider_url == o.provider_url &&
      service_accounts == o.service_accounts &&
      slug == o.slug &&
      slug_perm == o.slug_perm
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 208

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CloudsmithApi.const_get(type).new
    temp_model.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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 274

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 187

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 180

def hash
  [claims, dynamic_mappings, enabled, mapping_claim, name, provider_url, service_accounts, slug, slug_perm].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 125

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

  if @enabled.nil?
    invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @provider_url.nil?
    invalid_properties.push('invalid value for "provider_url", provider_url cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 260

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



248
249
250
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 248

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



148
149
150
151
152
153
154
 
# File 'lib/cloudsmith-api/models/provider_settings_write.rb', line 148

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