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

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

Overview

An AiDataPlatform is a unified platform for lifecycle management and governance of data and AI objects.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AI_FEATURE_STATUS_ENUM = 
[
  AI_FEATURE_STATUS_DISABLED = 'DISABLED'.freeze,
  AI_FEATURE_STATUS_ENABLING = 'ENABLING'.freeze,
  AI_FEATURE_STATUS_READY = 'READY'.freeze,
  AI_FEATURE_STATUS_FAILED = 'FAILED'.freeze,
  AI_FEATURE_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AiDataPlatform

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :ai_data_platform_type (String) —

    The value to assign to the #ai_data_platform_type property

  • :created_by (String) —

    The value to assign to the #created_by property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :alias_key (String) —

    The value to assign to the #alias_key property

  • :web_socket_endpoint (String) —

    The value to assign to the #web_socket_endpoint property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :ai_feature_status (String) —

    The value to assign to the #ai_feature_status property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details 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



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
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
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 181

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

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

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

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

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

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

  self.web_socket_endpoint = attributes[:'webSocketEndpoint'] if attributes[:'webSocketEndpoint']

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

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

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

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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

[Required] The AiDataPlatform type.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 49

def ai_data_platform_type
  @ai_data_platform_type
end

#ai_feature_status ⇒ String

The current aiFeatureStatus of the AiDataPlatform.

Returns:

  • (String) 


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

def ai_feature_status
  @ai_feature_status
end

#alias_key ⇒ String

The alias Id of the AiDataPlatform which is the short form of OCID.

Returns:

  • (String) 


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

def alias_key
  @alias_key
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#created_by ⇒ String

The OCID of the IAM user.

Returns:

  • (String) 


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

def created_by
  @created_by
end

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

[Required] 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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


97
98
99
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the AiDataPlatform.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the AiDataPlatform.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 79

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


112
113
114
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 112

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the AiDataPlatform was created, in the format defined by RFC 3339.

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the AiDataPlatform was updated, in the format defined by RFC 3339.

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#web_socket_endpoint ⇒ String

The WebSocket URL of the AiDataPlatform.

Returns:

  • (String) 


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

def web_socket_endpoint
  @web_socket_endpoint
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'ai_data_platform_type': :'aiDataPlatformType',
    'created_by': :'createdBy',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'alias_key': :'aliasKey',
    'web_socket_endpoint': :'webSocketEndpoint',
    'lifecycle_state': :'lifecycleState',
    'ai_feature_status': :'aiFeatureStatus',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'ai_data_platform_type': :'String',
    'created_by': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'alias_key': :'String',
    'web_socket_endpoint': :'String',
    'lifecycle_state': :'String',
    'ai_feature_status': :'String',
    'lifecycle_details': :'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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    ai_data_platform_type == other.ai_data_platform_type &&
    created_by == other.created_by &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    alias_key == other.alias_key &&
    web_socket_endpoint == other.web_socket_endpoint &&
    lifecycle_state == other.lifecycle_state &&
    ai_feature_status == other.ai_feature_status &&
    lifecycle_details == other.lifecycle_details &&
    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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 351

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


331
332
333
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 331

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



340
341
342
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 340

def hash
  [id, display_name, compartment_id, ai_data_platform_type, created_by, time_created, time_updated, alias_key, web_socket_endpoint, lifecycle_state, ai_feature_status, lifecycle_details, 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



384
385
386
387
388
389
390
391
392
393
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 384

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



378
379
380
 
# File 'lib/oci/ai_data_platform/models/ai_data_platform.rb', line 378

def to_s
  to_hash.to_s
end