Class: OCI::Desktops::Models::DesktopPoolDesktopSummary

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

Overview

Provides information about a desktop within a desktop pool, such as if it is assigned to a user, the state, owner, desktop pool, resource id, and time created.

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 = {}) ⇒ DesktopPoolDesktopSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
172
173
174
175
176
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 119

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

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

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

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

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

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

  self.is_assigned = attributes[:'isAssigned'] unless attributes[:'isAssigned'].nil?

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

  self.is_assigned = attributes[:'is_assigned'] unless attributes[:'is_assigned'].nil?

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



65
66
67
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 65

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


62
63
64
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 62

def defined_tags
  @defined_tags
end

#desktop_id ⇒ String

[Required] The OCID of the desktop.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 38

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


55
56
57
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 55

def freeform_tags
  @freeform_tags
end

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

Returns:



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

def image
  @image
end

#instance_id ⇒ String

[Required] The OCID of the compute resource used by this desktop.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 30

def instance_id
  @instance_id
end

#is_assigned ⇒ BOOLEAN

[Required] Indicates whether the desktop is assigned to a user.

Returns:

  • (BOOLEAN) 


42
43
44
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 42

def is_assigned
  @is_assigned
end

#lifecycle_state ⇒ String

[Required] The state of the desktop.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 26

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 46

def time_created
  @time_created
end

#user_name ⇒ String

The owner of the desktop.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 34

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'lifecycle_state': :'lifecycleState',
    'instance_id': :'instanceId',
    'user_name': :'userName',
    'desktop_id': :'desktopId',
    'is_assigned': :'isAssigned',
    'time_created': :'timeCreated',
    'image': :'image',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'connection': :'connection'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'lifecycle_state': :'String',
    'instance_id': :'String',
    'user_name': :'String',
    'desktop_id': :'String',
    'is_assigned': :'BOOLEAN',
    'time_created': :'DateTime',
    '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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 198

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

  self.class == other.class &&
    lifecycle_state == other.lifecycle_state &&
    instance_id == other.instance_id &&
    user_name == other.user_name &&
    desktop_id == other.desktop_id &&
    is_assigned == other.is_assigned &&
    time_created == other.time_created &&
    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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 237

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


217
218
219
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 226

def hash
  [lifecycle_state, instance_id, user_name, desktop_id, is_assigned, time_created, 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



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 270

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



264
265
266
 
# File 'lib/oci/desktops/models/desktop_pool_desktop_summary.rb', line 264

def to_s
  to_hash.to_s
end