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_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):



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

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

Instance Attribute Details

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

This attribute is required.

Returns:



84
85
86
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 84

def capacity
  @capacity
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 70

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


126
127
128
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 126

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 65

def description
  @description
end

#domain_id ⇒ String

Identity domain OCID.

Returns:

  • (String) 


169
170
171
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 169

def domain_id
  @domain_id
end

#email_notification ⇒ String

Email address receiving notifications.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 94

def email_notification
  @email_notification
end

#feature_bundle ⇒ String

The feature set of an Analytics instance.

Returns:

  • (String) 


164
165
166
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 164

def feature_bundle
  @feature_bundle
end

#feature_set ⇒ String

[Required] Analytics feature set.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 80

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


134
135
136
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 134

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The resource OCID.

Returns:

  • (String) 


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

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 Oracle managed default encryption.

Returns:

  • (String) 


145
146
147
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 145

def kms_key_id
  @kms_key_id
end

#license_type ⇒ String

The license used for the service.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 89

def license_type
  @license_type
end

#lifecycle_state ⇒ String

[Required] The current state of an instance.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 75

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 60

def name
  @name
end

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

This attribute is required.

Returns:



103
104
105
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 103

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:



108
109
110
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 108

def private_access_channels
  @private_access_channels
end

#service_url ⇒ String

URL of the Analytics service.

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 118

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


140
141
142
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 140

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


152
153
154
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 152

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.

Returns:

  • (DateTime) 


159
160
161
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 159

def time_updated
  @time_updated
end

#update_channel ⇒ String

Analytics instance update channel.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 99

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:



113
114
115
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 113

def vanity_url_details
  @vanity_url_details
end

Class Method Details

.attribute_map ⇒ Object

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



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

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 454

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



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 505

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


485
486
487
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 485

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



494
495
496
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 494

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



538
539
540
541
542
543
544
545
546
547
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 538

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



532
533
534
 
# File 'lib/oci/analytics/models/analytics_instance.rb', line 532

def to_s
  to_hash.to_s
end