Class: OCI::GoldenGate::Models::UpdateDeploymentDetails

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

Overview

The information to use to update a 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
ENVIRONMENT_TYPE_ENUM = 
[
  ENVIRONMENT_TYPE_PRODUCTION = 'PRODUCTION'.freeze,
  ENVIRONMENT_TYPE_DEVELOPMENT_OR_TESTING = 'DEVELOPMENT_OR_TESTING'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDeploymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



189
190
191
192
193
194
195
196
197
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
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 189

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

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

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

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

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

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

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

  self.backup_schedule = attributes[:'backupSchedule'] if attributes[:'backupSchedule']

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

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

Instance Attribute Details

#backup_schedule ⇒ OCI::GoldenGate::Models::UpdateBackupScheduleDetails

Returns:



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

def backup_schedule
  @backup_schedule
end

#cpu_core_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 40

def description
  @description
end

#display_name ⇒ String

An object's Display Name.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 25

def display_name
  @display_name
end

#environment_type ⇒ String

Specifies whether the deployment is used in a production or development/testing environment.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 35

def environment_type
  @environment_type
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/update_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>) 


48
49
50
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#is_auto_scaling_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_auto_scaling_enabled
  @is_auto_scaling_enabled
end

#is_public ⇒ BOOLEAN

True if this object is publicly available.

Returns:

  • (BOOLEAN) 


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

def is_public
  @is_public
end

#license_model ⇒ String

The Oracle license model that applies to a Deployment.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 30

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 compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 74

def load_balancer_subnet_id
  @load_balancer_subnet_id
end

#maintenance_configuration ⇒ OCI::GoldenGate::Models::UpdateMaintenanceConfigurationDetails

Returns:



108
109
110
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 108

def maintenance_configuration
  @maintenance_configuration
end

#maintenance_window ⇒ OCI::GoldenGate::Models::UpdateMaintenanceWindowDetails

Returns:



105
106
107
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 105

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


60
61
62
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 60

def nsg_ids
  @nsg_ids
end

#ogg_data ⇒ OCI::GoldenGate::Models::UpdateOggDeploymentDetails

Returns:



102
103
104
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 102

def ogg_data
  @ogg_data
end

#placements ⇒ Array<OCI::GoldenGate::Models::DeploymentPlacementDetails>

An array of local peers of deployment

Returns:



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

def placements
  @placements
end

#subnet_id ⇒ String

The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 114

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

.swagger_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'license_model': :'String',
    'environment_type': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'load_balancer_subnet_id': :'String',
    'is_public': :'BOOLEAN',
    'fqdn': :'String',
    'cpu_core_count': :'Integer',
    'is_auto_scaling_enabled': :'BOOLEAN',
    'placements': :'Array<OCI::GoldenGate::Models::DeploymentPlacementDetails>',
    'ogg_data': :'OCI::GoldenGate::Models::UpdateOggDeploymentDetails',
    'maintenance_window': :'OCI::GoldenGate::Models::UpdateMaintenanceWindowDetails',
    'maintenance_configuration': :'OCI::GoldenGate::Models::UpdateMaintenanceConfigurationDetails',
    'backup_schedule': :'OCI::GoldenGate::Models::UpdateBackupScheduleDetails'
    # 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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 315

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

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 362

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


342
343
344
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 342

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



351
352
353
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 351

def hash
  [display_name, license_model, environment_type, description, freeform_tags, defined_tags, nsg_ids, subnet_id, load_balancer_subnet_id, is_public, fqdn, cpu_core_count, is_auto_scaling_enabled, placements, ogg_data, maintenance_window, maintenance_configuration, backup_schedule].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 395

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



389
390
391
 
# File 'lib/oci/golden_gate/models/update_deployment_details.rb', line 389

def to_s
  to_hash.to_s
end