Class: OCI::StackMonitoring::Models::SqlOutParamDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/sql_out_param_details.rb

Overview

Position and SQL Type of PL/SQL OUT parameter

Constant Summary collapse

OUT_PARAM_TYPE_ENUM =
[
  OUT_PARAM_TYPE_SQL_CURSOR = 'SQL_CURSOR'.freeze,
  OUT_PARAM_TYPE_ARRAY = 'ARRAY'.freeze,
  OUT_PARAM_TYPE_NO_OUT_PARAM = 'NO_OUT_PARAM'.freeze,
  OUT_PARAM_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SqlOutParamDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :out_param_position (Integer)

    The value to assign to the #out_param_position property

  • :out_param_type (String)

    The value to assign to the #out_param_type property

  • :out_param_name (String)

    The value to assign to the #out_param_name property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 62

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

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

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

  self.out_param_type = attributes[:'outParamType'] if attributes[:'outParamType']

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

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

  self.out_param_name = attributes[:'outParamName'] if attributes[:'outParamName']

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

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

Instance Attribute Details

#out_param_nameString

Name of the Out Parameter

Returns:

  • (String)


29
30
31
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 29

def out_param_name
  @out_param_name
end

#out_param_positionInteger

[Required] Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.

Returns:

  • (Integer)


21
22
23
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 21

def out_param_position
  @out_param_position
end

#out_param_typeString

[Required] SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.

Returns:

  • (String)


25
26
27
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 25

def out_param_type
  @out_param_type
end

Class Method Details

.attribute_mapObject

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



32
33
34
35
36
37
38
39
40
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'out_param_position': :'outParamPosition',
    'out_param_type': :'outParamType',
    'out_param_name': :'outParamName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



43
44
45
46
47
48
49
50
51
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'out_param_position': :'Integer',
    'out_param_type': :'String',
    'out_param_name': :'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



107
108
109
110
111
112
113
114
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 107

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

  self.class == other.class &&
    out_param_position == other.out_param_position &&
    out_param_type == other.out_param_type &&
    out_param_name == other.out_param_name
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 139

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


119
120
121
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 119

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



128
129
130
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 128

def hash
  [out_param_position, out_param_type, out_param_name].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 172

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



166
167
168
# File 'lib/oci/stack_monitoring/models/sql_out_param_details.rb', line 166

def to_s
  to_hash.to_s
end