Class: OCI::GoldenGate::Models::CreateDeploymentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/create_deployment_details.rb

Overview

The information about a new Deployment.

Constant Summary collapse

LICENSE_MODEL_ENUM = 
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze
].freeze
DEPLOYMENT_TYPE_ENUM = 
[
  DEPLOYMENT_TYPE_OGG = 'OGG'.freeze,
  DEPLOYMENT_TYPE_DATABASE_ORACLE = 'DATABASE_ORACLE'.freeze,
  DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'.freeze,
  DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER = 'DATABASE_MICROSOFT_SQLSERVER'.freeze,
  DEPLOYMENT_TYPE_DATABASE_MYSQL = 'DATABASE_MYSQL'.freeze,
  DEPLOYMENT_TYPE_DATABASE_POSTGRESQL = 'DATABASE_POSTGRESQL'.freeze,
  DEPLOYMENT_TYPE_DATABASE_DB2_ZOS = 'DATABASE_DB2ZOS'.freeze,
  DEPLOYMENT_TYPE_GGSA = 'GGSA'.freeze,
  DEPLOYMENT_TYPE_DATA_TRANSFORMS = 'DATA_TRANSFORMS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDeploymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 198

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

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

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

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

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

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.load_balancer_subnet_id = attributes[:'loadBalancerSubnetId'] if attributes[:'loadBalancerSubnetId']

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

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.is_public = attributes[:'isPublic'] unless attributes[:'isPublic'].nil?

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

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

  self.cpu_core_count = attributes[:'cpuCoreCount'] if attributes[:'cpuCoreCount']

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

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

  self.is_auto_scaling_enabled = attributes[:'isAutoScalingEnabled'] unless attributes[:'isAutoScalingEnabled'].nil?

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

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

  self.deployment_type = attributes[:'deploymentType'] if attributes[:'deploymentType']

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

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

  self.ogg_data = attributes[:'oggData'] if attributes[:'oggData']

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

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

  self.maintenance_window = attributes[:'maintenanceWindow'] if attributes[:'maintenanceWindow']

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

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

  self.maintenance_configuration = attributes[:'maintenanceConfiguration'] if attributes[:'maintenanceConfiguration']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 47

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

[Required] The Minimum number of OCPUs to be made available for this Deployment.

Returns:

  • (Integer) 


99
100
101
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 99

def cpu_core_count
  @cpu_core_count
end

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

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


62
63
64
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 62

def defined_tags
  @defined_tags
end

#deployment_backup_id ⇒ String

The OCID of the backup being referenced.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 67

def deployment_backup_id
  @deployment_backup_id
end

#deployment_type ⇒ String

[Required] The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 111

def deployment_type
  @deployment_type
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 42

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 32

def display_name
  @display_name
end

#fqdn ⇒ String

A three-label Fully Qualified Domain Name (FQDN) for a resource.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 84

def fqdn
  @fqdn
end

#freeform_tags ⇒ Hash<String, String>

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


55
56
57
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 55

def freeform_tags
  @freeform_tags
end

#is_auto_scaling_enabled ⇒ BOOLEAN

[Required] Indicates if auto scaling is enabled for the Deployment's CPU core count.

Returns:

  • (BOOLEAN) 


104
105
106
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 104

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_public ⇒ BOOLEAN

True if this object is publicly available.

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 94

def is_public
  @is_public
end

#license_model ⇒ String

[Required] The Oracle license model that applies to a Deployment.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 37

def license_model
  @license_model
end

#load_balancer_subnet_id ⇒ String

The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatiblity this is an optional property for now, but it will become mandatory (for public deployments only) after October 1, 2024.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 79

def load_balancer_subnet_id
  @load_balancer_subnet_id
end

#maintenance_configuration ⇒ OCI::GoldenGate::Models::CreateMaintenanceConfigurationDetails

Returns:



120
121
122
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 120

def maintenance_configuration
  @maintenance_configuration
end

#maintenance_window ⇒ OCI::GoldenGate::Models::CreateMaintenanceWindowDetails

Returns:



117
118
119
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 117

def maintenance_window
  @maintenance_window
end

#nsg_ids ⇒ Array<String>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:

  • (Array<String>) 


89
90
91
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 89

def nsg_ids
  @nsg_ids
end

#ogg_data ⇒ OCI::GoldenGate::Models::CreateOggDeploymentDetails

Returns:



114
115
116
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 114

def ogg_data
  @ogg_data
end

#subnet_id ⇒ String

[Required] The OCID of the subnet of the deployment's private endpoint.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 72

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



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/golden_gate/models/create_deployment_details.rb', line 123

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'license_model': :'licenseModel',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'deployment_backup_id': :'deploymentBackupId',
    'subnet_id': :'subnetId',
    'load_balancer_subnet_id': :'loadBalancerSubnetId',
    'fqdn': :'fqdn',
    'nsg_ids': :'nsgIds',
    'is_public': :'isPublic',
    'cpu_core_count': :'cpuCoreCount',
    'is_auto_scaling_enabled': :'isAutoScalingEnabled',
    'deployment_type': :'deploymentType',
    'ogg_data': :'oggData',
    'maintenance_window': :'maintenanceWindow',
    'maintenance_configuration': :'maintenanceConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 149

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'license_model': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'deployment_backup_id': :'String',
    'subnet_id': :'String',
    'load_balancer_subnet_id': :'String',
    'fqdn': :'String',
    'nsg_ids': :'Array<String>',
    'is_public': :'BOOLEAN',
    'cpu_core_count': :'Integer',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'deployment_type': :'String',
    'ogg_data': :'OCI::GoldenGate::Models::CreateOggDeploymentDetails',
    'maintenance_window': :'OCI::GoldenGate::Models::CreateMaintenanceWindowDetails',
    'maintenance_configuration': :'OCI::GoldenGate::Models::CreateMaintenanceConfigurationDetails'
    # 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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 328

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

  self.class == other.class &&
    display_name == other.display_name &&
    license_model == other.license_model &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    deployment_backup_id == other.deployment_backup_id &&
    subnet_id == other.subnet_id &&
    load_balancer_subnet_id == other.load_balancer_subnet_id &&
    fqdn == other.fqdn &&
    nsg_ids == other.nsg_ids &&
    is_public == other.is_public &&
    cpu_core_count == other.cpu_core_count &&
    is_auto_scaling_enabled == other.is_auto_scaling_enabled &&
    deployment_type == other.deployment_type &&
    ogg_data == other.ogg_data &&
    maintenance_window == other.maintenance_window &&
    maintenance_configuration == other.maintenance_configuration
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 375

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


355
356
357
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 355

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



364
365
366
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 364

def hash
  [display_name, license_model, description, compartment_id, freeform_tags, defined_tags, deployment_backup_id, subnet_id, load_balancer_subnet_id, fqdn, nsg_ids, is_public, cpu_core_count, is_auto_scaling_enabled, deployment_type, ogg_data, maintenance_window, maintenance_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
417
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 408

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



402
403
404
 
# File 'lib/oci/golden_gate/models/create_deployment_details.rb', line 402

def to_s
  to_hash.to_s
end