Package com.oracle.bmc.resourcemanager

Interface ResourceManagerAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ResourceManagerAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180917")
public interface ResourceManagerAsync
extends AutoCloseable
    Use the Resource Manager API to automate deployment and operations for all Oracle Cloud Infrastructure resources.

    Using the infrastructure-as-code (IaC) model, the service is based on Terraform, an open source industry standard that lets DevOps engineers develop and deploy their infrastructure anywhere. For more information, see the Resource Manager documentation.

    • 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

      • cancelJob

        Future<CancelJobResponse> cancelJob​(CancelJobRequest request,
                                    AsyncHandler<CancelJobRequest,​CancelJobResponse> handler)
        Indicates the intention to cancel the specified job.

        Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting isForced to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources. For more information, see Canceling a Job.

        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.

      • changeStackCompartment

        Future<ChangeStackCompartmentResponse> changeStackCompartment​(ChangeStackCompartmentRequest request,
                                                              AsyncHandler<ChangeStackCompartmentRequest,​ChangeStackCompartmentResponse> handler)
        Moves a stack (and its associated jobs) into a different compartment within the same tenancy.

        For more information, see Moving a Stack.

        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.

      • createJob

        Future<CreateJobResponse> createJob​(CreateJobRequest request,
                                    AsyncHandler<CreateJobRequest,​CreateJobResponse> handler)
        Creates a job.

        For more information, see Creating a Job.

        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.

      • createStack

        Future<CreateStackResponse> createStack​(CreateStackRequest request,
                                        AsyncHandler<CreateStackRequest,​CreateStackResponse> handler)
        Creates a stack in the specified compartment.

        You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see Creating a Stack.

        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.

      • createTemplate

        Future<CreateTemplateResponse> createTemplate​(CreateTemplateRequest request,
                                              AsyncHandler<CreateTemplateRequest,​CreateTemplateResponse> handler)
        Creates a private template in the specified compartment.

        For more information, see Creating a Private Template.

        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.

      • deleteStack

        Future<DeleteStackResponse> deleteStack​(DeleteStackRequest request,
                                        AsyncHandler<DeleteStackRequest,​DeleteStackResponse> handler)
        Deletes the specified stack.

        For more information, see Deleting a Stack.

        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.

      • deleteTemplate

        Future<DeleteTemplateResponse> deleteTemplate​(DeleteTemplateRequest request,
                                              AsyncHandler<DeleteTemplateRequest,​DeleteTemplateResponse> handler)
        Deletes the specified template.

        For more information, see Deleting a Private Template.

        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.

      • detectStackDrift

        Future<DetectStackDriftResponse> detectStackDrift​(DetectStackDriftRequest request,
                                                  AsyncHandler<DetectStackDriftRequest,​DetectStackDriftResponse> handler)
        Checks drift status for the specified stack.

        For more information, see Detecting Drift.

        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.

      • getJob

        Future<GetJobResponse> getJob​(GetJobRequest request,
                              AsyncHandler<GetJobRequest,​GetJobResponse> handler)
        Gets the properties of the specified job.

        For more information, see Getting a Job’s Details.

        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.

      • getJobLogs

        Future<GetJobLogsResponse> getJobLogs​(GetJobLogsRequest request,
                                      AsyncHandler<GetJobLogsRequest,​GetJobLogsResponse> handler)
        Returns console log entries for the specified job in JSON format.

        For more information, see Getting Logs for a Job.

        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.

      • getJobLogsContent

        Future<GetJobLogsContentResponse> getJobLogsContent​(GetJobLogsContentRequest request,
                                                    AsyncHandler<GetJobLogsContentRequest,​GetJobLogsContentResponse> handler)
        Returns the raw log file for the specified job in text format.

        The file includes a maximum of 100,000 log entries. For more information, see Getting Logs Content for a Job.

        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.

      • getJobTfConfig

        Future<GetJobTfConfigResponse> getJobTfConfig​(GetJobTfConfigRequest request,
                                              AsyncHandler<GetJobTfConfigRequest,​GetJobTfConfigResponse> handler)
        Returns the Terraform configuration for the specified job in zip format.

        If no zip file is found, returns an error. For more information, see Getting a Job Terraform Configuration.

        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.

      • getJobTfPlan

        Future<GetJobTfPlanResponse> getJobTfPlan​(GetJobTfPlanRequest request,
                                          AsyncHandler<GetJobTfPlanRequest,​GetJobTfPlanResponse> handler)
        Returns the output of the specified Terraform plan job in binary or JSON format.

        For more information, see Getting the Terraform Output for a Plan Job.

        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.

      • getJobTfState

        Future<GetJobTfStateResponse> getJobTfState​(GetJobTfStateRequest request,
                                            AsyncHandler<GetJobTfStateRequest,​GetJobTfStateResponse> handler)
        Returns the Terraform state for the specified job.

        For more information, see Getting a Job Terraform Configuration.

        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.

      • getReachableIp

        Future<GetReachableIpResponse> getReachableIp​(GetReachableIpRequest request,
                                              AsyncHandler<GetReachableIpRequest,​GetReachableIpResponse> handler)
        Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint.

        Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint. For more information, see Getting the Reachable IP Address for a Private Endpoint.

        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.

      • getStack

        Future<GetStackResponse> getStack​(GetStackRequest request,
                                  AsyncHandler<GetStackRequest,​GetStackResponse> handler)
        Gets the specified stack.

        For more information, see Getting a Stack’s Details.

        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.

      • getStackTfConfig

        Future<GetStackTfConfigResponse> getStackTfConfig​(GetStackTfConfigRequest request,
                                                  AsyncHandler<GetStackTfConfigRequest,​GetStackTfConfigResponse> handler)
        Returns the Terraform configuration file for the specified stack in zip format.

        Returns an error if no zip file is found. For more information, see Getting a Stack Terraform Configuration.

        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.

      • getStackTfState

        Future<GetStackTfStateResponse> getStackTfState​(GetStackTfStateRequest request,
                                                AsyncHandler<GetStackTfStateRequest,​GetStackTfStateResponse> handler)
        Returns the Terraform state for the specified stack.

        For more information, see Getting a Stack State File.

        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.

      • getTemplate

        Future<GetTemplateResponse> getTemplate​(GetTemplateRequest request,
                                        AsyncHandler<GetTemplateRequest,​GetTemplateResponse> handler)
        Gets the specified template.

        For more information, see Getting a Private Template’s Details.

        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.

      • getTemplateLogo

        Future<GetTemplateLogoResponse> getTemplateLogo​(GetTemplateLogoRequest request,
                                                AsyncHandler<GetTemplateLogoRequest,​GetTemplateLogoResponse> handler)
        Returns the Terraform logo file in .logo format for the specified template.

        Returns an error if no logo file is found. For more information, see Getting a Private Template’s Logo.

        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.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Returns the specified work request.

        For more information, see Getting a Work Request’s Details.

        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.

      • listJobOutputs

        Future<ListJobOutputsResponse> listJobOutputs​(ListJobOutputsRequest request,
                                              AsyncHandler<ListJobOutputsRequest,​ListJobOutputsResponse> handler)
        Gets the list of outputs associated with the specified job.

        For more information, see Listing Job Outputs.

        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.

      • listJobs

        Future<ListJobsResponse> listJobs​(ListJobsRequest request,
                                  AsyncHandler<ListJobsRequest,​ListJobsResponse> handler)
        Lists jobs according to the specified filter.

        By default, the list is ordered by time created. For more information, see Listing Jobs.

        - To list all jobs in a stack, provide the stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To list all jobs in a compartment, provide the compartment [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - To return a specific job, provide the job [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). (Equivalent to getStack.)

        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.

      • listPrivateEndpoints

        Future<ListPrivateEndpointsResponse> listPrivateEndpoints​(ListPrivateEndpointsRequest request,
                                                          AsyncHandler<ListPrivateEndpointsRequest,​ListPrivateEndpointsResponse> handler)
        Lists private endpoints according to the specified filter.

        For more information, see Listing Private Endpoints.

        • For compartmentId, lists all private endpoints in the matching compartment. - For privateEndpointId, lists the matching private endpoint.
        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.

      • listStackResourceDriftDetails

        Future<ListStackResourceDriftDetailsResponse> listStackResourceDriftDetails​(ListStackResourceDriftDetailsRequest request,
                                                                            AsyncHandler<ListStackResourceDriftDetailsRequest,​ListStackResourceDriftDetailsResponse> handler)
        Lists drift status details for each resource defined in the specified stack.

        The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (workRequestId). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack. For more information, see Listing Drift Status.

        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.

      • listStacks

        Future<ListStacksResponse> listStacks​(ListStacksRequest request,
                                      AsyncHandler<ListStacksRequest,​ListStacksResponse> handler)
        Lists stacks according to the specified filter.

        For more information, see Listing Stacks. - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack. (See also getStack.)

        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.

      • listTemplates

        Future<ListTemplatesResponse> listTemplates​(ListTemplatesRequest request,
                                            AsyncHandler<ListTemplatesRequest,​ListTemplatesResponse> handler)
        Lists templates according to the specified filter.

        The attributes compartmentId and templateCategoryId are required unless templateId is specified. For more information, see Listing Templates.

        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.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in the specified compartment or for the specified resource.

        For more information, see Listing Work Requests.

        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.

      • updateJob

        Future<UpdateJobResponse> updateJob​(UpdateJobRequest request,
                                    AsyncHandler<UpdateJobRequest,​UpdateJobResponse> handler)
        Updates the specified job.

        For more information, see Updating a Job.

        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.

      • updateStack

        Future<UpdateStackResponse> updateStack​(UpdateStackRequest request,
                                        AsyncHandler<UpdateStackRequest,​UpdateStackResponse> handler)
        Updates the specified stack.

        Use UpdateStack when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Updating a Stack.

        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.

      • updateTemplate

        Future<UpdateTemplateResponse> updateTemplate​(UpdateTemplateRequest request,
                                              AsyncHandler<UpdateTemplateRequest,​UpdateTemplateResponse> handler)
        Updates the specified template.

        For more information, see Updating a Private Template.

        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.