Class: OCI::Sch::Models::PluginSourceDetails

Inherits:
SourceDetails show all
Defined in:
lib/oci/sch/models/plugin_source_details.rb

Overview

Details about a connector plugin used to fetch data from a source. For configuration instructions, see Creating a Connector.

Constant Summary

Constants inherited from SourceDetails

SourceDetails::KIND_ENUM

Instance Attribute Summary collapse

Attributes inherited from SourceDetails

#kind

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SourceDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PluginSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :plugin_name (String) —

    The value to assign to the #plugin_name property

  • :config_map (Object) —

    The value to assign to the #config_map property



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 58

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

  attributes['kind'] = 'plugin'

  super(attributes)

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

  self.plugin_name = attributes[:'pluginName'] if attributes[:'pluginName']

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

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

  self.config_map = attributes[:'configMap'] if attributes[:'configMap']

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

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

Instance Attribute Details

#config_map ⇒ Object

[Required] The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for QueueSource, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using (GetConnectorPlugin) and review its schema value.

Returns:

  • (Object) 


26
27
28
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 26

def config_map
  @config_map
end

#plugin_name ⇒ String

[Required] The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, QueueSource indicates the Queue service. To find names of connector plugins, list the plugin using (ListConnectorPlugin).

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 19

def plugin_name
  @plugin_name
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'plugin_name': :'pluginName',
    'config_map': :'configMap'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'plugin_name': :'String',
    'config_map': :'Object'
    # 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



88
89
90
91
92
93
94
95
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 88

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

  self.class == other.class &&
    kind == other.kind &&
    plugin_name == other.plugin_name &&
    config_map == other.config_map
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 120

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


100
101
102
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 109

def hash
  [kind, plugin_name, config_map].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 153

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



147
148
149
 
# File 'lib/oci/sch/models/plugin_source_details.rb', line 147

def to_s
  to_hash.to_s
end