Class: OCI::Jms::Models::Fleet

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

Overview

A Fleet is the primary collection with which users interact when using Java Management Service.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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):



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
 
# File 'lib/oci/jms/models/fleet.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.description = attributes[:'description'] if attributes[:'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.approximate_jre_count = attributes[:'approximateJreCount'] if attributes[:'approximateJreCount']

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

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

  self.approximate_installation_count = attributes[:'approximateInstallationCount'] if attributes[:'approximateInstallationCount']

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

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

  self.approximate_application_count = attributes[:'approximateApplicationCount'] if attributes[:'approximateApplicationCount']

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

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

  self.approximate_managed_instance_count = attributes[:'approximateManagedInstanceCount'] if attributes[:'approximateManagedInstanceCount']

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

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

  self.approximate_java_server_count = attributes[:'approximateJavaServerCount'] if attributes[:'approximateJavaServerCount']

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

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

  self.inventory_log = attributes[:'inventoryLog'] if attributes[:'inventoryLog']

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

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

  self.operation_log = attributes[:'operationLog'] if attributes[:'operationLog']

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

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

  self.is_advanced_features_enabled = attributes[:'isAdvancedFeaturesEnabled'] unless attributes[:'isAdvancedFeaturesEnabled'].nil?

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

  self.is_advanced_features_enabled = attributes[:'is_advanced_features_enabled'] unless attributes[:'is_advanced_features_enabled'].nil?

  self.is_export_setting_enabled = attributes[:'isExportSettingEnabled'] unless attributes[:'isExportSettingEnabled'].nil?

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

  self.is_export_setting_enabled = attributes[:'is_export_setting_enabled'] unless attributes[:'is_export_setting_enabled'].nil?

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

#approximate_application_count ⇒ Integer

[Required] The approximate count of all unique applications in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag.

Returns:

  • (Integer) 


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

def approximate_application_count
  @approximate_application_count
end

#approximate_installation_count ⇒ Integer

[Required] The approximate count of all unique Java installations in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oci/jms/models/fleet.rb', line 51

def approximate_installation_count
  @approximate_installation_count
end

#approximate_java_server_count ⇒ Integer

[Required] The approximate count of all unique Java servers in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/jms/models/fleet.rb', line 69

def approximate_java_server_count
  @approximate_java_server_count
end

#approximate_jre_count ⇒ Integer

[Required] The approximate count of all unique Java Runtimes in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/jms/models/fleet.rb', line 45

def approximate_jre_count
  @approximate_jre_count
end

#approximate_managed_instance_count ⇒ Integer

[Required] The approximate count of all unique managed instances in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag.

Returns:

  • (Integer) 


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

def approximate_managed_instance_count
  @approximate_managed_instance_count
end

#compartment_id ⇒ String

[Required] The OCID of the compartment of the Fleet.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/jms/models/fleet.rb', line 39

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}. (See {Understanding Free-form Tags}[https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm]).

Returns:

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


101
102
103
 
# File 'lib/oci/jms/models/fleet.rb', line 101

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The Fleet's description.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/jms/models/fleet.rb', line 34

def description
  @description
end

#display_name ⇒ String

[Required] The name of the Fleet.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/jms/models/fleet.rb', line 30

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}. (See {Managing Tags and Tag Namespaces}[https://docs.cloud.oracle.com/Content/Tagging/Concepts/understandingfreeformtags.htm].)

Returns:

  • (Hash<String, String>) 


107
108
109
 
# File 'lib/oci/jms/models/fleet.rb', line 107

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Fleet.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/jms/models/fleet.rb', line 26

def id
  @id
end

#inventory_log ⇒ OCI::Jms::Models::CustomLog

Returns:



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

def inventory_log
  @inventory_log
end

#is_advanced_features_enabled ⇒ BOOLEAN

Whether or not advanced features are enabled in this Fleet. Deprecated, use /fleets/{fleetId}/advanceFeatureConfiguration API instead.

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/jms/models/fleet.rb', line 81

def is_advanced_features_enabled
  @is_advanced_features_enabled
end

#is_export_setting_enabled ⇒ BOOLEAN

Whether or not export setting is enabled in this Fleet.

Returns:

  • (BOOLEAN) 


86
87
88
 
# File 'lib/oci/jms/models/fleet.rb', line 86

def is_export_setting_enabled
  @is_export_setting_enabled
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the Fleet.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/jms/models/fleet.rb', line 95

def lifecycle_state
  @lifecycle_state
end

#operation_log ⇒ OCI::Jms::Models::CustomLog

Returns:



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

def operation_log
  @operation_log
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The creation date and time of the Fleet (formatted according to RFC3339).

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/jms/models/fleet.rb', line 119

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'approximate_jre_count': :'approximateJreCount',
    'approximate_installation_count': :'approximateInstallationCount',
    'approximate_application_count': :'approximateApplicationCount',
    'approximate_managed_instance_count': :'approximateManagedInstanceCount',
    'approximate_java_server_count': :'approximateJavaServerCount',
    'inventory_log': :'inventoryLog',
    'operation_log': :'operationLog',
    'is_advanced_features_enabled': :'isAdvancedFeaturesEnabled',
    'is_export_setting_enabled': :'isExportSettingEnabled',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/jms/models/fleet.rb', line 145

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'approximate_jre_count': :'Integer',
    'approximate_installation_count': :'Integer',
    'approximate_application_count': :'Integer',
    'approximate_managed_instance_count': :'Integer',
    'approximate_java_server_count': :'Integer',
    'inventory_log': :'OCI::Jms::Models::CustomLog',
    'operation_log': :'OCI::Jms::Models::CustomLog',
    'is_advanced_features_enabled': :'BOOLEAN',
    'is_export_setting_enabled': :'BOOLEAN',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    '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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/jms/models/fleet.rb', line 321

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    approximate_jre_count == other.approximate_jre_count &&
    approximate_installation_count == other.approximate_installation_count &&
    approximate_application_count == other.approximate_application_count &&
    approximate_managed_instance_count == other.approximate_managed_instance_count &&
    approximate_java_server_count == other.approximate_java_server_count &&
    inventory_log == other.inventory_log &&
    operation_log == other.operation_log &&
    is_advanced_features_enabled == other.is_advanced_features_enabled &&
    is_export_setting_enabled == other.is_export_setting_enabled &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/jms/models/fleet.rb', line 368

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


348
349
350
 
# File 'lib/oci/jms/models/fleet.rb', line 348

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/oci/jms/models/fleet.rb', line 357

def hash
  [id, display_name, description, compartment_id, approximate_jre_count, approximate_installation_count, approximate_application_count, approximate_managed_instance_count, approximate_java_server_count, inventory_log, operation_log, is_advanced_features_enabled, is_export_setting_enabled, time_created, lifecycle_state, defined_tags, freeform_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



401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/jms/models/fleet.rb', line 401

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



395
396
397
 
# File 'lib/oci/jms/models/fleet.rb', line 395

def to_s
  to_hash.to_s
end