Class: OCI::Ocvp::Models::CreateByolDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/create_byol_details.rb

Overview

The details to create a BYOL.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateByolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :software_type (String) —

    The value to assign to the #software_type property

  • :total_units (Integer) —

    The value to assign to the #total_units property

  • :time_term_start (DateTime) —

    The value to assign to the #time_term_start property

  • :time_term_end (DateTime) —

    The value to assign to the #time_term_end property

  • :entitlement_key (String) —

    The value to assign to the #entitlement_key property

  • :site_id (String) —

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



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
203
204
205
206
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 139

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

  self.software_type = attributes[:'softwareType'] if attributes[:'softwareType']

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

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

  self.total_units = attributes[:'totalUnits'] if attributes[:'totalUnits']

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

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

  self.time_term_start = attributes[:'timeTermStart'] if attributes[:'timeTermStart']

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

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

  self.time_term_end = attributes[:'timeTermEnd'] if attributes[:'timeTermEnd']

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

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

  self.entitlement_key = attributes[:'entitlementKey'] if attributes[:'entitlementKey']

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

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

  self.site_id = attributes[:'siteId'] if attributes[:'siteId']

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the BYOL.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 15

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


82
83
84
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 82

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the BYOL.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 24

def description
  @description
end

#display_name ⇒ String

[Required] A descriptive name for the BYOL.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 20

def display_name
  @display_name
end

#entitlement_key ⇒ String

[Required] The Broadcom-supplied identifier of a BYOL license.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 61

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


74
75
76
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 74

def freeform_tags
  @freeform_tags
end

#site_id ⇒ String

The hyperscaler identifier in Broadcom systems.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 66

def site_id
  @site_id
end

#software_type ⇒ String

[Required] The type of VMware software the BYOL applies to. Supported values: - VCF (VMware Cloud Foundation) - VSAN (VMware vSAN) - VDEFEND (VMware vDefend Firewall) - AVI_LOAD_BALANCER (VMware Avi Load Balancer)

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 34

def software_type
  @software_type
end

#time_term_end ⇒ DateTime

[Required] The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 56

def time_term_end
  @time_term_end
end

#time_term_start ⇒ DateTime

[Required] The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 50

def time_term_start
  @time_term_start
end

#total_units ⇒ Integer

[Required] Total quantity of licensed units for the specified softwareType:

  • VCF, VDEFEND: number of OCPUs

  • VSAN: storage capacity in TiB (tebibytes)

  • AVI_LOAD_BALANCER: number of instances

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 43

def total_units
  @total_units
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
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'software_type': :'softwareType',
    'total_units': :'totalUnits',
    'time_term_start': :'timeTermStart',
    'time_term_end': :'timeTermEnd',
    'entitlement_key': :'entitlementKey',
    'site_id': :'siteId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'software_type': :'String',
    'total_units': :'Integer',
    'time_term_start': :'DateTime',
    'time_term_end': :'DateTime',
    'entitlement_key': :'String',
    'site_id': :'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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 215

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    software_type == other.software_type &&
    total_units == other.total_units &&
    time_term_start == other.time_term_start &&
    time_term_end == other.time_term_end &&
    entitlement_key == other.entitlement_key &&
    site_id == other.site_id &&
    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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 255

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


235
236
237
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 244

def hash
  [compartment_id, display_name, description, software_type, total_units, time_term_start, time_term_end, entitlement_key, site_id, 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



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 288

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



282
283
284
 
# File 'lib/oci/ocvp/models/create_byol_details.rb', line 282

def to_s
  to_hash.to_s
end