Class: OCI::GoldenGate::Models::CreateOggDeploymentDetails

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

Overview

Deployment Data for creating an OggDeployment

Constant Summary collapse

CREDENTIAL_STORE_ENUM = 
[
  CREDENTIAL_STORE_GOLDENGATE = 'GOLDENGATE'.freeze,
  CREDENTIAL_STORE_IAM = 'IAM'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOggDeploymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :deployment_name (String) —

    The value to assign to the #deployment_name property

  • :credential_store (String) —

    The value to assign to the #credential_store property

  • :identity_domain_id (String) —

    The value to assign to the #identity_domain_id property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :admin_username (String) —

    The value to assign to the #admin_username property

  • :admin_password (String) —

    The value to assign to the #admin_password property

  • :certificate (String) —

    The value to assign to the #certificate property

  • :key (String) —

    The value to assign to the #key property

  • :ogg_version (String) —

    The value to assign to the #ogg_version property



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 115

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

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

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

  self.credential_store = attributes[:'credentialStore'] if attributes[:'credentialStore']
  self.credential_store = "GOLDENGATE" if credential_store.nil? && !attributes.key?(:'credentialStore') # rubocop:disable Style/StringLiterals

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

  self.credential_store = attributes[:'credential_store'] if attributes[:'credential_store']
  self.credential_store = "GOLDENGATE" if credential_store.nil? && !attributes.key?(:'credentialStore') && !attributes.key?(:'credential_store') # rubocop:disable Style/StringLiterals

  self.identity_domain_id = attributes[:'identityDomainId'] if attributes[:'identityDomainId']

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

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

  self.admin_username = attributes[:'adminUsername'] if attributes[:'adminUsername']

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

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

  self.admin_password = attributes[:'adminPassword'] if attributes[:'adminPassword']

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

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

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

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

  self.ogg_version = attributes[:'oggVersion'] if attributes[:'oggVersion']

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

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

Instance Attribute Details

#admin_password ⇒ String

The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as '$', '^', or '?' are not allowed. This field will be deprecated and replaced by "passwordSecretId".

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 49

def admin_password
  @admin_password
end

#admin_username ⇒ String

The GoldenGate deployment console username.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 41

def admin_username
  @admin_username
end

#certificate ⇒ String

A PEM-encoded SSL certificate.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 54

def certificate
  @certificate
end

#credential_store ⇒ String

The type of credential store for OGG.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 26

def credential_store
  @credential_store
end

#deployment_name ⇒ String

[Required] The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 21

def deployment_name
  @deployment_name
end

#identity_domain_id ⇒ String

The OCID of the Identity Domain when IAM credential store is used.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 31

def identity_domain_id
  @identity_domain_id
end

#key ⇒ String

A PEM-encoded private key.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 59

def key
  @key
end

#ogg_version ⇒ String

Version of OGG

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 64

def ogg_version
  @ogg_version
end

#password_secret_id ⇒ String

The OCID of the Secret where the deployment password is stored.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 36

def password_secret_id
  @password_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'deployment_name': :'deploymentName',
    'credential_store': :'credentialStore',
    'identity_domain_id': :'identityDomainId',
    'password_secret_id': :'passwordSecretId',
    'admin_username': :'adminUsername',
    'admin_password': :'adminPassword',
    'certificate': :'certificate',
    'key': :'key',
    'ogg_version': :'oggVersion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'deployment_name': :'String',
    'credential_store': :'String',
    'identity_domain_id': :'String',
    'password_secret_id': :'String',
    'admin_username': :'String',
    'admin_password': :'String',
    'certificate': :'String',
    'key': :'String',
    'ogg_version': :'String'
    # 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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 185

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

  self.class == other.class &&
    deployment_name == other.deployment_name &&
    credential_store == other.credential_store &&
    identity_domain_id == other.identity_domain_id &&
    password_secret_id == other.password_secret_id &&
    admin_username == other.admin_username &&
    admin_password == other.admin_password &&
    certificate == other.certificate &&
    key == other.key &&
    ogg_version == other.ogg_version
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 223

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


203
204
205
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 203

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 212

def hash
  [deployment_name, credential_store, identity_domain_id, password_secret_id, admin_username, admin_password, certificate, key, ogg_version].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 256

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



250
251
252
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 250

def to_s
  to_hash.to_s
end