Package com.oracle.bmc.computeinstanceagent

Interface ComputeInstanceAgent

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

    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 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

      • cancelInstanceAgentCommand

        CancelInstanceAgentCommandResponse cancelInstanceAgentCommand​(CancelInstanceAgentCommandRequest request)
        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
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/CancelInstanceAgentCommandExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelInstanceAgentCommand API.

      • createInstanceAgentCommand

        CreateInstanceAgentCommandResponse createInstanceAgentCommand​(CreateInstanceAgentCommandRequest request)
        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
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/CreateInstanceAgentCommandExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInstanceAgentCommand API.

      • getInstanceAgentCommand

        GetInstanceAgentCommandResponse getInstanceAgentCommand​(GetInstanceAgentCommandRequest request)
        Gets information about an Oracle Cloud Agent command.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/GetInstanceAgentCommandExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstanceAgentCommand API.

      • getInstanceAgentCommandExecution

        GetInstanceAgentCommandExecutionResponse getInstanceAgentCommandExecution​(GetInstanceAgentCommandExecutionRequest request)
        Gets information about the status of specified instance agent commandId for the given instanceId.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/GetInstanceAgentCommandExecutionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstanceAgentCommandExecution API.

      • listInstanceAgentCommandExecutions

        ListInstanceAgentCommandExecutionsResponse listInstanceAgentCommandExecutions​(ListInstanceAgentCommandExecutionsRequest request)
        Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/ListInstanceAgentCommandExecutionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstanceAgentCommandExecutions API.

      • listInstanceAgentCommands

        ListInstanceAgentCommandsResponse listInstanceAgentCommands​(ListInstanceAgentCommandsRequest request)
        Lists the Oracle Cloud Agent commands issued in a compartment.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/computeinstanceagent/ListInstanceAgentCommandsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstanceAgentCommands API.

      • getWaiters

        ComputeInstanceAgentWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        ComputeInstanceAgentPaginators 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.