Class: OCI::FleetAppsManagement::Models::ProvisionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/provision_summary.rb

Overview

Summary information about a FamProvision.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProvisionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
222
223
224
225
226
227
228
229
230
231
232
233
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
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 194

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 }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.provision_description = attributes[:'provisionDescription'] if attributes[:'provisionDescription']

  raise 'You cannot provide both :provisionDescription and :provision_description' if attributes.key?(:'provisionDescription') && attributes.key?(:'provision_description')

  self.provision_description = attributes[:'provision_description'] if attributes[:'provision_description']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.package_catalog_item_id = attributes[:'packageCatalogItemId'] if attributes[:'packageCatalogItemId']

  raise 'You cannot provide both :packageCatalogItemId and :package_catalog_item_id' if attributes.key?(:'packageCatalogItemId') && attributes.key?(:'package_catalog_item_id')

  self.package_catalog_item_id = attributes[:'package_catalog_item_id'] if attributes[:'package_catalog_item_id']

  self.config_catalog_item_id = attributes[:'configCatalogItemId'] if attributes[:'configCatalogItemId']

  raise 'You cannot provide both :configCatalogItemId and :config_catalog_item_id' if attributes.key?(:'configCatalogItemId') && attributes.key?(:'config_catalog_item_id')

  self.config_catalog_item_id = attributes[:'config_catalog_item_id'] if attributes[:'config_catalog_item_id']

  self.package_catalog_item_display_name = attributes[:'packageCatalogItemDisplayName'] if attributes[:'packageCatalogItemDisplayName']

  raise 'You cannot provide both :packageCatalogItemDisplayName and :package_catalog_item_display_name' if attributes.key?(:'packageCatalogItemDisplayName') && attributes.key?(:'package_catalog_item_display_name')

  self.package_catalog_item_display_name = attributes[:'package_catalog_item_display_name'] if attributes[:'package_catalog_item_display_name']

  self.package_catalog_item_listing_id = attributes[:'packageCatalogItemListingId'] if attributes[:'packageCatalogItemListingId']

  raise 'You cannot provide both :packageCatalogItemListingId and :package_catalog_item_listing_id' if attributes.key?(:'packageCatalogItemListingId') && attributes.key?(:'package_catalog_item_listing_id')

  self.package_catalog_item_listing_id = attributes[:'package_catalog_item_listing_id'] if attributes[:'package_catalog_item_listing_id']

  self.package_catalog_item_listing_version = attributes[:'packageCatalogItemListingVersion'] if attributes[:'packageCatalogItemListingVersion']

  raise 'You cannot provide both :packageCatalogItemListingVersion and :package_catalog_item_listing_version' if attributes.key?(:'packageCatalogItemListingVersion') && attributes.key?(:'package_catalog_item_listing_version')

  self.package_catalog_item_listing_version = attributes[:'package_catalog_item_listing_version'] if attributes[:'package_catalog_item_listing_version']

  self.config_catalog_item_display_name = attributes[:'configCatalogItemDisplayName'] if attributes[:'configCatalogItemDisplayName']

  raise 'You cannot provide both :configCatalogItemDisplayName and :config_catalog_item_display_name' if attributes.key?(:'configCatalogItemDisplayName') && attributes.key?(:'config_catalog_item_display_name')

  self.config_catalog_item_display_name = attributes[:'config_catalog_item_display_name'] if attributes[:'config_catalog_item_display_name']

  self.config_catalog_item_listing_id = attributes[:'configCatalogItemListingId'] if attributes[:'configCatalogItemListingId']

  raise 'You cannot provide both :configCatalogItemListingId and :config_catalog_item_listing_id' if attributes.key?(:'configCatalogItemListingId') && attributes.key?(:'config_catalog_item_listing_id')

  self.config_catalog_item_listing_id = attributes[:'config_catalog_item_listing_id'] if attributes[:'config_catalog_item_listing_id']

  self.config_catalog_item_listing_version = attributes[:'configCatalogItemListingVersion'] if attributes[:'configCatalogItemListingVersion']

  raise 'You cannot provide both :configCatalogItemListingVersion and :config_catalog_item_listing_version' if attributes.key?(:'configCatalogItemListingVersion') && attributes.key?(:'config_catalog_item_listing_version')

  self.config_catalog_item_listing_version = attributes[:'config_catalog_item_listing_version'] if attributes[:'config_catalog_item_listing_version']

  self.stack_id = attributes[:'stackId'] if attributes[:'stackId']

  raise 'You cannot provide both :stackId and :stack_id' if attributes.key?(:'stackId') && attributes.key?(:'stack_id')

  self.stack_id = attributes[:'stack_id'] if attributes[:'stack_id']

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

  raise 'You cannot provide both :fleetId and :fleet_id' if attributes.key?(:'fleetId') && attributes.key?(:'fleet_id')

  self.fleet_id = attributes[:'fleet_id'] if attributes[:'fleet_id']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 25

def compartment_id
  @compartment_id
end

#config_catalog_item_display_name ⇒ String

[Required] A display Name of the Catalog Item in the Catalog.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 73

def config_catalog_item_display_name
  @config_catalog_item_display_name
end

#config_catalog_item_id ⇒ String

[Required] A OCID of the Catalog Item to a file with key/value pairs to set up variables for createStack API.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 57

def config_catalog_item_id
  @config_catalog_item_id
end

#config_catalog_item_listing_id ⇒ String

[Required] A listing ID of the Catalog Item in the Catalog.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 77

def config_catalog_item_listing_id
  @config_catalog_item_listing_id
end

#config_catalog_item_listing_version ⇒ String

[Required] A listing version of the Catalog Item in the Catalog.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 81

def config_catalog_item_listing_version
  @config_catalog_item_listing_version
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


101
102
103
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 101

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 17

def display_name
  @display_name
end

#fleet_id ⇒ String

[Required] The OCID of the Fleet.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 89

def fleet_id
  @fleet_id
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


95
96
97
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 95

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the FamProvision.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the FamProvision in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 49

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the FamProvision.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#package_catalog_item_display_name ⇒ String

[Required] A display Name of the Catalog Item in the Catalog.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 61

def package_catalog_item_display_name
  @package_catalog_item_display_name
end

#package_catalog_item_id ⇒ String

[Required] The OCID of the Catalog Item.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 53

def package_catalog_item_id
  @package_catalog_item_id
end

#package_catalog_item_listing_id ⇒ String

[Required] A listing ID of the Catalog Item in the Catalog.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 65

def package_catalog_item_listing_id
  @package_catalog_item_listing_id
end

#package_catalog_item_listing_version ⇒ String

[Required] A listing version of the Catalog Item in the Catalog.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 69

def package_catalog_item_listing_version
  @package_catalog_item_listing_version
end

#provision_description ⇒ String

[Required] A description of the provision.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 21

def provision_description
  @provision_description
end

#stack_id ⇒ String

[Required] The OCID of the RMS Stack.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 85

def stack_id
  @stack_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


107
108
109
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 107

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the FamProvision was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 32

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the FamProvision was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 39

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'provision_description': :'provisionDescription',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'package_catalog_item_id': :'packageCatalogItemId',
    'config_catalog_item_id': :'configCatalogItemId',
    'package_catalog_item_display_name': :'packageCatalogItemDisplayName',
    'package_catalog_item_listing_id': :'packageCatalogItemListingId',
    'package_catalog_item_listing_version': :'packageCatalogItemListingVersion',
    'config_catalog_item_display_name': :'configCatalogItemDisplayName',
    'config_catalog_item_listing_id': :'configCatalogItemListingId',
    'config_catalog_item_listing_version': :'configCatalogItemListingVersion',
    'stack_id': :'stackId',
    'fleet_id': :'fleetId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 139

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'provision_description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'package_catalog_item_id': :'String',
    'config_catalog_item_id': :'String',
    'package_catalog_item_display_name': :'String',
    'package_catalog_item_listing_id': :'String',
    'package_catalog_item_listing_version': :'String',
    'config_catalog_item_display_name': :'String',
    'config_catalog_item_listing_id': :'String',
    'config_catalog_item_listing_version': :'String',
    'stack_id': :'String',
    'fleet_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 330

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    provision_description == other.provision_description &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    package_catalog_item_id == other.package_catalog_item_id &&
    config_catalog_item_id == other.config_catalog_item_id &&
    package_catalog_item_display_name == other.package_catalog_item_display_name &&
    package_catalog_item_listing_id == other.package_catalog_item_listing_id &&
    package_catalog_item_listing_version == other.package_catalog_item_listing_version &&
    config_catalog_item_display_name == other.config_catalog_item_display_name &&
    config_catalog_item_listing_id == other.config_catalog_item_listing_id &&
    config_catalog_item_listing_version == other.config_catalog_item_listing_version &&
    stack_id == other.stack_id &&
    fleet_id == other.fleet_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 380

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


360
361
362
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 360

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



369
370
371
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 369

def hash
  [id, display_name, provision_description, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, package_catalog_item_id, config_catalog_item_id, package_catalog_item_display_name, package_catalog_item_listing_id, package_catalog_item_listing_version, config_catalog_item_display_name, config_catalog_item_listing_id, config_catalog_item_listing_version, stack_id, fleet_id, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 413

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



407
408
409
 
# File 'lib/oci/fleet_apps_management/models/provision_summary.rb', line 407

def to_s
  to_hash.to_s
end