Class: OCI::Cims::IncidentClient
- Inherits:
-
Object
- Object
- OCI::Cims::IncidentClient
- 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, you need to have an Oracle Single Sign On (SSO) account, and you need to register your Customer Support Identifier (CSI) with My Oracle Support.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_incident(create_incident_details, ocid, opts = {}) ⇒ Response
This API enables the customer to Create an Incident.
-
#get_incident(incident_key, csi, ocid, opts = {}) ⇒ Response
This API fetches the details of a requested Incident.
-
#get_status(source, ocid, opts = {}) ⇒ Response
GetStatus of the Service.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IncidentClient
constructor
Creates a new IncidentClient.
-
#list_incident_resource_types(problem_type, compartment_id, csi, ocid, opts = {}) ⇒ Response
This API returns the list of all possible product that OCI supports, while creating an incident.
-
#list_incidents(csi, compartment_id, ocid, opts = {}) ⇒ Response
This API returns the list of incidents raised by the tenant.
-
#logger ⇒ Logger
The logger for this client.
-
#update_incident(incident_key, csi, update_incident_details, ocid, opts = {}) ⇒ Response
This API updates an existing incident.
-
#validate_user(csi, ocid, opts = {}) ⇒ Response
ValidateUser.
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.
53 54 55 56 57 58 59 60 61 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/cims/incident_client.rb', line 53 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) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @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.
13 14 15 |
# File 'lib/oci/cims/incident_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/cims/incident_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/cims/incident_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/cims/incident_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#create_incident(create_incident_details, ocid, opts = {}) ⇒ Response
This API enables the customer to Create an Incident
119 120 121 122 123 124 125 126 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 |
# File 'lib/oci/cims/incident_client.rb', line 119 def create_incident(create_incident_details, ocid, 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? raise "Missing the required parameter 'ocid' when calling create_incident." if ocid.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[:ocid] = ocid header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_incident_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(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, csi, ocid, opts = {}) ⇒ Response
This API fetches the details of a requested Incident
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 |
# File 'lib/oci/cims/incident_client.rb', line 177 def get_incident(incident_key, csi, ocid, 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 'csi' when calling get_incident." if csi.nil? raise "Missing the required parameter 'ocid' when calling get_incident." if ocid.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 = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:csi] = csi header_params[:ocid] = ocid header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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 |
#get_status(source, ocid, opts = {}) ⇒ Response
GetStatus of the Service
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/cims/incident_client.rb', line 235 def get_status(source, ocid, opts = {}) logger.debug 'Calling operation IncidentClient#get_status.' if logger raise "Missing the required parameter 'source' when calling get_status." if source.nil? raise "Missing the required parameter 'ocid' when calling get_status." if ocid.nil? raise "Parameter value for 'source' must not be blank" if OCI::Internal::Util.blank_string?(source) path = '/v2/incidents/status/{source}'.sub('{source}', source.to_s) 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[:ocid] = ocid header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IncidentClient#get_status') 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::Status' ) end # rubocop:enable Metrics/BlockLength end |
#list_incident_resource_types(problem_type, compartment_id, csi, ocid, opts = {}) ⇒ Response
This API returns the list of all possible product that OCI supports, while creating an incident
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 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/oci/cims/incident_client.rb', line 298 def list_incident_resource_types(problem_type, compartment_id, csi, ocid, 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? raise "Missing the required parameter 'csi' when calling list_incident_resource_types." if csi.nil? raise "Missing the required parameter 'ocid' when calling list_incident_resource_types." if ocid.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[:csi] = csi header_params[:ocid] = ocid header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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(csi, compartment_id, ocid, opts = {}) ⇒ Response
This API returns the list of incidents raised by the tenant
377 378 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 |
# File 'lib/oci/cims/incident_client.rb', line 377 def list_incidents(csi, compartment_id, ocid, opts = {}) logger.debug 'Calling operation IncidentClient#list_incidents.' if logger raise "Missing the required parameter 'csi' when calling list_incidents." if csi.nil? raise "Missing the required parameter 'compartment_id' when calling list_incidents." if compartment_id.nil? raise "Missing the required parameter 'ocid' when calling list_incidents." if ocid.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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:csi] = csi header_params[:ocid] = ocid header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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.
101 102 103 |
# File 'lib/oci/cims/incident_client.rb', line 101 def logger @api_client.config.logger end |
#update_incident(incident_key, csi, update_incident_details, ocid, opts = {}) ⇒ Response
This API updates an existing incident
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 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 |
# File 'lib/oci/cims/incident_client.rb', line 456 def update_incident(incident_key, csi, update_incident_details, ocid, 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 'csi' when calling update_incident." if csi.nil? raise "Missing the required parameter 'update_incident_details' when calling update_incident." if update_incident_details.nil? raise "Missing the required parameter 'ocid' when calling update_incident." if ocid.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 = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:csi] = csi header_params[:ocid] = ocid header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_incident_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(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(csi, ocid, opts = {}) ⇒ Response
ValidateUser
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'lib/oci/cims/incident_client.rb', line 520 def validate_user(csi, ocid, opts = {}) logger.debug 'Calling operation IncidentClient#validate_user.' if logger raise "Missing the required parameter 'csi' when calling validate_user." if csi.nil? raise "Missing the required parameter 'ocid' when calling validate_user." if ocid.nil? 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[:csi] = csi header_params[:ocid] = ocid header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(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 |