Class: OCI::GenerativeAi::Models::SemanticStoreSummary

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

Overview

Summary information for a SemanticStore.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SemanticStoreSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 150

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

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

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

  self.refresh_schedule = attributes[:'refreshSchedule'] if attributes[:'refreshSchedule']

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

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

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

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

#compartment_id ⇒ String

[Required] Owning compartment OCID for a SemanticStore.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 25

def compartment_id
  @compartment_id
end

#data_source ⇒ OCI::GenerativeAi::Models::DataSourceDetails

This attribute is required.

Returns:



29
30
31
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 29

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


77
78
79
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 77

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the SemanticStore.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 21

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 17

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


69
70
71
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 69

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An OCID that uniquely identifies a SemanticStore.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 13

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail that can provide actionable information.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 61

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the SemanticStore.

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#refresh_schedule ⇒ OCI::GenerativeAi::Models::RefreshScheduleDetails

Returns:



32
33
34
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 32

def refresh_schedule
  @refresh_schedule
end

#schemas ⇒ OCI::GenerativeAi::Models::SchemasDetails

This attribute is required.

Returns:



36
37
38
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 36

def schemas
  @schemas
end

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

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


84
85
86
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 84

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the semanticStore was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 40

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time that the semanticStore was updated in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 44

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'data_source': :'dataSource',
    'refresh_schedule': :'refreshSchedule',
    'schemas': :'schemas',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'data_source': :'OCI::GenerativeAi::Models::DataSourceDetails',
    'refresh_schedule': :'OCI::GenerativeAi::Models::RefreshScheduleDetails',
    'schemas': :'OCI::GenerativeAi::Models::SchemasDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 236

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    data_source == other.data_source &&
    refresh_schedule == other.refresh_schedule &&
    schemas == other.schemas &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 279

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


259
260
261
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 259

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 268

def hash
  [id, display_name, description, compartment_id, data_source, refresh_schedule, schemas, time_created, time_updated, lifecycle_state, 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



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 312

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



306
307
308
 
# File 'lib/oci/generative_ai/models/semantic_store_summary.rb', line 306

def to_s
  to_hash.to_s
end