Class: OCI::DataIntegration::Models::WorkspaceSummary
- Inherits:
-
Object
- Object
- OCI::DataIntegration::Models::WorkspaceSummary
- Defined in:
- lib/oci/data_integration/models/workspace_summary.rb
Overview
Summary details of a workspace.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_STARTING = 'STARTING'.freeze, LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze, LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment that contains the workspace.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#description ⇒ String
A user defined description for the workspace.
-
#display_name ⇒ String
A user-friendly display name that is changeable.
-
#endpoint_id ⇒ String
DCMS endpoint associated with the container/workspace.
-
#endpoint_name ⇒ String
Name of the private endpoint associated with the container/workspace.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
A system-generated and immutable identifier assigned to the workspace upon creation.
-
#lifecycle_state ⇒ String
The current state of the workspace.
-
#registry_id ⇒ String
DCMS registry associated with the container/workspace.
-
#state_message ⇒ String
A detailed description about the current state of the workspace.
-
#time_created ⇒ DateTime
The date and time the workspace was created, in the timestamp format defined by RFC3339.
-
#time_updated ⇒ DateTime
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
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 = {}) ⇒ WorkspaceSummary
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 = {}) ⇒ WorkspaceSummary
Initializes the object
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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 145 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.description = attributes[:'description'] if attributes[:'description'] 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.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. = 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.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. = attributes[:'stateMessage'] if attributes[:'stateMessage'] raise 'You cannot provide both :stateMessage and :state_message' if attributes.key?(:'stateMessage') && attributes.key?(:'state_message') self. = attributes[:'state_message'] if attributes[:'state_message'] self.endpoint_name = attributes[:'endpointName'] if attributes[:'endpointName'] raise 'You cannot provide both :endpointName and :endpoint_name' if attributes.key?(:'endpointName') && attributes.key?(:'endpoint_name') self.endpoint_name = attributes[:'endpoint_name'] if attributes[:'endpoint_name'] self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId'] raise 'You cannot provide both :endpointId and :endpoint_id' if attributes.key?(:'endpointId') && attributes.key?(:'endpoint_id') self.endpoint_id = attributes[:'endpoint_id'] if attributes[:'endpoint_id'] self.registry_id = attributes[:'registryId'] if attributes[:'registryId'] raise 'You cannot provide both :registryId and :registry_id' if attributes.key?(:'registryId') && attributes.key?(:'registry_id') self.registry_id = attributes[:'registry_id'] if attributes[:'registry_id'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID of the compartment that contains the workspace.
40 41 42 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 40 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
62 63 64 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 62 def @defined_tags end |
#description ⇒ String
A user defined description for the workspace.
32 33 34 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 32 def description @description end |
#display_name ⇒ String
A user-friendly display name that is changeable. Avoid entering confidential information.
36 37 38 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 36 def display_name @display_name end |
#endpoint_id ⇒ String
DCMS endpoint associated with the container/workspace. Returns null if there is none.
78 79 80 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 78 def endpoint_id @endpoint_id end |
#endpoint_name ⇒ String
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
74 75 76 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 74 def endpoint_name @endpoint_name 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\"}
56 57 58 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 56 def @freeform_tags end |
#id ⇒ String
A system-generated and immutable identifier assigned to the workspace upon creation.
28 29 30 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 28 def id @id end |
#lifecycle_state ⇒ String
The current state of the workspace.
66 67 68 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 66 def lifecycle_state @lifecycle_state end |
#registry_id ⇒ String
DCMS registry associated with the container/workspace. Returns null if there is none.
82 83 84 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 82 def registry_id @registry_id end |
#state_message ⇒ String
A detailed description about the current state of the workspace. Used to provide actionable information if the workspace is in a failed state.
70 71 72 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 70 def @state_message end |
#time_created ⇒ DateTime
The date and time the workspace was created, in the timestamp format defined by RFC3339.
45 46 47 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 45 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
50 51 52 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 50 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 85 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'description': :'description', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'lifecycle_state': :'lifecycleState', 'state_message': :'stateMessage', 'endpoint_name': :'endpointName', 'endpoint_id': :'endpointId', 'registry_id': :'registryId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 106 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'description': :'String', 'display_name': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'lifecycle_state': :'String', 'state_message': :'String', 'endpoint_name': :'String', 'endpoint_id': :'String', 'registry_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 242 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && description == other.description && display_name == other.display_name && compartment_id == other.compartment_id && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. && lifecycle_state == other.lifecycle_state && == other. && endpoint_name == other.endpoint_name && endpoint_id == other.endpoint_id && registry_id == other.registry_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 284 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
264 265 266 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 264 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
273 274 275 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 273 def hash [id, description, display_name, compartment_id, time_created, time_updated, , , lifecycle_state, , endpoint_name, endpoint_id, registry_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
317 318 319 320 321 322 323 324 325 326 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 317 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
311 312 313 |
# File 'lib/oci/data_integration/models/workspace_summary.rb', line 311 def to_s to_hash.to_s end |