Class: OCI::AiDataPlatform::Models::CreateAiDataPlatformDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb

Overview

The data to create a AiDataPlatform.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAiDataPlatformDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :ai_data_platform_type (String) —

    The value to assign to the #ai_data_platform_type property

  • :is_enable_ai_feature (BOOLEAN) —

    The value to assign to the #is_enable_ai_feature property

  • :vector_db_id (String) —

    The value to assign to the #vector_db_id property

  • :vector_db_admin_cred (String) —

    The value to assign to the #vector_db_admin_cred property

  • :vector_db_admin_secret_id (String) —

    The value to assign to the #vector_db_admin_secret_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :default_workspace_name (String) —

    The value to assign to the #default_workspace_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 126

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

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

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

  self.is_enable_ai_feature = attributes[:'isEnableAiFeature'] unless attributes[:'isEnableAiFeature'].nil?

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

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

  self.vector_db_id = attributes[:'vectorDbId'] if attributes[:'vectorDbId']

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

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

  self.vector_db_admin_cred = attributes[:'vectorDbAdminCred'] if attributes[:'vectorDbAdminCred']

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

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

  self.vector_db_admin_secret_id = attributes[:'vectorDbAdminSecretId'] if attributes[:'vectorDbAdminSecretId']

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

  self.vector_db_admin_secret_id = attributes[:'vector_db_admin_secret_id'] if attributes[:'vector_db_admin_secret_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.default_workspace_name = attributes[:'defaultWorkspaceName'] if attributes[:'defaultWorkspaceName']

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

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

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

  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

#ai_data_platform_type ⇒ String

The AiDataPlatform type.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 17

def ai_data_platform_type
  @ai_data_platform_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the AiDataPlatform in.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 42

def compartment_id
  @compartment_id
end

#default_workspace_name ⇒ String

The name for the default workspace for the AiDataPlatform

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 46

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


62
63
64
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 62

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 13

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


54
55
56
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 54

def freeform_tags
  @freeform_tags
end

#is_enable_ai_feature ⇒ BOOLEAN

The flag to enable/disable AiFeatures for the instance.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 22

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


69
70
71
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 69

def system_tags
  @system_tags
end

#vector_db_admin_cred ⇒ String

The Vector DB Lakehouse 26ai ADMIN user password.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 32

def vector_db_admin_cred
  @vector_db_admin_cred
end

#vector_db_admin_secret_id ⇒ String

The OCID of the OCI Vault secret holding the vector db Lakehouse 26ai Admin user password.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 37

def vector_db_admin_secret_id
  @vector_db_admin_secret_id
end

#vector_db_id ⇒ String

The OCID of the vector db Lakehouse 26ai.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 27

def vector_db_id
  @vector_db_id
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'ai_data_platform_type': :'aiDataPlatformType',
    'is_enable_ai_feature': :'isEnableAiFeature',
    'vector_db_id': :'vectorDbId',
    'vector_db_admin_cred': :'vectorDbAdminCred',
    'vector_db_admin_secret_id': :'vectorDbAdminSecretId',
    'compartment_id': :'compartmentId',
    'default_workspace_name': :'defaultWorkspaceName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'ai_data_platform_type': :'String',
    'is_enable_ai_feature': :'BOOLEAN',
    'vector_db_id': :'String',
    'vector_db_admin_cred': :'String',
    'vector_db_admin_secret_id': :'String',
    'compartment_id': :'String',
    'default_workspace_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    '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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 206

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

  self.class == other.class &&
    display_name == other.display_name &&
    ai_data_platform_type == other.ai_data_platform_type &&
    is_enable_ai_feature == other.is_enable_ai_feature &&
    vector_db_id == other.vector_db_id &&
    vector_db_admin_cred == other.vector_db_admin_cred &&
    vector_db_admin_secret_id == other.vector_db_admin_secret_id &&
    compartment_id == other.compartment_id &&
    default_workspace_name == other.default_workspace_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 246

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


226
227
228
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 226

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 235

def hash
  [display_name, ai_data_platform_type, is_enable_ai_feature, vector_db_id, vector_db_admin_cred, vector_db_admin_secret_id, compartment_id, default_workspace_name, freeform_tags, defined_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



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 279

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



273
274
275
 
# File 'lib/oci/ai_data_platform/models/create_ai_data_platform_details.rb', line 273

def to_s
  to_hash.to_s
end