Class: OCI::Analytics::Models::AnalyticsInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/analytics/models/analytics_instance.rb

Overview

Analytics instance metadata.

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_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FEATURE_SET_ENUM = 
[
  FEATURE_SET_SELF_SERVICE_ANALYTICS = 'SELF_SERVICE_ANALYTICS'.freeze,
  FEATURE_SET_ENTERPRISE_ANALYTICS = 'ENTERPRISE_ANALYTICS'.freeze,
  FEATURE_SET_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LICENSE_TYPE_ENUM = 
[
  LICENSE_TYPE_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_TYPE_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze,
  LICENSE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
UPDATE_CHANNEL_ENUM = 
[
  UPDATE_CHANNEL_REGULAR = 'REGULAR'.freeze,
  UPDATE_CHANNEL_EARLY = 'EARLY'.freeze,
  UPDATE_CHANNEL_PHASE_2 = 'PHASE_2'.freeze,
  UPDATE_CHANNEL_PHASE_1 = 'PHASE_1'.freeze,
  UPDATE_CHANNEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FEATURE_BUNDLE_ENUM = 
[
  FEATURE_BUNDLE_FAW_PAID = 'FAW_PAID'.freeze,
  FEATURE_BUNDLE_FAW_FREE = 'FAW_FREE'.freeze,
  FEATURE_BUNDLE_FDI_BASE = 'FDI_BASE'.freeze,
  FEATURE_BUNDLE_EE_EMBEDDED = 'EE_EMBEDDED'.freeze,
  FEATURE_BUNDLE_SE_EMBEDDED = 'SE_EMBEDDED'.freeze,
  FEATURE_BUNDLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 269

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

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

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

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

  self.license_type = attributes[:'licenseType'] if attributes[:'licenseType']

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

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

  self.email_notification = attributes[:'emailNotification'] if attributes[:'emailNotification']

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

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

  self.update_channel = attributes[:'updateChannel'] if attributes[:'updateChannel']

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

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

  self.network_endpoint_details = attributes[:'networkEndpointDetails'] if attributes[:'networkEndpointDetails']

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

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

  self.private_access_channels = attributes[:'privateAccessChannels'] if attributes[:'privateAccessChannels']

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

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

  self.vanity_url_details = attributes[:'vanityUrlDetails'] if attributes[:'vanityUrlDetails']

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

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

  self.service_url = attributes[:'serviceUrl'] if attributes[:'serviceUrl']

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

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

  self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_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.feature_bundle = attributes[:'featureBundle'] if attributes[:'featureBundle']

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

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

  self.domain_id = attributes[:'domainId'] if attributes[:'domainId']

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

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

  self.resource_groups = attributes[:'resourceGroups'] if attributes[:'resourceGroups']

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

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

Instance Attribute Details

#capacity ⇒ OCI::Analytics::Models::Capacity

This attribute is required.

Returns:



86
87
88
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 86

def capacity
  @capacity
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 72

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. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


128
129
130
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 128

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 67

def description
  @description
end

#domain_id ⇒ String

Identity domain OCID.

Returns:

  • (String) 


171
172
173
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 171

def domain_id
  @domain_id
end

#email_notification ⇒ String

Email address receiving notifications.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 96

def email_notification
  @email_notification
end

#feature_bundle ⇒ String

The feature set of an Analytics instance.

Returns:

  • (String) 


166
167
168
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 166

def feature_bundle
  @feature_bundle
end

#feature_set ⇒ String

[Required] The feature set. Either SELF_SERVICE_ANALYTICS (Professional Edition) or ENTERPRISE_ANALYTICS (Enterprise Edition).

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 82

def feature_set
  @feature_set
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


136
137
138
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 136

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The resource OCID.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 56

def id
  @id
end

#kms_key_id ⇒ String

OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates that the default Oracle-managed encryption is used.

Returns:

  • (String) 


147
148
149
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 147

def kms_key_id
  @kms_key_id
end

#license_type ⇒ String

The license used for the service.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 91

def license_type
  @license_type
end

#lifecycle_state ⇒ String

[Required] The current state of the Analytics instance.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 77

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the Analytics instance. This name must be unique in the tenancy and can't be changed. The name must start with a letter and can contain only letters, numbers and dash (-).

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 62

def name
  @name
end

#network_endpoint_details ⇒ OCI::Analytics::Models::NetworkEndpointDetails

This attribute is required.

Returns:



105
106
107
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 105

def network_endpoint_details
  @network_endpoint_details
end

#private_access_channels ⇒ Hash<String, OCI::Analytics::Models::PrivateAccessChannel>

Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.

Returns:



110
111
112
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 110

def private_access_channels
  @private_access_channels
end

#resource_groups ⇒ Array<OCI::Analytics::Models::InstanceResourceGroup>

List of resource groups for this Analytics instance. The resource group id must be unique within the instance.

Returns:



176
177
178
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 176

def resource_groups
  @resource_groups
end

#service_url ⇒ String

URL of the Analytics instance.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 120

def service_url
  @service_url
end

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

System tags for this resource. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"key\": \"value\"}}

Returns:

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


142
143
144
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 142

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Analytics instance was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


154
155
156
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 154

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Analytics instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events don't affect it.

Returns:

  • (DateTime) 


161
162
163
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 161

def time_updated
  @time_updated
end

#update_channel ⇒ String

The Analytics instance update cycle.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 101

def update_channel
  @update_channel
end

#vanity_url_details ⇒ Hash<String, OCI::Analytics::Models::VanityUrlDetails>

Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.

Returns:



115
116
117
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 115

def vanity_url_details
  @vanity_url_details
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 179

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'feature_set': :'featureSet',
    'capacity': :'capacity',
    'license_type': :'licenseType',
    'email_notification': :'emailNotification',
    'update_channel': :'updateChannel',
    'network_endpoint_details': :'networkEndpointDetails',
    'private_access_channels': :'privateAccessChannels',
    'vanity_url_details': :'vanityUrlDetails',
    'service_url': :'serviceUrl',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'kms_key_id': :'kmsKeyId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'feature_bundle': :'featureBundle',
    'domain_id': :'domainId',
    'resource_groups': :'resourceGroups'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 210

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'feature_set': :'String',
    'capacity': :'OCI::Analytics::Models::Capacity',
    'license_type': :'String',
    'email_notification': :'String',
    'update_channel': :'String',
    'network_endpoint_details': :'OCI::Analytics::Models::NetworkEndpointDetails',
    'private_access_channels': :'Hash<String, OCI::Analytics::Models::PrivateAccessChannel>',
    'vanity_url_details': :'Hash<String, OCI::Analytics::Models::VanityUrlDetails>',
    'service_url': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'kms_key_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'feature_bundle': :'String',
    'domain_id': :'String',
    'resource_groups': :'Array<OCI::Analytics::Models::InstanceResourceGroup>'
    # 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



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 470

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    feature_set == other.feature_set &&
    capacity == other.capacity &&
    license_type == other.license_type &&
    email_notification == other.email_notification &&
    update_channel == other.update_channel &&
    network_endpoint_details == other.network_endpoint_details &&
    private_access_channels == other.private_access_channels &&
    vanity_url_details == other.vanity_url_details &&
    service_url == other.service_url &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    kms_key_id == other.kms_key_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    feature_bundle == other.feature_bundle &&
    domain_id == other.domain_id &&
    resource_groups == other.resource_groups
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



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 522

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


502
503
504
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 502

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



511
512
513
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 511

def hash
  [id, name, description, compartment_id, lifecycle_state, feature_set, capacity, license_type, email_notification, update_channel, network_endpoint_details, private_access_channels, vanity_url_details, service_url, defined_tags, freeform_tags, system_tags, kms_key_id, time_created, time_updated, feature_bundle, domain_id, resource_groups].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



555
556
557
558
559
560
561
562
563
564
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 555

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



549
550
551
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 549

def to_s
  to_hash.to_s
end