Class: OCI::Nosql::Models::Table
- Inherits:
-
Object
- Object
- OCI::Nosql::Models::Table
- Defined in:
- lib/oci/nosql/models/table.rb
Overview
Complete metadata about a table.
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_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- SCHEMA_STATE_ENUM =
[ SCHEMA_STATE_MUTABLE = 'MUTABLE'.freeze, SCHEMA_STATE_FROZEN = 'FROZEN'.freeze, SCHEMA_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] Compartment Identifier.
-
#ddl_statement ⇒ String
A DDL statement representing the schema.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] Unique identifier that is immutable.
-
#is_auto_reclaimable ⇒ BOOLEAN
True if this table can be reclaimed after an idle period.
-
#is_multi_region ⇒ BOOLEAN
True if this table is currently a member of a replication set.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The state of a table.
-
#local_replica_initialization_in_percent ⇒ Integer
If this table is in a replication set, this value represents the progress of the initialization of the replica's data.
-
#name ⇒ String
Human-friendly table name, immutable.
-
#replicas ⇒ Array<OCI::Nosql::Models::Replica>
An array of Replica listing this table's replicas, if any.
- #schema ⇒ OCI::Nosql::Models::Schema
-
#schema_state ⇒ String
The current state of this table's schema.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Read-only system tag.
- #table_limits ⇒ OCI::Nosql::Models::TableLimits
-
#time_created ⇒ DateTime
The time the the table was created.
-
#time_of_expiration ⇒ DateTime
If lifecycleState is INACTIVE, indicates when this table will be automatically removed.
-
#time_updated ⇒ DateTime
The time the the table's metadata was last updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Table
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Table
Initializes the object
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 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 |
# File 'lib/oci/nosql/models/table.rb', line 207 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.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.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.table_limits = attributes[:'tableLimits'] if attributes[:'tableLimits'] raise 'You cannot provide both :tableLimits and :table_limits' if attributes.key?(:'tableLimits') && attributes.key?(:'table_limits') self.table_limits = attributes[:'table_limits'] if attributes[:'table_limits'] 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.is_auto_reclaimable = attributes[:'isAutoReclaimable'] unless attributes[:'isAutoReclaimable'].nil? raise 'You cannot provide both :isAutoReclaimable and :is_auto_reclaimable' if attributes.key?(:'isAutoReclaimable') && attributes.key?(:'is_auto_reclaimable') self.is_auto_reclaimable = attributes[:'is_auto_reclaimable'] unless attributes[:'is_auto_reclaimable'].nil? self.time_of_expiration = attributes[:'timeOfExpiration'] if attributes[:'timeOfExpiration'] raise 'You cannot provide both :timeOfExpiration and :time_of_expiration' if attributes.key?(:'timeOfExpiration') && attributes.key?(:'time_of_expiration') self.time_of_expiration = attributes[:'time_of_expiration'] if attributes[:'time_of_expiration'] 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.schema = attributes[:'schema'] if attributes[:'schema'] self.ddl_statement = attributes[:'ddlStatement'] if attributes[:'ddlStatement'] raise 'You cannot provide both :ddlStatement and :ddl_statement' if attributes.key?(:'ddlStatement') && attributes.key?(:'ddl_statement') self.ddl_statement = attributes[:'ddl_statement'] if attributes[:'ddl_statement'] self.schema_state = attributes[:'schemaState'] if attributes[:'schemaState'] raise 'You cannot provide both :schemaState and :schema_state' if attributes.key?(:'schemaState') && attributes.key?(:'schema_state') self.schema_state = attributes[:'schema_state'] if attributes[:'schema_state'] self.is_multi_region = attributes[:'isMultiRegion'] unless attributes[:'isMultiRegion'].nil? raise 'You cannot provide both :isMultiRegion and :is_multi_region' if attributes.key?(:'isMultiRegion') && attributes.key?(:'is_multi_region') self.is_multi_region = attributes[:'is_multi_region'] unless attributes[:'is_multi_region'].nil? self.local_replica_initialization_in_percent = attributes[:'localReplicaInitializationInPercent'] if attributes[:'localReplicaInitializationInPercent'] raise 'You cannot provide both :localReplicaInitializationInPercent and :local_replica_initialization_in_percent' if attributes.key?(:'localReplicaInitializationInPercent') && attributes.key?(:'local_replica_initialization_in_percent') self.local_replica_initialization_in_percent = attributes[:'local_replica_initialization_in_percent'] if attributes[:'local_replica_initialization_in_percent'] self.replicas = attributes[:'replicas'] if attributes[:'replicas'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] Compartment Identifier.
39 40 41 |
# File 'lib/oci/nosql/models/table.rb', line 39 def compartment_id @compartment_id end |
#ddl_statement ⇒ String
A DDL statement representing the schema.
81 82 83 |
# File 'lib/oci/nosql/models/table.rb', line 81 def ddl_statement @ddl_statement end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
117 118 119 |
# File 'lib/oci/nosql/models/table.rb', line 117 def @defined_tags end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
110 111 112 |
# File 'lib/oci/nosql/models/table.rb', line 110 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier that is immutable.
31 32 33 |
# File 'lib/oci/nosql/models/table.rb', line 31 def id @id end |
#is_auto_reclaimable ⇒ BOOLEAN
True if this table can be reclaimed after an idle period.
62 63 64 |
# File 'lib/oci/nosql/models/table.rb', line 62 def is_auto_reclaimable @is_auto_reclaimable end |
#is_multi_region ⇒ BOOLEAN
True if this table is currently a member of a replication set.
92 93 94 |
# File 'lib/oci/nosql/models/table.rb', line 92 def is_multi_region @is_multi_region end |
#lifecycle_details ⇒ String
A message describing the current state in more detail.
74 75 76 |
# File 'lib/oci/nosql/models/table.rb', line 74 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The state of a table.
58 59 60 |
# File 'lib/oci/nosql/models/table.rb', line 58 def lifecycle_state @lifecycle_state end |
#local_replica_initialization_in_percent ⇒ Integer
If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.
99 100 101 |
# File 'lib/oci/nosql/models/table.rb', line 99 def local_replica_initialization_in_percent @local_replica_initialization_in_percent end |
#name ⇒ String
Human-friendly table name, immutable.
35 36 37 |
# File 'lib/oci/nosql/models/table.rb', line 35 def name @name end |
#replicas ⇒ Array<OCI::Nosql::Models::Replica>
An array of Replica listing this table's replicas, if any
103 104 105 |
# File 'lib/oci/nosql/models/table.rb', line 103 def replicas @replicas end |
#schema ⇒ OCI::Nosql::Models::Schema
77 78 79 |
# File 'lib/oci/nosql/models/table.rb', line 77 def schema @schema end |
#schema_state ⇒ String
The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
88 89 90 |
# File 'lib/oci/nosql/models/table.rb', line 88 def schema_state @schema_state end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is \"orcl-cloud\"
; and the only key in that namespace is \"free-tier-retained\"
. Example: {\"orcl-cloud\"\": {\"free-tier-retained\": \"true\"}}
126 127 128 |
# File 'lib/oci/nosql/models/table.rb', line 126 def @system_tags end |
#table_limits ⇒ OCI::Nosql::Models::TableLimits
54 55 56 |
# File 'lib/oci/nosql/models/table.rb', line 54 def table_limits @table_limits end |
#time_created ⇒ DateTime
The time the the table was created. An RFC3339 formatted datetime string.
45 46 47 |
# File 'lib/oci/nosql/models/table.rb', line 45 def time_created @time_created end |
#time_of_expiration ⇒ DateTime
If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
69 70 71 |
# File 'lib/oci/nosql/models/table.rb', line 69 def time_of_expiration @time_of_expiration end |
#time_updated ⇒ DateTime
The time the the table's metadata was last updated. An RFC3339 formatted datetime string.
51 52 53 |
# File 'lib/oci/nosql/models/table.rb', line 51 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/nosql/models/table.rb', line 129 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'table_limits': :'tableLimits', 'lifecycle_state': :'lifecycleState', 'is_auto_reclaimable': :'isAutoReclaimable', 'time_of_expiration': :'timeOfExpiration', 'lifecycle_details': :'lifecycleDetails', 'schema': :'schema', 'ddl_statement': :'ddlStatement', 'schema_state': :'schemaState', 'is_multi_region': :'isMultiRegion', 'local_replica_initialization_in_percent': :'localReplicaInitializationInPercent', 'replicas': :'replicas', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/nosql/models/table.rb', line 156 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'table_limits': :'OCI::Nosql::Models::TableLimits', 'lifecycle_state': :'String', 'is_auto_reclaimable': :'BOOLEAN', 'time_of_expiration': :'DateTime', 'lifecycle_details': :'String', 'schema': :'OCI::Nosql::Models::Schema', 'ddl_statement': :'String', 'schema_state': :'String', 'is_multi_region': :'BOOLEAN', 'local_replica_initialization_in_percent': :'Integer', 'replicas': :'Array<OCI::Nosql::Models::Replica>', '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.
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
# File 'lib/oci/nosql/models/table.rb', line 345 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && compartment_id == other.compartment_id && time_created == other.time_created && time_updated == other.time_updated && table_limits == other.table_limits && lifecycle_state == other.lifecycle_state && is_auto_reclaimable == other.is_auto_reclaimable && time_of_expiration == other.time_of_expiration && lifecycle_details == other.lifecycle_details && schema == other.schema && ddl_statement == other.ddl_statement && schema_state == other.schema_state && is_multi_region == other.is_multi_region && local_replica_initialization_in_percent == other.local_replica_initialization_in_percent && replicas == other.replicas && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
# File 'lib/oci/nosql/models/table.rb', line 393 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
373 374 375 |
# File 'lib/oci/nosql/models/table.rb', line 373 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
382 383 384 |
# File 'lib/oci/nosql/models/table.rb', line 382 def hash [id, name, compartment_id, time_created, time_updated, table_limits, lifecycle_state, is_auto_reclaimable, time_of_expiration, lifecycle_details, schema, ddl_statement, schema_state, is_multi_region, local_replica_initialization_in_percent, replicas, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
426 427 428 429 430 431 432 433 434 435 |
# File 'lib/oci/nosql/models/table.rb', line 426 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
420 421 422 |
# File 'lib/oci/nosql/models/table.rb', line 420 def to_s to_hash.to_s end |