Class IncidentClient
Service client instance for Incident.
Implements
Inherited Members
Namespace: Oci.CimsService
Assembly: OCI.DotNetSDK.Cims.dll
Syntax
public class IncidentClient : RegionalClientBase, IDisposable
Constructors
IncidentClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public IncidentClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public IncidentPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
IncidentPaginators |
Methods
CreateIncident(CreateIncidentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a support ticket in the specified tenancy. For more information, see Creating Support Requests.
Declaration
public Task<CreateIncidentResponse> CreateIncident(CreateIncidentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIncidentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIncidentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIncident API.
GetIncident(GetIncidentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified support ticket. For more information, see Getting Details for a Support Request.
Declaration
public Task<GetIncidentResponse> GetIncident(GetIncidentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIncidentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIncidentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIncident API.
ListIncidentResourceTypes(ListIncidentResourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Depending on the selected productType
, either
lists available products (service groups, services, service categories, and subcategories) for technical support tickets 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.
Declaration
public Task<ListIncidentResourceTypesResponse> ListIncidentResourceTypes(ListIncidentResourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIncidentResourceTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIncidentResourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIncidentResourceTypes API.
ListIncidents(ListIncidentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists support tickets for the specified tenancy. For more information, see Listing Support Requests.
Declaration
public Task<ListIncidentsResponse> ListIncidents(ListIncidentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIncidentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIncidentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIncidents API.
UpdateIncident(UpdateIncidentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified support ticket. For more information, see Updating Support Requests.
Declaration
public Task<UpdateIncidentResponse> UpdateIncident(UpdateIncidentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIncidentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIncidentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIncident API.
ValidateUser(ValidateUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Checks whether the requested user is valid. For more information, see Validating a User.
Declaration
public Task<ValidateUserResponse> ValidateUser(ValidateUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateUser API.