Package com.oracle.bmc.computeinstanceagent

Interface ComputeInstanceAgentAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ComputeInstanceAgentAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180530")
public interface ComputeInstanceAgentAsync
extends AutoCloseable
    API for the Oracle Cloud Agent software running on compute instances.

    Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.

    • 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

      • cancelInstanceAgentCommand

        Future<CancelInstanceAgentCommandResponse> cancelInstanceAgentCommand​(CancelInstanceAgentCommandRequest request,
                                                                      AsyncHandler<CancelInstanceAgentCommandRequest,​CancelInstanceAgentCommandResponse> handler)
        Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.

        Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.

        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.

      • createInstanceAgentCommand

        Future<CreateInstanceAgentCommandResponse> createInstanceAgentCommand​(CreateInstanceAgentCommandRequest request,
                                                                      AsyncHandler<CreateInstanceAgentCommandRequest,​CreateInstanceAgentCommandResponse> handler)
        Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.

        On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell.

        Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.

        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.

      • getInstanceAgentCommand

        Future<GetInstanceAgentCommandResponse> getInstanceAgentCommand​(GetInstanceAgentCommandRequest request,
                                                                AsyncHandler<GetInstanceAgentCommandRequest,​GetInstanceAgentCommandResponse> handler)
        Gets information about an Oracle Cloud Agent command.
        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.