Class: OCI::FleetAppsManagement::Models::Fleet

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

Overview

A fleet is a collection or grouping of resources based on criteria.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Fleet

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
322
323
324
325
326
327
328
329
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 218

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.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.resource_region = attributes[:'resourceRegion'] if attributes[:'resourceRegion']

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

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

  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.description = attributes[:'description'] if attributes[:'description']

  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.products = attributes[:'products'] if attributes[:'products']

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

  self.environment_type = attributes[:'environmentType'] if attributes[:'environmentType']

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

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

  self.resource_selection = attributes[:'resourceSelection'] if attributes[:'resourceSelection']

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

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

  self.notification_preferences = attributes[:'notificationPreferences'] if attributes[:'notificationPreferences']

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

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

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

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

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

  self.parent_fleet_id = attributes[:'parentFleetId'] if attributes[:'parentFleetId']

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

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

  self.is_target_auto_confirm = attributes[:'isTargetAutoConfirm'] unless attributes[:'isTargetAutoConfirm'].nil?
  self.is_target_auto_confirm = false if is_target_auto_confirm.nil? && !attributes.key?(:'isTargetAutoConfirm') # rubocop:disable Style/StringLiterals

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

  self.is_target_auto_confirm = attributes[:'is_target_auto_confirm'] unless attributes[:'is_target_auto_confirm'].nil?
  self.is_target_auto_confirm = false if is_target_auto_confirm.nil? && !attributes.key?(:'isTargetAutoConfirm') && !attributes.key?(:'is_target_auto_confirm') # rubocop:disable Style/StringLiterals

  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.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] Compartment OCID

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 31

def compartment_id
  @compartment_id
end

#credentials ⇒ Array<OCI::FleetAppsManagement::Models::AssociatedFleetCredentialDetails>

Credentials associated with the Fleet.

Returns:



91
92
93
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 91

def credentials
  @credentials
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>>) 


122
123
124
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 122

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


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

def description
  @description
end

#details ⇒ OCI::FleetAppsManagement::Models::FleetDetails

Returns:



66
67
68
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 66

def details
  @details
end

#display_name ⇒ String

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

Example: My new resource

Returns:

  • (String) 


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

def display_name
  @display_name
end

#environment_type ⇒ String

Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 72

def environment_type
  @environment_type
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>) 


116
117
118
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 116

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 27

def id
  @id
end

#is_target_auto_confirm ⇒ BOOLEAN

A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention.

Returns:

  • (BOOLEAN) 


102
103
104
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 102

def is_target_auto_confirm
  @is_target_auto_confirm
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 110

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the Fleet.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 106

def lifecycle_state
  @lifecycle_state
end

#notification_preferences ⇒ Array<OCI::FleetAppsManagement::Models::NotificationPreference>

Notification Preferences associated with the Fleet.

Returns:



79
80
81
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 79

def notification_preferences
  @notification_preferences
end

#parent_fleet_id ⇒ String

The OCID of the fleet that would be the parent for this fleet.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 96

def parent_fleet_id
  @parent_fleet_id
end

#products ⇒ Array<String>

Products associated with the Fleet. PlatformConfiguration Ids corresponding to the Products.

Returns:

  • (Array<String>) 


63
64
65
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 63

def products
  @products
end

#properties ⇒ Array<OCI::FleetAppsManagement::Models::AssociatedFleetPropertyDetails>

Properties associated with the Fleet.

Returns:



87
88
89
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 87

def properties
  @properties
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 35

def resource_region
  @resource_region
end

#resource_selection ⇒ OCI::FleetAppsManagement::Models::ResourceSelection

Returns:



75
76
77
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 75

def resource_selection
  @resource_selection
end

#resources ⇒ Array<OCI::FleetAppsManagement::Models::AssociatedFleetResourceDetails>

Resources associated with the Fleet if resourceSelectionType is MANUAL.

Returns:



83
84
85
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 83

def resources
  @resources
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>>) 


128
129
130
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 128

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'products': :'products',
    'details': :'details',
    'environment_type': :'environmentType',
    'resource_selection': :'resourceSelection',
    'notification_preferences': :'notificationPreferences',
    'resources': :'resources',
    'properties': :'properties',
    'credentials': :'credentials',
    'parent_fleet_id': :'parentFleetId',
    'is_target_auto_confirm': :'isTargetAutoConfirm',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'resource_region': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'products': :'Array<String>',
    'details': :'OCI::FleetAppsManagement::Models::FleetDetails',
    'environment_type': :'String',
    'resource_selection': :'OCI::FleetAppsManagement::Models::ResourceSelection',
    'notification_preferences': :'Array<OCI::FleetAppsManagement::Models::NotificationPreference>',
    'resources': :'Array<OCI::FleetAppsManagement::Models::AssociatedFleetResourceDetails>',
    'properties': :'Array<OCI::FleetAppsManagement::Models::AssociatedFleetPropertyDetails>',
    'credentials': :'Array<OCI::FleetAppsManagement::Models::AssociatedFleetCredentialDetails>',
    'parent_fleet_id': :'String',
    'is_target_auto_confirm': :'BOOLEAN',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 351

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    products == other.products &&
    details == other.details &&
    environment_type == other.environment_type &&
    resource_selection == other.resource_selection &&
    notification_preferences == other.notification_preferences &&
    resources == other.resources &&
    properties == other.properties &&
    credentials == other.credentials &&
    parent_fleet_id == other.parent_fleet_id &&
    is_target_auto_confirm == other.is_target_auto_confirm &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 402

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


382
383
384
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 382

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 391

def hash
  [id, compartment_id, resource_region, display_name, description, time_created, time_updated, products, details, environment_type, resource_selection, notification_preferences, resources, properties, credentials, parent_fleet_id, is_target_auto_confirm, lifecycle_state, lifecycle_details, 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



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 435

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



429
430
431
 
# File 'lib/oci/fleet_apps_management/models/fleet.rb', line 429

def to_s
  to_hash.to_s
end