Class: OCI::Analytics::Models::CreateAnalyticsInstanceDetails

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

Overview

Input payload to create an Anaytics instance.

Constant Summary collapse

FEATURE_SET_ENUM = 
[
  FEATURE_SET_SELF_SERVICE_ANALYTICS = 'SELF_SERVICE_ANALYTICS'.freeze,
  FEATURE_SET_ENTERPRISE_ANALYTICS = 'ENTERPRISE_ANALYTICS'.freeze
].freeze
LICENSE_TYPE_ENUM = 
[
  LICENSE_TYPE_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_TYPE_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.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
].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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAnalyticsInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

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

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

Instance Attribute Details

#admin_user ⇒ String

The Analytics instance administrator user. This must be the user name (not OCID) of a user in the nominated identity domain. For example: john.smith@example.com.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 114

def admin_user
  @admin_user
end

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

This attribute is required.

Returns:



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

def capacity
  @capacity
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 51

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Optional description.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 46

def description
  @description
end

#domain_id ⇒ String

The OCID of the identity domain to use for the new Analytics instance. For example: ocid1.domain.oc1..ocid1.domain.oc1..aaaaaa111111bbbbbb222222cccccc333333dddddd444444eeeeee5555.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 109

def domain_id
  @domain_id
end

#email_notification ⇒ String

Email address receiving notifications.

Returns:

  • (String) 


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

def email_notification
  @email_notification
end

#feature_bundle ⇒ String

The feature set of an Analytics instance.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 119

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) 


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

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


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

def freeform_tags
  @freeform_tags
end

#idcs_access_token ⇒ String

IDCS access token identifying a stripe and service administrator user.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 78

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


104
105
106
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 104

def kms_key_id
  @kms_key_id
end

#license_type ⇒ String

[Required] The license used for the service.

Returns:

  • (String) 


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

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


41
42
43
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 41

def name
  @name
end

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

Returns:



73
74
75
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 73

def network_endpoint_details
  @network_endpoint_details
end

#update_channel ⇒ String

The Analytics instance update cycle.

Returns:

  • (String) 


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

def update_channel
  @update_channel
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'feature_set': :'featureSet',
    'capacity': :'capacity',
    'license_type': :'licenseType',
    'email_notification': :'emailNotification',
    'network_endpoint_details': :'networkEndpointDetails',
    'idcs_access_token': :'idcsAccessToken',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'update_channel': :'updateChannel',
    'kms_key_id': :'kmsKeyId',
    'domain_id': :'domainId',
    'admin_user': :'adminUser',
    'feature_bundle': :'featureBundle'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'feature_set': :'String',
    'capacity': :'OCI::Analytics::Models::Capacity',
    'license_type': :'String',
    'email_notification': :'String',
    'network_endpoint_details': :'OCI::Analytics::Models::NetworkEndpointDetails',
    'idcs_access_token': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'update_channel': :'String',
    'kms_key_id': :'String',
    'domain_id': :'String',
    'admin_user': :'String',
    'feature_bundle': :'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



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

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    feature_set == other.feature_set &&
    capacity == other.capacity &&
    license_type == other.license_type &&
    email_notification == other.email_notification &&
    network_endpoint_details == other.network_endpoint_details &&
    idcs_access_token == other.idcs_access_token &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    update_channel == other.update_channel &&
    kms_key_id == other.kms_key_id &&
    domain_id == other.domain_id &&
    admin_user == other.admin_user &&
    feature_bundle == other.feature_bundle
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



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

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


346
347
348
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 346

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 355

def hash
  [name, description, compartment_id, feature_set, capacity, license_type, email_notification, network_endpoint_details, idcs_access_token, defined_tags, freeform_tags, update_channel, kms_key_id, domain_id, admin_user, feature_bundle].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 399

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



393
394
395
 
# File 'lib/oci/analytics/models/create_analytics_instance_details.rb', line 393

def to_s
  to_hash.to_s
end