com.oracle.bmc.cims

Interface Incident

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

IncidentClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181231")
public interface Incident
extends AutoCloseable

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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CreateIncidentResponse	createIncident(CreateIncidentRequest request) Creates a support ticket in the specified tenancy.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetIncidentResponse	getIncident(GetIncidentRequest request) Gets the specified support ticket.
IncidentPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListIncidentResourceTypesResponse	listIncidentResourceTypes(ListIncidentResourceTypesRequest request) 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.
ListIncidentsResponse	listIncidents(ListIncidentsRequest request) Lists support tickets for the specified tenancy.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateIncidentResponse	updateIncident(UpdateIncidentRequest request) Updates the specified support ticket.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.
ValidateUserResponse	validateUser(ValidateUserRequest request) Checks whether the requested user is valid.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

createIncident

CreateIncidentResponse createIncident(CreateIncidentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateIncident API.

getIncident

GetIncidentResponse getIncident(GetIncidentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetIncident API.

listIncidentResourceTypes

ListIncidentResourceTypesResponse listIncidentResourceTypes(ListIncidentResourceTypesRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListIncidentResourceTypes API.

listIncidents

ListIncidentsResponse listIncidents(ListIncidentsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListIncidents API.

updateIncident

UpdateIncidentResponse updateIncident(UpdateIncidentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateIncident API.

validateUser

ValidateUserResponse validateUser(ValidateUserRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ValidateUser API.

getPaginators

IncidentPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.