Class: OCI::Cims::IncidentClient

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

Overview

Use the Support Management API to manage support requests. For more information, see Getting Help and Contacting Support. Note: Before you can create service requests with this API, complete user registration at My Oracle Cloud Support and then ask your tenancy administrator to provide you authorization for the related user groups.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IncidentClient

Creates a new IncidentClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/cims/incident_client.rb', line 59

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20181231'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "IncidentClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



19
20
21
 
# File 'lib/oci/cims/incident_client.rb', line 19

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


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

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


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

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



29
30
31
 
# File 'lib/oci/cims/incident_client.rb', line 29

def retry_config
  @retry_config
end

Instance Method Details

#create_incident(create_incident_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_incident API.

Creates a support request in the specified tenancy. For more information, see Creating Support Requests.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/cims/incident_client.rb', line 127

def create_incident(create_incident_details, opts = {})
  logger.debug 'Calling operation IncidentClient#create_incident.' if logger

  raise "Missing the required parameter 'create_incident_details' when calling create_incident." if create_incident_details.nil?

  path = '/v2/incidents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(create_incident_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#create_incident') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Cims::Models::Incident'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_incident(incident_key, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_incident API.

Gets the specified support request. For more information, see Getting Details for a Support Request.

Parameters:

  • incident_key (String) —

    Unique identifier for the support request.

  • compartment_id (String) —

    The OCID of the tenancy.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :problemtype (String) —

    The kind of support request.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/cims/incident_client.rb', line 200

def get_incident(incident_key, compartment_id, opts = {})
  logger.debug 'Calling operation IncidentClient#get_incident.' if logger

  raise "Missing the required parameter 'incident_key' when calling get_incident." if incident_key.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_incident." if compartment_id.nil?
  raise "Parameter value for 'incident_key' must not be blank" if OCI::Internal::Util.blank_string?(incident_key)

  path = '/v2/incidents/{incidentKey}'.sub('{incidentKey}', incident_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:problemtype] = opts[:problemtype] if opts[:problemtype]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#get_incident') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Cims::Models::Incident'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_incident_resource_types(problem_type, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_incident_resource_types API.

Depending on the selected productType, either lists available products (service groups, services, service categories, and subcategories) for technical support requests or lists limits and current usage for limit increase tickets. This operation is called during creation of technical support and limit increase tickets. For more information about listing products, see Listing Products for Support Requests. For more information about listing limits, see Listing Limits for Service Limit Increase Requests.

Parameters:

  • problem_type (String) —

    The kind of support request.

  • compartment_id (String) —

    The OCID of the tenancy.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 50)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination. (default to 1)

  • :sort_by (String) —

    The key to use to sort the returned items. (default to dateUpdated)

  • :sort_order (String) —

    The order to sort the results in. (default to ASC)

  • :name (String) —

    The user-friendly name of the support request type. (default to limit)

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/cims/incident_client.rb', line 286

def list_incident_resource_types(problem_type, compartment_id, opts = {})
  logger.debug 'Calling operation IncidentClient#list_incident_resource_types.' if logger

  raise "Missing the required parameter 'problem_type' when calling list_incident_resource_types." if problem_type.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_incident_resource_types." if compartment_id.nil?

  if opts[:sort_by] && !OCI::Cims::Models::SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::Cims::Models::SORT_BY_ENUM.'
  end

  if opts[:sort_order] && !OCI::Cims::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Cims::Models::SORT_ORDER_ENUM.'
  end

  path = '/v2/incidents/incidentResourceTypes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:problemType] = problem_type
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:name] = opts[:name] if opts[:name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#list_incident_resource_types') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Cims::Models::IncidentResourceType>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_incidents(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_incidents API.

Lists support requests for the specified tenancy. For more information, see Listing Support Requests.

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 50)

  • :sort_by (String) —

    The key to use to sort the returned items. (default to dateUpdated)

  • :sort_order (String) —

    The order to sort the results in. (default to ASC)

  • :time_updated_greater_than_or_equal_to (DateTime) —

    Filter to return results updated only after the specified timestamp. Must be an RFC 3339 timestamp (e.g. 2025-12-07T17:42:54Z).

  • :lifecycle_state (String) —

    The current state of the ticket. (default to ACTIVE)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination. (default to 1)

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :problem_type (String) —

    The kind of support request.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/oci/cims/incident_client.rb', line 379

def list_incidents(compartment_id, opts = {})
  logger.debug 'Calling operation IncidentClient#list_incidents.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_incidents." if compartment_id.nil?

  if opts[:sort_by] && !OCI::Cims::Models::SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::Cims::Models::SORT_BY_ENUM.'
  end

  if opts[:sort_order] && !OCI::Cims::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Cims::Models::SORT_ORDER_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Cims::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Cims::Models::LIFECYCLE_STATE_ENUM.'
  end

  path = '/v2/incidents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:problemType] = opts[:problem_type] if opts[:problem_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#list_incidents') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Cims::Models::IncidentSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



98
99
100
 
# File 'lib/oci/cims/incident_client.rb', line 98

def logger
  @api_client.config.logger
end

#put_attachment(put_attachment_details, incident_key, attachment_name, compartment_id, is_restricted_flag, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_attachment API.

Uploads the file and attaches it to the support request.

Parameters:

  • put_attachment_details (String, IO) —

    File to be uploaded as attachment to the Service Request.

  • incident_key (String) —

    Unique identifier for the support request.

  • attachment_name (String) —

    The name of the file to attach to the support request. Avoid entering confidential information.

  • compartment_id (String) —

    The OCID of the tenancy.

  • is_restricted_flag (BOOLEAN) —

    Set to true when the attachment contains personal information (PI) or protected health information (PHI).

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :homeregion (String) —

    The region of the tenancy.

  • :problemtype (String) —

    The kind of support request.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/oci/cims/incident_client.rb', line 476

def put_attachment(put_attachment_details, incident_key, attachment_name, compartment_id, is_restricted_flag, opts = {})
  logger.debug 'Calling operation IncidentClient#put_attachment.' if logger

  raise "Missing the required parameter 'put_attachment_details' when calling put_attachment." if put_attachment_details.nil?
  raise "Missing the required parameter 'incident_key' when calling put_attachment." if incident_key.nil?
  raise "Missing the required parameter 'attachment_name' when calling put_attachment." if attachment_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling put_attachment." if compartment_id.nil?
  raise "Missing the required parameter 'is_restricted_flag' when calling put_attachment." if is_restricted_flag.nil?
  raise "Parameter value for 'incident_key' must not be blank" if OCI::Internal::Util.blank_string?(incident_key)

  path = '/v2/incidents/{incidentKey}/attachment'.sub('{incidentKey}', incident_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attachmentName] = attachment_name
  query_params[:compartmentId] = compartment_id
  query_params[:isRestrictedFlag] = is_restricted_flag

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:problemtype] = opts[:problemtype] if opts[:problemtype]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'

  post_body = @api_client.object_to_http_body(put_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#put_attachment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Cims::Models::Incident'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_incident(incident_key, update_incident_details, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_incident API.

Updates the specified support request. For more information, see Updating Support Requests.

Parameters:

  • incident_key (String) —

    Unique identifier for the support request.

  • update_incident_details (OCI::Cims::Models::UpdateIncident) —

    Details about the support request being updated.

  • compartment_id (String) —

    The OCID of the tenancy.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/oci/cims/incident_client.rb', line 560

def update_incident(incident_key, update_incident_details, compartment_id, opts = {})
  logger.debug 'Calling operation IncidentClient#update_incident.' if logger

  raise "Missing the required parameter 'incident_key' when calling update_incident." if incident_key.nil?
  raise "Missing the required parameter 'update_incident_details' when calling update_incident." if update_incident_details.nil?
  raise "Missing the required parameter 'compartment_id' when calling update_incident." if compartment_id.nil?
  raise "Parameter value for 'incident_key' must not be blank" if OCI::Internal::Util.blank_string?(incident_key)

  path = '/v2/incidents/{incidentKey}'.sub('{incidentKey}', incident_key.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_incident_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#update_incident') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Cims::Models::Incident'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_user(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_user API.

Checks whether the requested user is valid. For more information, see Validating a User.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :problem_type (String) —

    The kind of support request.

  • :ocid (String) —

    User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account. User OCID is mandatory for OCI Users and optional for Multicloud users.

  • :homeregion (String) —

    The region of the tenancy.

  • :bearertokentype (String) —

    Token type that determine which cloud provider the request come from.

  • :bearertoken (String) —

    Token that provided by multi cloud provider, which help to validate the email.

  • :idtoken (String) —

    IdToken that provided by multi cloud provider, which help to validate the email.

  • :domainid (String) —

    The OCID of identity domain. DomainID is mandatory if the user is part of Non Default Identity domain.

Returns:



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/oci/cims/incident_client.rb', line 636

def validate_user(opts = {})
  logger.debug 'Calling operation IncidentClient#validate_user.' if logger


  if opts[:problem_type] && !OCI::Cims::Models::PROBLEM_TYPE_ENUM.include?(opts[:problem_type])
    raise 'Invalid value for "problem_type", must be one of the values in OCI::Cims::Models::PROBLEM_TYPE_ENUM.'
  end

  path = '/v2/incidents/user/validate'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:problemType] = opts[:problem_type] if opts[:problem_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:ocid] = opts[:ocid] if opts[:ocid]
  header_params[:homeregion] = opts[:homeregion] if opts[:homeregion]
  header_params[:bearertokentype] = opts[:bearertokentype] if opts[:bearertokentype]
  header_params[:bearertoken] = opts[:bearertoken] if opts[:bearertoken]
  header_params[:idtoken] = opts[:idtoken] if opts[:idtoken]
  header_params[:domainid] = opts[:domainid] if opts[:domainid]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IncidentClient#validate_user') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Cims::Models::ValidationResponse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end