Class: OCI::VisualBuilder::Models::CreateVbInstanceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/visual_builder/models/create_vb_instance_details.rb

Overview

The information about new VbInstance.

Constant Summary collapse

CONSUMPTION_MODEL_ENUM = 
[
  CONSUMPTION_MODEL_UCM = 'UCM'.freeze,
  CONSUMPTION_MODEL_GOV = 'GOV'.freeze,
  CONSUMPTION_MODEL_VB4_SAAS = 'VB4SAAS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVbInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 122

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

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

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

  self.node_count = attributes[:'nodeCount'] if attributes[:'nodeCount']

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

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

  self.is_visual_builder_enabled = attributes[:'isVisualBuilderEnabled'] unless attributes[:'isVisualBuilderEnabled'].nil?
  self.is_visual_builder_enabled = true if is_visual_builder_enabled.nil? && !attributes.key?(:'isVisualBuilderEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_visual_builder_enabled = attributes[:'is_visual_builder_enabled'] unless attributes[:'is_visual_builder_enabled'].nil?
  self.is_visual_builder_enabled = true if is_visual_builder_enabled.nil? && !attributes.key?(:'isVisualBuilderEnabled') && !attributes.key?(:'is_visual_builder_enabled') # rubocop:disable Style/StringLiterals

  self.custom_endpoint = attributes[:'customEndpoint'] if attributes[:'customEndpoint']

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

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

  self.alternate_custom_endpoints = attributes[:'alternateCustomEndpoints'] if attributes[:'alternateCustomEndpoints']

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

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

  self.consumption_model = attributes[:'consumptionModel'] if attributes[:'consumptionModel']

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

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

  self.network_endpoint_details = attributes[:'networkEndpointDetails'] if attributes[:'networkEndpointDetails']

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

  self.network_endpoint_details = attributes[:'network_endpoint_details'] if attributes[:'network_endpoint_details']
end

Instance Attribute Details

#alternate_custom_endpoints ⇒ Array<OCI::VisualBuilder::Models::CreateCustomEndpointDetails>

A list of alternate custom endpoints to be used for the vb instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).

Returns:



58
59
60
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 58

def alternate_custom_endpoints
  @alternate_custom_endpoints
end

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 23

def compartment_id
  @compartment_id
end

#consumption_model ⇒ String

Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 62

def consumption_model
  @consumption_model
end

#custom_endpoint ⇒ OCI::VisualBuilder::Models::CreateCustomEndpointDetails

Returns:



52
53
54
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 52

def custom_endpoint
  @custom_endpoint
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


37
38
39
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 37

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Vb Instance Identifier.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 19

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


30
31
32
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 30

def freeform_tags
  @freeform_tags
end

#idcs_open_id ⇒ String

Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 41

def idcs_open_id
  @idcs_open_id
end

#is_visual_builder_enabled ⇒ BOOLEAN

Visual Builder is enabled or not.

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 49

def is_visual_builder_enabled
  @is_visual_builder_enabled
end

#network_endpoint_details ⇒ OCI::VisualBuilder::Models::NetworkEndpointDetails

Returns:



65
66
67
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 65

def network_endpoint_details
  @network_endpoint_details
end

#node_count ⇒ Integer

[Required] The number of Nodes

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 45

def node_count
  @node_count
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
84
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'idcs_open_id': :'idcsOpenId',
    'node_count': :'nodeCount',
    'is_visual_builder_enabled': :'isVisualBuilderEnabled',
    'custom_endpoint': :'customEndpoint',
    'alternate_custom_endpoints': :'alternateCustomEndpoints',
    'consumption_model': :'consumptionModel',
    'network_endpoint_details': :'networkEndpointDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 87

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'idcs_open_id': :'String',
    'node_count': :'Integer',
    'is_visual_builder_enabled': :'BOOLEAN',
    'custom_endpoint': :'OCI::VisualBuilder::Models::CreateCustomEndpointDetails',
    'alternate_custom_endpoints': :'Array<OCI::VisualBuilder::Models::CreateCustomEndpointDetails>',
    'consumption_model': :'String',
    'network_endpoint_details': :'OCI::VisualBuilder::Models::NetworkEndpointDetails'
    # 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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 212

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    idcs_open_id == other.idcs_open_id &&
    node_count == other.node_count &&
    is_visual_builder_enabled == other.is_visual_builder_enabled &&
    custom_endpoint == other.custom_endpoint &&
    alternate_custom_endpoints == other.alternate_custom_endpoints &&
    consumption_model == other.consumption_model &&
    network_endpoint_details == other.network_endpoint_details
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 252

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


232
233
234
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 241

def hash
  [display_name, compartment_id, freeform_tags, defined_tags, idcs_open_id, node_count, is_visual_builder_enabled, custom_endpoint, alternate_custom_endpoints, consumption_model, network_endpoint_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 285

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



279
280
281
 
# File 'lib/oci/visual_builder/models/create_vb_instance_details.rb', line 279

def to_s
  to_hash.to_s
end