Package com.oracle.bmc.cims

Interface IncidentAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    IncidentAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181231")
public interface IncidentAsync
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.

    • 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 serice.

      • 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

        Future<CreateIncidentResponse> createIncident​(CreateIncidentRequest request,
                                              AsyncHandler<CreateIncidentRequest,​CreateIncidentResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getIncident

        Future<GetIncidentResponse> getIncident​(GetIncidentRequest request,
                                        AsyncHandler<GetIncidentRequest,​GetIncidentResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listIncidents

        Future<ListIncidentsResponse> listIncidents​(ListIncidentsRequest request,
                                            AsyncHandler<ListIncidentsRequest,​ListIncidentsResponse> handler)
        Lists support tickets for the specified tenancy.

        For more information, see Listing Support Requests.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateIncident

        Future<UpdateIncidentResponse> updateIncident​(UpdateIncidentRequest request,
                                              AsyncHandler<UpdateIncidentRequest,​UpdateIncidentResponse> handler)
        Updates the specified support ticket.

        For more information, see Updating Support Requests.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • validateUser

        Future<ValidateUserResponse> validateUser​(ValidateUserRequest request,
                                          AsyncHandler<ValidateUserRequest,​ValidateUserResponse> handler)
        Checks whether the requested user is valid.

        For more information, see Validating a User.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.