Package com.oracle.bmc.cloudbridge

Interface OcbAgentSvc

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OcbAgentSvcClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public interface OcbAgentSvc
extends AutoCloseable
    API for Oracle Cloud Bridge service.

    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

      • addAgentDependency

        AddAgentDependencyResponse addAgentDependency​(AddAgentDependencyRequest request)
        Add a dependency to the environment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/AddAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddAgentDependency API.

      • changeAgentCompartment

        ChangeAgentCompartmentResponse changeAgentCompartment​(ChangeAgentCompartmentRequest request)
        Moves an Agent resource from one compartment identifier to another.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ChangeAgentCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeAgentCompartment API.

      • changeAgentDependencyCompartment

        ChangeAgentDependencyCompartmentResponse changeAgentDependencyCompartment​(ChangeAgentDependencyCompartmentRequest request)
        Moves a AgentDependency resource from one compartment identifier to another.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ChangeAgentDependencyCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeAgentDependencyCompartment API.

      • changeEnvironmentCompartment

        ChangeEnvironmentCompartmentResponse changeEnvironmentCompartment​(ChangeEnvironmentCompartmentRequest request)
        Moves a source environment resource from one compartment identifier to another.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ChangeEnvironmentCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeEnvironmentCompartment API.

      • createAgent

        CreateAgentResponse createAgent​(CreateAgentRequest request)
        Creates an Agent.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/CreateAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAgent API.

      • createAgentDependency

        CreateAgentDependencyResponse createAgentDependency​(CreateAgentDependencyRequest request)
        Creates an AgentDependency.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/CreateAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAgentDependency API.

      • createEnvironment

        CreateEnvironmentResponse createEnvironment​(CreateEnvironmentRequest request)
        Creates a source environment.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/CreateEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEnvironment API.

      • deleteAgent

        DeleteAgentResponse deleteAgent​(DeleteAgentRequest request)
        Deletes an Agent resource identified by an identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/DeleteAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAgent API.

      • deleteAgentDependency

        DeleteAgentDependencyResponse deleteAgentDependency​(DeleteAgentDependencyRequest request)
        Deletes the AgentDependency resource based on an identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/DeleteAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAgentDependency API.

      • deleteEnvironment

        DeleteEnvironmentResponse deleteEnvironment​(DeleteEnvironmentRequest request)
        Deletes a the source environment resource identified by an identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/DeleteEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEnvironment API.

      • getAgent

        GetAgentResponse getAgent​(GetAgentRequest request)
        Gets an Agent by identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/GetAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAgent API.

      • getAgentDependency

        GetAgentDependencyResponse getAgentDependency​(GetAgentDependencyRequest request)
        Gets an AgentDependency by identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/GetAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAgentDependency API.

      • getEnvironment

        GetEnvironmentResponse getEnvironment​(GetEnvironmentRequest request)
        Gets a source environment by identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/GetEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEnvironment API.

      • getPlugin

        GetPluginResponse getPlugin​(GetPluginRequest request)
        Gets a plugin by identifier.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/GetPluginExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPlugin API.

      • listAgentDependencies

        ListAgentDependenciesResponse listAgentDependencies​(ListAgentDependenciesRequest request)
        Returns a list of AgentDependencies such as AgentDependencyCollection.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ListAgentDependenciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAgentDependencies API.

      • listAgents

        ListAgentsResponse listAgents​(ListAgentsRequest request)
        Returns a list of Agents.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ListAgentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAgents API.

      • listApplianceImages

        ListApplianceImagesResponse listApplianceImages​(ListApplianceImagesRequest request)
        Returns a list of Appliance Images.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ListApplianceImagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApplianceImages API.

      • listEnvironments

        ListEnvironmentsResponse listEnvironments​(ListEnvironmentsRequest request)
        Returns a list of source environments.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/ListEnvironmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEnvironments API.

      • removeAgentDependency

        RemoveAgentDependencyResponse removeAgentDependency​(RemoveAgentDependencyRequest request)
        Adds a dependency to the source environment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/RemoveAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveAgentDependency API.

      • updateAgent

        UpdateAgentResponse updateAgent​(UpdateAgentRequest request)
        Updates the Agent.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/UpdateAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAgent API.

      • updateAgentDependency

        UpdateAgentDependencyResponse updateAgentDependency​(UpdateAgentDependencyRequest request)
        Updates the AgentDependency.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/UpdateAgentDependencyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAgentDependency API.

      • updateEnvironment

        UpdateEnvironmentResponse updateEnvironment​(UpdateEnvironmentRequest request)
        Updates the source environment.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/UpdateEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEnvironment API.

      • updatePlugin

        UpdatePluginResponse updatePlugin​(UpdatePluginRequest request)
        Updates the plugin.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/latest/cloudbridge/UpdatePluginExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePlugin API.

      • getWaiters

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

      • getPaginators

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