Class: OCI::GoldenGate::Models::JavaMessageServiceConnectionSummary

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

Overview

Summary of the Java Message Service Connection.

Constant Summary

Constants inherited from ConnectionSummary

ConnectionSummary::CONNECTION_TYPE_ENUM, ConnectionSummary::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectionSummary

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #nsg_ids, #routing_method, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConnectionSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ JavaMessageServiceConnectionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id proprety

  • :display_name (String)

    The value to assign to the #display_name proprety

  • :description (String)

    The value to assign to the #description proprety

  • :compartment_id (String)

    The value to assign to the #compartment_id proprety

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

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

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String)

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime)

    The value to assign to the #time_created proprety

  • :time_updated (DateTime)

    The value to assign to the #time_updated proprety

  • :vault_id (String)

    The value to assign to the #vault_id proprety

  • :key_id (String)

    The value to assign to the #key_id proprety

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>)

    The value to assign to the #ingress_ips proprety

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String)

    The value to assign to the #subnet_id proprety

  • :routing_method (String)

    The value to assign to the #routing_method proprety

  • :technology_type (String)

    The value to assign to the #technology_type property

  • :should_use_jndi (BOOLEAN)

    The value to assign to the #should_use_jndi property

  • :jndi_connection_factory (String)

    The value to assign to the #jndi_connection_factory property

  • :jndi_provider_url (String)

    The value to assign to the #jndi_provider_url property

  • :jndi_initial_context_factory (String)

    The value to assign to the #jndi_initial_context_factory property

  • :jndi_security_principal (String)

    The value to assign to the #jndi_security_principal property

  • :connection_url (String)

    The value to assign to the #connection_url property

  • :connection_factory (String)

    The value to assign to the #connection_factory property

  • :security_protocol (String)

    The value to assign to the #security_protocol property

  • :authentication_type (String)

    The value to assign to the #authentication_type property

  • :username (String)

    The value to assign to the #username property

  • :private_ip (String)

    The value to assign to the #private_ip property



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
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 202

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['connectionType'] = 'JAVA_MESSAGE_SERVICE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType']

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

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

  self.should_use_jndi = attributes[:'shouldUseJndi'] unless attributes[:'shouldUseJndi'].nil?

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

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

  self.jndi_connection_factory = attributes[:'jndiConnectionFactory'] if attributes[:'jndiConnectionFactory']

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

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

  self.jndi_provider_url = attributes[:'jndiProviderUrl'] if attributes[:'jndiProviderUrl']

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

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

  self.jndi_initial_context_factory = attributes[:'jndiInitialContextFactory'] if attributes[:'jndiInitialContextFactory']

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

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

  self.jndi_security_principal = attributes[:'jndiSecurityPrincipal'] if attributes[:'jndiSecurityPrincipal']

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

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

  self.connection_url = attributes[:'connectionUrl'] if attributes[:'connectionUrl']

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

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

  self.connection_factory = attributes[:'connectionFactory'] if attributes[:'connectionFactory']

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

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

  self.security_protocol = attributes[:'securityProtocol'] if attributes[:'securityProtocol']

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

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

  self.authentication_type = attributes[:'authenticationType'] if attributes[:'authenticationType']

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

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

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

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

Instance Attribute Details

#authentication_typeString

Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

Returns:

  • (String)


71
72
73
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 71

def authentication_type
  @authentication_type
end

#connection_factoryString

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

Returns:

  • (String)


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

def connection_factory
  @connection_factory
end

#connection_urlString

Connectin URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'

Returns:

  • (String)


52
53
54
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 52

def connection_url
  @connection_url
end

#jndi_connection_factoryString

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

Returns:

  • (String)


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

def jndi_connection_factory
  @jndi_connection_factory
end

#jndi_initial_context_factoryString

The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'

Returns:

  • (String)


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

def jndi_initial_context_factory
  @jndi_initial_context_factory
end

#jndi_provider_urlString

The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'

Returns:

  • (String)


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

def jndi_provider_url
  @jndi_provider_url
end

#jndi_security_principalString

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

Returns:

  • (String)


46
47
48
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 46

def jndi_security_principal
  @jndi_security_principal
end

#private_ipString

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:

  • (String)


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

def private_ip
  @private_ip
end

#security_protocolString

Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.

Returns:

  • (String)


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

def security_protocol
  @security_protocol
end

#should_use_jndiBOOLEAN

[Required] If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

Returns:

  • (BOOLEAN)


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

def should_use_jndi
  @should_use_jndi
end

#technology_typeString

[Required] The Java Message Service technology type.

Returns:

  • (String)


16
17
18
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 16

def technology_type
  @technology_type
end

#usernameString

The username Oracle GoldenGate uses to connect to the Java Message Service. This username must already exist and be available by the Java Message Service to be connected to.

Returns:

  • (String)


77
78
79
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 77

def username
  @username
end

Class Method Details

.attribute_mapObject

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



92
93
94
95
96
97
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
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'technology_type': :'technologyType',
    'should_use_jndi': :'shouldUseJndi',
    'jndi_connection_factory': :'jndiConnectionFactory',
    'jndi_provider_url': :'jndiProviderUrl',
    'jndi_initial_context_factory': :'jndiInitialContextFactory',
    'jndi_security_principal': :'jndiSecurityPrincipal',
    'connection_url': :'connectionUrl',
    'connection_factory': :'connectionFactory',
    'security_protocol': :'securityProtocol',
    'authentication_type': :'authenticationType',
    'username': :'username',
    'private_ip': :'privateIp'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'technology_type': :'String',
    'should_use_jndi': :'BOOLEAN',
    'jndi_connection_factory': :'String',
    'jndi_provider_url': :'String',
    'jndi_initial_context_factory': :'String',
    'jndi_security_principal': :'String',
    'connection_url': :'String',
    'connection_factory': :'String',
    'security_protocol': :'String',
    'authentication_type': :'String',
    'username': :'String',
    'private_ip': :'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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 288

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    technology_type == other.technology_type &&
    should_use_jndi == other.should_use_jndi &&
    jndi_connection_factory == other.jndi_connection_factory &&
    jndi_provider_url == other.jndi_provider_url &&
    jndi_initial_context_factory == other.jndi_initial_context_factory &&
    jndi_security_principal == other.jndi_security_principal &&
    connection_url == other.connection_url &&
    connection_factory == other.connection_factory &&
    security_protocol == other.security_protocol &&
    authentication_type == other.authentication_type &&
    username == other.username &&
    private_ip == other.private_ip
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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 347

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


327
328
329
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 327

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



336
337
338
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 336

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, technology_type, should_use_jndi, jndi_connection_factory, jndi_provider_url, jndi_initial_context_factory, jndi_security_principal, connection_url, connection_factory, security_protocol, authentication_type, username, private_ip].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



380
381
382
383
384
385
386
387
388
389
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 380

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



374
375
376
# File 'lib/oci/golden_gate/models/java_message_service_connection_summary.rb', line 374

def to_s
  to_hash.to_s
end