Class: IbmCloudResourceController::ResourceKey

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_resource_controller/models/resource_key.rb

Overview

A resource key.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudResourceController::ResourceKey` 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 `IbmCloudResourceController::ResourceKey`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

An alpha-numeric value identifying the account ID.



34
35
36
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 34

def 
  @account_id
end

#created_at ⇒ Object

The date when the key was created.



58
59
60
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 58

def created_at
  @created_at
end

#created_by ⇒ Object

The subject who created the key.



67
68
69
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 67

def created_by
  @created_by
end

#credentials ⇒ Object

The credentials for the key. Additional key-value pairs are passed through from the resource brokers. Refer to service’s documentation for additional details.



49
50
51
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 49

def credentials
  @credentials
end

#crn ⇒ Object

The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see [Cloud Resource Names](cloud.ibm.com/docs/overview?topic=overview-crn).



25
26
27
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 25

def crn
  @crn
end

#deleted_at ⇒ Object

The date when the key was deleted.



64
65
66
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 64

def deleted_at
  @deleted_at
end

#deleted_by ⇒ Object

The subject who deleted the key.



73
74
75
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 73

def deleted_by
  @deleted_by
end

#guid ⇒ Object

When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the key.



22
23
24
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 22

def guid
  @guid
end

#iam_compatible ⇒ Object

Specifies whether the key’s credentials support IAM.



52
53
54
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 52

def iam_compatible
  @iam_compatible
end

#id ⇒ Object

The ID associated with the key.



19
20
21
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 19

def id
  @id
end

#name ⇒ Object

The human-readable name of the key.



31
32
33
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 31

def name
  @name
end

#resource_group_id ⇒ Object

The short ID of the resource group.



37
38
39
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 37

def resource_group_id
  @resource_group_id
end

#resource_instance_url ⇒ Object

The relative path to the resource.



55
56
57
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 55

def resource_instance_url
  @resource_instance_url
end

#role ⇒ Object

The role CRN.



43
44
45
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 43

def role
  @role
end

#source_crn ⇒ Object

The CRN of resource instance or alias associated to the key.



40
41
42
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 40

def source_crn
  @source_crn
end

#state ⇒ Object

The state of the key.



46
47
48
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 46

def state
  @state
end

#updated_at ⇒ Object

The date when the key was last updated.



61
62
63
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 61

def updated_at
  @updated_at
end

#updated_by ⇒ Object

The subject who updated the key.



70
71
72
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 70

def updated_by
  @updated_by
end

#url ⇒ Object

When you created a new key, a relative URL path is created identifying the location of the key.



28
29
30
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 28

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'guid' => :'guid',
    :'crn' => :'crn',
    :'url' => :'url',
    :'name' => :'name',
    :'account_id' => :'account_id',
    :'resource_group_id' => :'resource_group_id',
    :'source_crn' => :'source_crn',
    :'role' => :'role',
    :'state' => :'state',
    :'credentials' => :'credentials',
    :'iam_compatible' => :'iam_compatible',
    :'resource_instance_url' => :'resource_instance_url',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'deleted_at' => :'deleted_at',
    :'created_by' => :'created_by',
    :'updated_by' => :'updated_by',
    :'deleted_by' => :'deleted_by'
  }
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



277
278
279
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 277

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 101

def self.openapi_types
  {
    :'id' => :'String',
    :'guid' => :'String',
    :'crn' => :'String',
    :'url' => :'String',
    :'name' => :'String',
    :'account_id' => :'String',
    :'resource_group_id' => :'String',
    :'source_crn' => :'String',
    :'role' => :'String',
    :'state' => :'String',
    :'credentials' => :'Credentials',
    :'iam_compatible' => :'Boolean',
    :'resource_instance_url' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'deleted_at' => :'DateTime',
    :'created_by' => :'String',
    :'updated_by' => :'String',
    :'deleted_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      guid == o.guid &&
      crn == o.crn &&
      url == o.url &&
      name == o.name &&
       == o. &&
      resource_group_id == o.resource_group_id &&
      source_crn == o.source_crn &&
      role == o.role &&
      state == o.state &&
      credentials == o.credentials &&
      iam_compatible == o.iam_compatible &&
      resource_instance_url == o.resource_instance_url &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deleted_at == o.deleted_at &&
      created_by == o.created_by &&
      updated_by == o.updated_by &&
      deleted_by == o.deleted_by
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 307

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
    IbmCloudResourceController.const_get(type).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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 376

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 284

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 270

def hash
  [id, guid, crn, url, name, , resource_group_id, source_crn, role, state, credentials, iam_compatible, resource_instance_url, created_at, updated_at, deleted_at, created_by, updated_by, deleted_by].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



225
226
227
228
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 225

def list_invalid_properties
  invalid_properties = Array.new
  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



352
353
354
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 358

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



346
347
348
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 346

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



232
233
234
 
# File 'lib/ibm_cloud_resource_controller/models/resource_key.rb', line 232

def valid?
  true
end