Class: IbmCloudResourceController::ResourceInstancePost

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

Overview

Property values for the new resource instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceInstancePost

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
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
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 73

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

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

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

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

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

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

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

Instance Attribute Details

#allow_cleanup ⇒ Object

A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.



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

def allow_cleanup
  @allow_cleanup
end

#name ⇒ Object

The name of the instance. Must be 180 characters or less and cannot include any special characters other than ‘(space) - . _ :`.



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

def name
  @name
end

#parameters ⇒ Object

Configuration options represented as key-value pairs that are passed through to the target resource brokers.



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

def parameters
  @parameters
end

#resource_group ⇒ Object

Short or long ID of resource group



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

def resource_group
  @resource_group
end

#resource_plan_id ⇒ Object

The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.



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

def resource_plan_id
  @resource_plan_id
end

#tags ⇒ Object

Tags that are attached to the instance after provisioning. These tags can be searched and managed through the Tagging API in IBM Cloud.



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

def tags
  @tags
end

#target ⇒ Object

The deployment location where the instance should be hosted.



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

def target
  @target
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 40

def self.attribute_map
  {
    :'name' => :'name',
    :'target' => :'target',
    :'resource_group' => :'resource_group',
    :'resource_plan_id' => :'resource_plan_id',
    :'tags' => :'tags',
    :'allow_cleanup' => :'allow_cleanup',
    :'parameters' => :'parameters'
  }
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



204
205
206
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 204

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 53

def self.openapi_types
  {
    :'name' => :'String',
    :'target' => :'String',
    :'resource_group' => :'String',
    :'resource_plan_id' => :'String',
    :'tags' => :'Array<String>',
    :'allow_cleanup' => :'Boolean',
    :'parameters' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      target == o.target &&
      resource_group == o.resource_group &&
      resource_plan_id == o.resource_plan_id &&
      tags == o.tags &&
      allow_cleanup == o.allow_cleanup &&
      parameters == o.parameters
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 234

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 303

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 211

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


191
192
193
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 197

def hash
  [name, target, resource_group, resource_plan_id, tags, allow_cleanup, parameters].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



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
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 123

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

  pattern = Regexp.new(/^([^[:ascii:]]|[a-zA-Z0-9\-._: ])+$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

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



279
280
281
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 285

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



273
274
275
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 273

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



151
152
153
154
155
156
157
158
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance_post.rb', line 151

def valid?
  return false if @name.nil?
  return false if @name !~ Regexp.new(/^([^[:ascii:]]|[a-zA-Z0-9\-._: ])+$/)
  return false if @target.nil?
  return false if @resource_group.nil?
  return false if @resource_plan_id.nil?
  true
end