Class: OCI::Cims::Models::Incident

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

Overview

Details about the support ticket.

Constant Summary collapse

PROBLEM_TYPE_ENUM = 
[
  PROBLEM_TYPE_LIMIT = 'LIMIT'.freeze,
  PROBLEM_TYPE_LEGACY_LIMIT = 'LEGACY_LIMIT'.freeze,
  PROBLEM_TYPE_TECH = 'TECH'.freeze,
  PROBLEM_TYPE_ACCOUNT = 'ACCOUNT'.freeze,
  PROBLEM_TYPE_TAXONOMY = 'TAXONOMY'.freeze,
  PROBLEM_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 = {}) ⇒ Incident

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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
 
# File 'lib/oci/cims/models/incident.rb', line 151

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.contact_list = attributes[:'contactList'] if attributes[:'contactList']

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

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

  self.tenancy_information = attributes[:'tenancyInformation'] if attributes[:'tenancyInformation']

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

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

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

  self.incident_type = attributes[:'incidentType'] if attributes[:'incidentType']

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

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

  self.user_group_id = attributes[:'userGroupId'] if attributes[:'userGroupId']

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

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

  self.user_group_name = attributes[:'userGroupName'] if attributes[:'userGroupName']

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

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

  self.primary_contact_party_id = attributes[:'primaryContactPartyId'] if attributes[:'primaryContactPartyId']

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

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

  self.primary_contact_party_name = attributes[:'primaryContactPartyName'] if attributes[:'primaryContactPartyName']

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

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

  self.is_write_permitted = attributes[:'isWritePermitted'] unless attributes[:'isWritePermitted'].nil?

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

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

  self.warn_message = attributes[:'warnMessage'] if attributes[:'warnMessage']

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

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

  self.problem_type = attributes[:'problemType'] if attributes[:'problemType']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/cims/models/incident.rb', line 27

def compartment_id
  @compartment_id
end

#contact_list ⇒ OCI::Cims::Models::ContactList

Returns:



30
31
32
 
# File 'lib/oci/cims/models/incident.rb', line 30

def contact_list
  @contact_list
end

#incident_type ⇒ OCI::Cims::Models::IncidentType

Returns:



39
40
41
 
# File 'lib/oci/cims/models/incident.rb', line 39

def incident_type
  @incident_type
end

#is_write_permitted ⇒ BOOLEAN

Technical support type (TECH) only: Allows update of the support request in My Oracle Cloud Support portal, when the user has write permission to the support request's user group.

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/cims/models/incident.rb', line 65

def is_write_permitted
  @is_write_permitted
end

#key ⇒ String

[Required] Unique identifier for the support ticket.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/cims/models/incident.rb', line 23

def key
  @key
end

#primary_contact_party_id ⇒ String

Technical support type (TECH) only: The identifier of the support request's primary contact (primaryContactPartyName) in My Oracle Cloud Support portal.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cims/models/incident.rb', line 54

def primary_contact_party_id
  @primary_contact_party_id
end

#primary_contact_party_name ⇒ String

Technical support type (TECH) only: The name of the support request's primary contact in My Oracle Cloud Support portal.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/cims/models/incident.rb', line 59

def primary_contact_party_name
  @primary_contact_party_name
end

#problem_type ⇒ String

The kind of support ticket (type of support request). For information about ACCOUNT support tickets, see Creating a Billing Support Request. For information about LIMIT support tickets, see Creating a Service Limit Increase Request. For information about TECH support tickets, see Creating a Technical Support Request.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/cims/models/incident.rb', line 81

def problem_type
  @problem_type
end

#referrer ⇒ String

The incident referrer. This value is often the URL that the customer used when creating the support ticket.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/cims/models/incident.rb', line 85

def referrer
  @referrer
end

#tenancy_information ⇒ OCI::Cims::Models::TenancyInformation

Returns:



33
34
35
 
# File 'lib/oci/cims/models/incident.rb', line 33

def tenancy_information
  @tenancy_information
end

#ticket ⇒ OCI::Cims::Models::Ticket

Returns:



36
37
38
 
# File 'lib/oci/cims/models/incident.rb', line 36

def ticket
  @ticket
end

#user_group_id ⇒ String

Technical support type (TECH) only: The identifier of the support request's user group in My Oracle Cloud Support portal.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/cims/models/incident.rb', line 44

def user_group_id
  @user_group_id
end

#user_group_name ⇒ String

Technical support type (TECH) only: Name of the support request's user group in My Oracle Cloud Support portal.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/cims/models/incident.rb', line 49

def user_group_name
  @user_group_name
end

#warn_message ⇒ String

Technical support type (TECH) only: Message indicating the user group (userGroupId) that was auto-selected for a new support request. This message appears when no user group was specified in the create request for a new technical support request.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/cims/models/incident.rb', line 70

def warn_message
  @warn_message
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/cims/models/incident.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'compartment_id': :'compartmentId',
    'contact_list': :'contactList',
    'tenancy_information': :'tenancyInformation',
    'ticket': :'ticket',
    'incident_type': :'incidentType',
    'user_group_id': :'userGroupId',
    'user_group_name': :'userGroupName',
    'primary_contact_party_id': :'primaryContactPartyId',
    'primary_contact_party_name': :'primaryContactPartyName',
    'is_write_permitted': :'isWritePermitted',
    'warn_message': :'warnMessage',
    'problem_type': :'problemType',
    'referrer': :'referrer'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/cims/models/incident.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'compartment_id': :'String',
    'contact_list': :'OCI::Cims::Models::ContactList',
    'tenancy_information': :'OCI::Cims::Models::TenancyInformation',
    'ticket': :'OCI::Cims::Models::Ticket',
    'incident_type': :'OCI::Cims::Models::IncidentType',
    'user_group_id': :'String',
    'user_group_name': :'String',
    'primary_contact_party_id': :'String',
    'primary_contact_party_name': :'String',
    'is_write_permitted': :'BOOLEAN',
    'warn_message': :'String',
    'problem_type': :'String',
    'referrer': :'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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/cims/models/incident.rb', line 250

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

  self.class == other.class &&
    key == other.key &&
    compartment_id == other.compartment_id &&
    contact_list == other.contact_list &&
    tenancy_information == other.tenancy_information &&
    ticket == other.ticket &&
    incident_type == other.incident_type &&
    user_group_id == other.user_group_id &&
    user_group_name == other.user_group_name &&
    primary_contact_party_id == other.primary_contact_party_id &&
    primary_contact_party_name == other.primary_contact_party_name &&
    is_write_permitted == other.is_write_permitted &&
    warn_message == other.warn_message &&
    problem_type == other.problem_type &&
    referrer == other.referrer
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/cims/models/incident.rb', line 293

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


273
274
275
 
# File 'lib/oci/cims/models/incident.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/cims/models/incident.rb', line 282

def hash
  [key, compartment_id, contact_list, tenancy_information, ticket, incident_type, user_group_id, user_group_name, primary_contact_party_id, primary_contact_party_name, is_write_permitted, warn_message, problem_type, referrer].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/cims/models/incident.rb', line 326

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



320
321
322
 
# File 'lib/oci/cims/models/incident.rb', line 320

def to_s
  to_hash.to_s
end