Class: IbmCloudIam::ServiceId

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_iam/models/service_id.rb

Overview

Response body format for service ID V1 REST requests.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceId

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 106

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

ID of the account the service ID belongs to.



42
43
44
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 42

def 
  @account_id
end

#apikey ⇒ Object

Returns the value of attribute apikey.



56
57
58
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 56

def apikey
  @apikey
end

#context ⇒ Object

Returns the value of attribute context.



18
19
20
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 18

def context
  @context
end

#created_at ⇒ Object

If set contains a date time string of the creation date in ISO format



36
37
38
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 36

def created_at
  @created_at
end

#crn ⇒ Object

Cloud Resource Name of the item. Example Cloud Resource Name: ‘crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::serviceid:1234-5678-9012’



30
31
32
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 30

def crn
  @crn
end

#description ⇒ Object

The optional description of the Service Id. The ‘description’ property is only available if a description was provided during a create of a Service Id.



48
49
50
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 48

def description
  @description
end

#entity_tag ⇒ Object

Version of the service ID details object. You need to specify this value when updating the service ID to avoid stale updates.



27
28
29
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 27

def entity_tag
  @entity_tag
end

#history ⇒ Object

History of the Service ID



54
55
56
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 54

def history
  @history
end

#iam_id ⇒ Object

Cloud wide identifier for identities of this service ID.



24
25
26
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 24

def iam_id
  @iam_id
end

#id ⇒ Object

Unique identifier of this Service Id.



21
22
23
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 21

def id
  @id
end

#locked ⇒ Object

The service ID cannot be changed if set to true.



33
34
35
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 33

def locked
  @locked
end

#modified_at ⇒ Object

If set contains a date time string of the last modification date in ISO format



39
40
41
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 39

def modified_at
  @modified_at
end

#name ⇒ Object

Name of the Service Id. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the Service Id.



45
46
47
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 45

def name
  @name
end

#unique_instance_crns ⇒ Object

Optional list of CRNs (string array) which point to the services connected to the service ID.



51
52
53
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 51

def unique_instance_crns
  @unique_instance_crns
end

Class Method Details

.attribute_map ⇒ Object

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
76
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 59

def self.attribute_map
  {
    :'context' => :'context',
    :'id' => :'id',
    :'iam_id' => :'iam_id',
    :'entity_tag' => :'entity_tag',
    :'crn' => :'crn',
    :'locked' => :'locked',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at',
    :'account_id' => :'account_id',
    :'name' => :'name',
    :'description' => :'description',
    :'unique_instance_crns' => :'unique_instance_crns',
    :'history' => :'history',
    :'apikey' => :'apikey'
  }
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



264
265
266
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 79

def self.openapi_types
  {
    :'context' => :'ResponseContext',
    :'id' => :'String',
    :'iam_id' => :'String',
    :'entity_tag' => :'String',
    :'crn' => :'String',
    :'locked' => :'Boolean',
    :'created_at' => :'DateTime',
    :'modified_at' => :'DateTime',
    :'account_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'unique_instance_crns' => :'Array<String>',
    :'history' => :'Array<EnityHistoryRecord>',
    :'apikey' => :'ApiKey'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      context == o.context &&
      id == o.id &&
      iam_id == o.iam_id &&
      entity_tag == o.entity_tag &&
      crn == o.crn &&
      locked == o.locked &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
       == o. &&
      name == o.name &&
      description == o.description &&
      unique_instance_crns == o.unique_instance_crns &&
      history == o.history &&
      apikey == o.apikey
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 294

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
    IbmCloudIam.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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 363

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 271

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


251
252
253
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 257

def hash
  [context, id, iam_id, entity_tag, crn, locked, created_at, modified_at, , name, description, unique_instance_crns, history, apikey].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



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
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 182

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

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

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

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

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

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

  if @apikey.nil?
    invalid_properties.push('invalid value for "apikey", apikey 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



339
340
341
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 345

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



333
334
335
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 333

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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ibm_cloud_iam/models/service_id.rb', line 217

def valid?
  return false if @id.nil?
  return false if @iam_id.nil?
  return false if @crn.nil?
  return false if @locked.nil?
  return false if @account_id.nil?
  return false if @name.nil?
  return false if @apikey.nil?
  true
end