Class: OCI::GoldenGate::Models::OggDeployment

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

Overview

Deployment Data for an OggDeployment

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OggDeployment

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

  • :admin_username (String) —

    The value to assign to the #admin_username property

  • :ogg_version (String) —

    The value to assign to the #ogg_version property

  • :certificate (String) —

    The value to assign to the #certificate 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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 98

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

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

Instance Attribute Details

#admin_username ⇒ String

[Required] The GoldenGate deployment console username.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 28

def admin_username
  @admin_username
end

#certificate ⇒ String

A PEM-encoded SSL certificate.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 38

def certificate
  @certificate
end

#credential_store ⇒ String

The type of credential store for OGG.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 43

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) 


23
24
25
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 23

def deployment_name
  @deployment_name
end

#identity_domain_id ⇒ String

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

Returns:

  • (String) 


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

def identity_domain_id
  @identity_domain_id
end

#ogg_version ⇒ String

Version of OGG

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 33

def ogg_version
  @ogg_version
end

#password_secret_id ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 53

def password_secret_id
  @password_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 56

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

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 71

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



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 165

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

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 201

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


181
182
183
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 181

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 190

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 234

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



228
229
230
 
# File 'lib/oci/golden_gate/models/ogg_deployment.rb', line 228

def to_s
  to_hash.to_s
end