Class: OCI::Cims::Models::ContextualData

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cims/models/contextual_data.rb

Overview

Information collected from user context during ticket creation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContextualData

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :client_id (String) —

    The value to assign to the #client_id property

  • :schema_name (String) —

    The value to assign to the #schema_name property

  • :schema_version (String) —

    The value to assign to the #schema_version property

  • :payload (String) —

    The value to assign to the #payload 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
86
87
 
# File 'lib/oci/cims/models/contextual_data.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.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.schema_name = attributes[:'schemaName'] if attributes[:'schemaName']

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

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

  self.schema_version = attributes[:'schemaVersion'] if attributes[:'schemaVersion']

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

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

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

Instance Attribute Details

#client_id ⇒ String

[Required] The unique identifier for the client.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/cims/models/contextual_data.rb', line 14

def client_id
  @client_id
end

#payload ⇒ String

[Required] The payload for the contextual data.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/cims/models/contextual_data.rb', line 26

def payload
  @payload
end

#schema_name ⇒ String

[Required] The name assigned to the schema.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/cims/models/contextual_data.rb', line 18

def schema_name
  @schema_name
end

#schema_version ⇒ String

[Required] The version of the schema.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/cims/models/contextual_data.rb', line 22

def schema_version
  @schema_version
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
38
 
# File 'lib/oci/cims/models/contextual_data.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'client_id': :'clientId',
    'schema_name': :'schemaName',
    'schema_version': :'schemaVersion',
    'payload': :'payload'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/cims/models/contextual_data.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'client_id': :'String',
    'schema_name': :'String',
    'schema_version': :'String',
    'payload': :'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



96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/cims/models/contextual_data.rb', line 96

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

  self.class == other.class &&
    client_id == other.client_id &&
    schema_name == other.schema_name &&
    schema_version == other.schema_version &&
    payload == other.payload
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



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

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


109
110
111
 
# File 'lib/oci/cims/models/contextual_data.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/cims/models/contextual_data.rb', line 118

def hash
  [client_id, schema_name, schema_version, payload].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/cims/models/contextual_data.rb', line 162

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



156
157
158
 
# File 'lib/oci/cims/models/contextual_data.rb', line 156

def to_s
  to_hash.to_s
end