Package com.oracle.bmc.cloudbridge

Interface OcbAgentSvcAsync

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

    • 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

      • addAgentDependency

        Future<AddAgentDependencyResponse> addAgentDependency​(AddAgentDependencyRequest request,
                                                      AsyncHandler<AddAgentDependencyRequest,​AddAgentDependencyResponse> handler)
        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
        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.

      • changeAgentCompartment

        Future<ChangeAgentCompartmentResponse> changeAgentCompartment​(ChangeAgentCompartmentRequest request,
                                                              AsyncHandler<ChangeAgentCompartmentRequest,​ChangeAgentCompartmentResponse> handler)
        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
        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.

      • changeEnvironmentCompartment

        Future<ChangeEnvironmentCompartmentResponse> changeEnvironmentCompartment​(ChangeEnvironmentCompartmentRequest request,
                                                                          AsyncHandler<ChangeEnvironmentCompartmentRequest,​ChangeEnvironmentCompartmentResponse> handler)
        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
        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.

      • createAgent

        Future<CreateAgentResponse> createAgent​(CreateAgentRequest request,
                                        AsyncHandler<CreateAgentRequest,​CreateAgentResponse> handler)
        Creates an Agent.
        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.

      • createAgentDependency

        Future<CreateAgentDependencyResponse> createAgentDependency​(CreateAgentDependencyRequest request,
                                                            AsyncHandler<CreateAgentDependencyRequest,​CreateAgentDependencyResponse> handler)
        Creates an AgentDependency.
        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.

      • createEnvironment

        Future<CreateEnvironmentResponse> createEnvironment​(CreateEnvironmentRequest request,
                                                    AsyncHandler<CreateEnvironmentRequest,​CreateEnvironmentResponse> handler)
        Creates a source environment.
        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.

      • deleteAgent

        Future<DeleteAgentResponse> deleteAgent​(DeleteAgentRequest request,
                                        AsyncHandler<DeleteAgentRequest,​DeleteAgentResponse> handler)
        Deletes an Agent resource identified by an 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.

      • deleteAgentDependency

        Future<DeleteAgentDependencyResponse> deleteAgentDependency​(DeleteAgentDependencyRequest request,
                                                            AsyncHandler<DeleteAgentDependencyRequest,​DeleteAgentDependencyResponse> handler)
        Deletes the AgentDependency resource based on an 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.

      • deleteEnvironment

        Future<DeleteEnvironmentResponse> deleteEnvironment​(DeleteEnvironmentRequest request,
                                                    AsyncHandler<DeleteEnvironmentRequest,​DeleteEnvironmentResponse> handler)
        Deletes a the source environment resource identified by an 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.

      • getAgent

        Future<GetAgentResponse> getAgent​(GetAgentRequest request,
                                  AsyncHandler<GetAgentRequest,​GetAgentResponse> handler)
        Gets an Agent 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.

      • getAgentDependency

        Future<GetAgentDependencyResponse> getAgentDependency​(GetAgentDependencyRequest request,
                                                      AsyncHandler<GetAgentDependencyRequest,​GetAgentDependencyResponse> handler)
        Gets an AgentDependency 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.

      • getEnvironment

        Future<GetEnvironmentResponse> getEnvironment​(GetEnvironmentRequest request,
                                              AsyncHandler<GetEnvironmentRequest,​GetEnvironmentResponse> handler)
        Gets a source environment 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.

      • getPlugin

        Future<GetPluginResponse> getPlugin​(GetPluginRequest request,
                                    AsyncHandler<GetPluginRequest,​GetPluginResponse> handler)
        Gets a plugin 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.

      • listAgentDependencies

        Future<ListAgentDependenciesResponse> listAgentDependencies​(ListAgentDependenciesRequest request,
                                                            AsyncHandler<ListAgentDependenciesRequest,​ListAgentDependenciesResponse> handler)
        Returns a list of AgentDependencies such as AgentDependencyCollection.
        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.

      • listAgents

        Future<ListAgentsResponse> listAgents​(ListAgentsRequest request,
                                      AsyncHandler<ListAgentsRequest,​ListAgentsResponse> handler)
        Returns a list of Agents.
        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.

      • listApplianceImages

        Future<ListApplianceImagesResponse> listApplianceImages​(ListApplianceImagesRequest request,
                                                        AsyncHandler<ListApplianceImagesRequest,​ListApplianceImagesResponse> handler)
        Returns a list of Appliance Images.
        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.

      • listEnvironments

        Future<ListEnvironmentsResponse> listEnvironments​(ListEnvironmentsRequest request,
                                                  AsyncHandler<ListEnvironmentsRequest,​ListEnvironmentsResponse> handler)
        Returns a list of source environments.
        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.

      • removeAgentDependency

        Future<RemoveAgentDependencyResponse> removeAgentDependency​(RemoveAgentDependencyRequest request,
                                                            AsyncHandler<RemoveAgentDependencyRequest,​RemoveAgentDependencyResponse> handler)
        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
        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.

      • updateAgent

        Future<UpdateAgentResponse> updateAgent​(UpdateAgentRequest request,
                                        AsyncHandler<UpdateAgentRequest,​UpdateAgentResponse> handler)
        Updates the Agent.
        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.

      • updateAgentDependency

        Future<UpdateAgentDependencyResponse> updateAgentDependency​(UpdateAgentDependencyRequest request,
                                                            AsyncHandler<UpdateAgentDependencyRequest,​UpdateAgentDependencyResponse> handler)
        Updates the AgentDependency.
        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.

      • updateEnvironment

        Future<UpdateEnvironmentResponse> updateEnvironment​(UpdateEnvironmentRequest request,
                                                    AsyncHandler<UpdateEnvironmentRequest,​UpdateEnvironmentResponse> handler)
        Updates the source environment.
        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.

      • updatePlugin

        Future<UpdatePluginResponse> updatePlugin​(UpdatePluginRequest request,
                                          AsyncHandler<UpdatePluginRequest,​UpdatePluginResponse> handler)
        Updates the plugin.
        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.