Package com.oracle.bmc.fleetappsmanagement

Interface FleetAppsManagementRunbooksAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    FleetAppsManagementRunbooksAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public interface FleetAppsManagementRunbooksAsync
extends AutoCloseable
    Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise.

    • 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

      • createRunbook

        Future<CreateRunbookResponse> createRunbook​(CreateRunbookRequest request,
                                            AsyncHandler<CreateRunbookRequest,​CreateRunbookResponse> handler)
        Creates a new Runbook.
        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.

      • createTaskRecord

        Future<CreateTaskRecordResponse> createTaskRecord​(CreateTaskRecordRequest request,
                                                  AsyncHandler<CreateTaskRecordRequest,​CreateTaskRecordResponse> handler)
        Creates a new Task.
        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.

      • deleteRunbook

        Future<DeleteRunbookResponse> deleteRunbook​(DeleteRunbookRequest request,
                                            AsyncHandler<DeleteRunbookRequest,​DeleteRunbookResponse> handler)
        Deletes a Runbook resource by identifier
        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.

      • deleteTaskRecord

        Future<DeleteTaskRecordResponse> deleteTaskRecord​(DeleteTaskRecordRequest request,
                                                  AsyncHandler<DeleteTaskRecordRequest,​DeleteTaskRecordResponse> handler)
        Deletes a Task Record resource by identifier
        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.

      • getRunbook

        Future<GetRunbookResponse> getRunbook​(GetRunbookRequest request,
                                      AsyncHandler<GetRunbookRequest,​GetRunbookResponse> handler)
        Get the details of a runbook in Fleet Application Management.
        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.

      • getTaskRecord

        Future<GetTaskRecordResponse> getTaskRecord​(GetTaskRecordRequest request,
                                            AsyncHandler<GetTaskRecordRequest,​GetTaskRecordResponse> handler)
        Gets a Task by identifier
        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.

      • listRunbooks

        Future<ListRunbooksResponse> listRunbooks​(ListRunbooksRequest request,
                                          AsyncHandler<ListRunbooksRequest,​ListRunbooksResponse> handler)
        List runbooks in Fleet Application Management.
        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.

      • listTaskRecords

        Future<ListTaskRecordsResponse> listTaskRecords​(ListTaskRecordsRequest request,
                                                AsyncHandler<ListTaskRecordsRequest,​ListTaskRecordsResponse> handler)
        Returns a list of TaskRecords.
        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.

      • publishRunbook

        Future<PublishRunbookResponse> publishRunbook​(PublishRunbookRequest request,
                                              AsyncHandler<PublishRunbookRequest,​PublishRunbookResponse> handler)
        Publish a Runbook.
        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.

      • setDefaultRunbook

        Future<SetDefaultRunbookResponse> setDefaultRunbook​(SetDefaultRunbookRequest request,
                                                    AsyncHandler<SetDefaultRunbookRequest,​SetDefaultRunbookResponse> handler)
        Publish a Runbook.
        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.

      • updateRunbook

        Future<UpdateRunbookResponse> updateRunbook​(UpdateRunbookRequest request,
                                            AsyncHandler<UpdateRunbookRequest,​UpdateRunbookResponse> handler)
        Updates the Ronbook
        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.

      • updateTaskRecord

        Future<UpdateTaskRecordResponse> updateTaskRecord​(UpdateTaskRecordRequest request,
                                                  AsyncHandler<UpdateTaskRecordRequest,​UpdateTaskRecordResponse> handler)
        Updates the Task
        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.