Class: OCI::Desktops::Models::DesktopPoolSummary

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

Overview

Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :maximum_size (Integer) —

    The value to assign to the #maximum_size property

  • :active_desktops (Integer) —

    The value to assign to the #active_desktops property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property

  • :contact_details (String) —

    The value to assign to the #contact_details property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
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
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 135

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

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

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

  self.active_desktops = attributes[:'activeDesktops'] if attributes[:'activeDesktops']

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

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

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

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

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

  self.contact_details = attributes[:'contactDetails'] if attributes[:'contactDetails']

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

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

  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']
end

Instance Attribute Details

#active_desktops ⇒ Integer

The number of active desktops in the desktop pool.

Returns:

  • (Integer) 


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

def active_desktops
  @active_desktops
end

#compartment_id ⇒ String

[Required] The OCID of the compartment which will contain the desktop pool.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 74

def compartment_id
  @compartment_id
end

#contact_details ⇒ String

[Required] Contact information of the desktop pool administrator. Avoid entering confidential information.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 70

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the desktop pool.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the desktop pool.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#maximum_size ⇒ Integer

[Required] The maximum number of desktops permitted in the desktop pool.

Returns:

  • (Integer) 


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

def maximum_size
  @maximum_size
end

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

Security attributes for this resource. Each attribute can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def security_attributes
  @security_attributes
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 78

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'maximum_size': :'maximumSize',
    'active_desktops': :'activeDesktops',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'contact_details': :'contactDetails',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 100

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'maximum_size': :'Integer',
    'active_desktops': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'contact_details': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime'
    # 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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 224

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    maximum_size == other.maximum_size &&
    active_desktops == other.active_desktops &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    contact_details == other.contact_details &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 264

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


244
245
246
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 253

def hash
  [id, display_name, lifecycle_state, maximum_size, active_desktops, freeform_tags, defined_tags, security_attributes, contact_details, compartment_id, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 297

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



291
292
293
 
# File 'lib/oci/desktops/models/desktop_pool_summary.rb', line 291

def to_s
  to_hash.to_s
end