Class: OCI::Sch::Models::SourceConnectorPlugin

Inherits:
ConnectorPlugin show all
Defined in:
lib/oci/sch/models/source_connector_plugin.rb

Overview

A connector plugin for fetching data from a source service. For configuration instructions, see Creating a Connector.

Constant Summary

Constants inherited from ConnectorPlugin

ConnectorPlugin::ESTIMATED_THROUGHPUT_ENUM, ConnectorPlugin::KIND_ENUM, ConnectorPlugin::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConnectorPlugin

#display_name, #estimated_throughput, #kind, #lifecycle_state, #name, #schema, #time_created

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConnectorPlugin

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SourceConnectorPlugin

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :estimated_throughput (String) —

    The value to assign to the #estimated_throughput proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :schema (String) —

    The value to assign to the #schema proprety

  • :max_retention (String) —

    The value to assign to the #max_retention property



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

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

  attributes['kind'] = 'SOURCE'

  super(attributes)

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

  self.max_retention = attributes[:'maxRetention'] if attributes[:'maxRetention']

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

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

Instance Attribute Details

#max_retention ⇒ String

The estimated maximum period of time the data will be kept at the source. The duration is specified as a string in ISO 8601 format (P1D for one day or P30D for thrity days).

Returns:

  • (String) 


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

def max_retention
  @max_retention
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'name': :'name',
    'time_created': :'timeCreated',
    'estimated_throughput': :'estimatedThroughput',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'schema': :'schema',
    'max_retention': :'maxRetention'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'name': :'String',
    'time_created': :'DateTime',
    'estimated_throughput': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'schema': :'String',
    'max_retention': :'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



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 90

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

  self.class == other.class &&
    kind == other.kind &&
    name == other.name &&
    time_created == other.time_created &&
    estimated_throughput == other.estimated_throughput &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    schema == other.schema &&
    max_retention == other.max_retention
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 127

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


107
108
109
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 116

def hash
  [kind, name, time_created, estimated_throughput, lifecycle_state, display_name, schema, max_retention].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 160

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



154
155
156
 
# File 'lib/oci/sch/models/source_connector_plugin.rb', line 154

def to_s
  to_hash.to_s
end