Class: OCI::Desktops::Models::DesktopPoolVolumeSummary

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

Overview

Provides information about a volume within the desktop pool.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ DesktopPoolVolumeSummary

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

  • :name (String) —

    The value to assign to the #name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :user_name (String) —

    The value to assign to the #user_name property

  • :pool_id (String) —

    The value to assign to the #pool_id property

  • :availability_domain (String) —

    The value to assign to the #availability_domain 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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 101

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

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of the desktop pool.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 40

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


53
54
55
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 53

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the desktop pool volume.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 20

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The state of the desktop pool volume.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 28

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the desktop pool volume.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 24

def name
  @name
end

#pool_id ⇒ String

The OCID of the desktop pool to which this volume belongs.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 36

def pool_id
  @pool_id
end

#user_name ⇒ String

[Required] The owner of the desktop pool volume.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 32

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'lifecycle_state': :'lifecycleState',
    'user_name': :'userName',
    'pool_id': :'poolId',
    'availability_domain': :'availabilityDomain',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'lifecycle_state': :'String',
    'user_name': :'String',
    'pool_id': :'String',
    'availability_domain': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 168

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    lifecycle_state == other.lifecycle_state &&
    user_name == other.user_name &&
    pool_id == other.pool_id &&
    availability_domain == other.availability_domain &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 205

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


185
186
187
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 185

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 194

def hash
  [id, name, lifecycle_state, user_name, pool_id, availability_domain, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 238

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



232
233
234
 
# File 'lib/oci/desktops/models/desktop_pool_volume_summary.rb', line 232

def to_s
  to_hash.to_s
end