Class: OCI::Desktops::Models::DesktopSummary

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

Overview

Provides information about a desktop.

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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DesktopSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



118
119
120
121
122
123
124
125
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
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 118

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

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

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

  self.pool_id = attributes[:'poolId'] if attributes[:'poolId']

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

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

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

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

Instance Attribute Details

#connection ⇒ OCI::Desktops::Models::DesktopConnection

Returns:



64
65
66
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 64

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


61
62
63
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 61

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user friendly display name. Avoid entering confidential information.

Returns:

  • (String) 


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

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/desktops/models/desktop_summary.rb', line 54

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the desktop.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 25

def id
  @id
end

#image ⇒ OCI::Desktops::Models::DesktopImage

Returns:



48
49
50
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 48

def image
  @image
end

#lifecycle_state ⇒ String

[Required] The state of the desktop.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 29

def lifecycle_state
  @lifecycle_state
end

#pool_id ⇒ String

[Required] The pool ID of the desktop.

Returns:

  • (String) 


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

def pool_id
  @pool_id
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created.

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 33

def time_created
  @time_created
end

#user_name ⇒ String

[Required] The owner of the desktop.

Returns:

  • (String) 


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

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'display_name': :'displayName',
    'user_name': :'userName',
    'pool_id': :'poolId',
    'image': :'image',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'connection': :'connection'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'display_name': :'String',
    'user_name': :'String',
    'pool_id': :'String',
    'image': :'OCI::Desktops::Models::DesktopImage',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'connection': :'OCI::Desktops::Models::DesktopConnection'
    # 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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 193

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

  self.class == other.class &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    display_name == other.display_name &&
    user_name == other.user_name &&
    pool_id == other.pool_id &&
    image == other.image &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    connection == other.connection
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 232

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


212
213
214
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 221

def hash
  [id, lifecycle_state, time_created, display_name, user_name, pool_id, image, freeform_tags, defined_tags, connection].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 265

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



259
260
261
 
# File 'lib/oci/desktops/models/desktop_summary.rb', line 259

def to_s
  to_hash.to_s
end