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



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

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

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

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

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

  self.group_to_roles_mapping = attributes[:'groupToRolesMapping'] if attributes[:'groupToRolesMapping']

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

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


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

def admin_password
  @admin_password
end

#admin_username ⇒ String

The GoldenGate deployment console username.

Returns:

  • (String) 


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

def admin_username
  @admin_username
end

#certificate ⇒ String

The base64 encoded content of the PEM file containing the SSL certificate.

Returns:

  • (String) 


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

def certificate
  @certificate
end

#credential_store ⇒ String

The type of credential store for OGG.

Returns:

  • (String) 


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

def credential_store
  @credential_store
end

#deployment_name ⇒ String

The name given to the GoldenGate service deployment. The name must contain only alphanumeric characters and must start with a letter. For standby deployment the deployment name is inherited from primary.

Returns:

  • (String) 


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

def deployment_name
  @deployment_name
end

#group_to_roles_mapping ⇒ OCI::GoldenGate::Models::GroupToRolesMappingDetails

Returns:



73
74
75
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 73

def group_to_roles_mapping
  @group_to_roles_mapping
end

#identity_domain_id ⇒ String

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

Returns:

  • (String) 


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

def identity_domain_id
  @identity_domain_id
end

#key ⇒ String

The base64 encoded content of the PEM file containing the private key.

Returns:

  • (String) 


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

def key
  @key
end

#key_secret_id ⇒ String

The OCID of the Secret where the deployment ssl private key is stored in PEM format.

Returns:

  • (String) 


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

def key_secret_id
  @key_secret_id
end

#ogg_version ⇒ String

Version of OGG

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 70

def ogg_version
  @ogg_version
end

#password_secret_id ⇒ String

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

Returns:

  • (String) 


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

def password_secret_id
  @password_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 76

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',
    'key_secret_id': :'keySecretId',
    'ogg_version': :'oggVersion',
    'group_to_roles_mapping': :'groupToRolesMapping'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/golden_gate/models/create_ogg_deployment_details.rb', line 95

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',
    'key_secret_id': :'String',
    'ogg_version': :'String',
    'group_to_roles_mapping': :'OCI::GoldenGate::Models::GroupToRolesMappingDetails'
    # 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/golden_gate/models/create_ogg_deployment_details.rb', line 212

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 &&
    key_secret_id == other.key_secret_id &&
    ogg_version == other.ogg_version &&
    group_to_roles_mapping == other.group_to_roles_mapping
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/golden_gate/models/create_ogg_deployment_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/golden_gate/models/create_ogg_deployment_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/golden_gate/models/create_ogg_deployment_details.rb', line 241

def hash
  [deployment_name, credential_store, identity_domain_id, password_secret_id, admin_username, admin_password, certificate, key, key_secret_id, ogg_version, group_to_roles_mapping].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/golden_gate/models/create_ogg_deployment_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/golden_gate/models/create_ogg_deployment_details.rb', line 279

def to_s
  to_hash.to_s
end