Class: OCI::FleetAppsManagement::Models::Onboarding

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

Overview

Fleet Application Management onboarding resource. The onboarding process letsu00A0Fleet Application Managementu00A0create a few required policies that you need to start using it and its features.

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 = {}) ⇒ Onboarding

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



155
156
157
158
159
160
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
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
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
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 155

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.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.is_fams_tag_enabled = attributes[:'isFamsTagEnabled'] unless attributes[:'isFamsTagEnabled'].nil?
  self.is_fams_tag_enabled = false if is_fams_tag_enabled.nil? && !attributes.key?(:'isFamsTagEnabled') # rubocop:disable Style/StringLiterals

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

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

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

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

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

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

  self.applied_policies = attributes[:'appliedPolicies'] if attributes[:'appliedPolicies']

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

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

  self.discovery_frequency = attributes[:'discoveryFrequency'] if attributes[:'discoveryFrequency']

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

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

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

  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']
end

Instance Attribute Details

#applied_policies ⇒ OCI::FleetAppsManagement::Models::OnboardingPolicySummary

Returns:



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

def applied_policies
  @applied_policies
end

#compartment_id ⇒ String

[Required] Tenancy OCID

Returns:

  • (String) 


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

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\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#discovery_frequency ⇒ String

Provide discovery frequency.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 67

def discovery_frequency
  @discovery_frequency
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\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique id of the resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 28

def id
  @id
end

#is_cost_tracking_tag_enabled ⇒ BOOLEAN

A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 60

def is_cost_tracking_tag_enabled
  @is_cost_tracking_tag_enabled
end

#is_fams_tag_enabled ⇒ BOOLEAN

A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag.

Returns:

  • (BOOLEAN) 


50
51
52
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 50

def is_fams_tag_enabled
  @is_fams_tag_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the Onboarding.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 71

def lifecycle_state
  @lifecycle_state
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 36

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 40

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 44

def time_updated
  @time_updated
end

#version ⇒ String

The version of Fleet Application Management that the tenant is onboarded to.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 54

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_fams_tag_enabled': :'isFamsTagEnabled',
    'version': :'version',
    'is_cost_tracking_tag_enabled': :'isCostTrackingTagEnabled',
    'applied_policies': :'appliedPolicies',
    'discovery_frequency': :'discoveryFrequency',
    'lifecycle_state': :'lifecycleState',
    'system_tags': :'systemTags',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'resource_region': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_fams_tag_enabled': :'BOOLEAN',
    'version': :'String',
    'is_cost_tracking_tag_enabled': :'BOOLEAN',
    'applied_policies': :'OCI::FleetAppsManagement::Models::OnboardingPolicySummary',
    'discovery_frequency': :'String',
    'lifecycle_state': :'String',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 262

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_fams_tag_enabled == other.is_fams_tag_enabled &&
    version == other.version &&
    is_cost_tracking_tag_enabled == other.is_cost_tracking_tag_enabled &&
    applied_policies == other.applied_policies &&
    discovery_frequency == other.discovery_frequency &&
    lifecycle_state == other.lifecycle_state &&
    system_tags == other.system_tags &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 305

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


285
286
287
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 285

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 294

def hash
  [id, compartment_id, resource_region, time_created, time_updated, is_fams_tag_enabled, version, is_cost_tracking_tag_enabled, applied_policies, discovery_frequency, lifecycle_state, system_tags, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 338

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



332
333
334
 
# File 'lib/oci/fleet_apps_management/models/onboarding.rb', line 332

def to_s
  to_hash.to_s
end