Interface BaseinfraAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    BaseinfraAsyncClient

    @Generated(value="OracleSDKGenerator",
               comments="API Version: 20251101")
    public interface BaseinfraAsync
    extends AutoCloseable
    API for Database Infrastructure Cloud@Customer Service.

    Use this API to manage Database Infrastructure VM clusters, Application VMs, and related resources.

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

        Future<ActivateInfrastructureResponse> activateInfrastructure​(ActivateInfrastructureRequest request,
                                                                      AsyncHandler<ActivateInfrastructureRequest,​ActivateInfrastructureResponse> handler)
        Activate an Database Infrastructure using the specified 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.
      • createInfrastructure

        Future<CreateInfrastructureResponse> createInfrastructure​(CreateInfrastructureRequest request,
                                                                  AsyncHandler<CreateInfrastructureRequest,​CreateInfrastructureResponse> handler)
        Create a Database Infrastructure using the specified 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.
      • createVmClusterNetwork

        Future<CreateVmClusterNetworkResponse> createVmClusterNetwork​(CreateVmClusterNetworkRequest request,
                                                                      AsyncHandler<CreateVmClusterNetworkRequest,​CreateVmClusterNetworkResponse> handler)
        Create an VM cluster on Database Infrastructure network using the specified 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.
      • createVmInstance

        Future<CreateVmInstanceResponse> createVmInstance​(CreateVmInstanceRequest request,
                                                          AsyncHandler<CreateVmInstanceRequest,​CreateVmInstanceResponse> handler)
        Create an VM instance on Database Infrastructure using the specified 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.
      • deleteInfrastructure

        Future<DeleteInfrastructureResponse> deleteInfrastructure​(DeleteInfrastructureRequest request,
                                                                  AsyncHandler<DeleteInfrastructureRequest,​DeleteInfrastructureResponse> handler)
        Delete the Database Infrastructure that has the specified OCID.

        It must be called once the resource usage is complete.

        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.
      • deleteVmClusterNetwork

        Future<DeleteVmClusterNetworkResponse> deleteVmClusterNetwork​(DeleteVmClusterNetworkRequest request,
                                                                      AsyncHandler<DeleteVmClusterNetworkRequest,​DeleteVmClusterNetworkResponse> handler)
        Delete the VM cluster network on Database Infrastructure that has the specified OCID.

        It must be called once the resource usage is complete.

        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.
      • deleteVmInstance

        Future<DeleteVmInstanceResponse> deleteVmInstance​(DeleteVmInstanceRequest request,
                                                          AsyncHandler<DeleteVmInstanceRequest,​DeleteVmInstanceResponse> handler)
        Delete the VM instance on Database Infrastructure that has the specified OCID.

        It must be called once the resource usage is complete.

        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.
      • getInfrastructure

        Future<GetInfrastructureResponse> getInfrastructure​(GetInfrastructureRequest request,
                                                            AsyncHandler<GetInfrastructureRequest,​GetInfrastructureResponse> handler)
        Obtain the Database Infrastructure that has the specified OCID.
        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.
      • getMaintenanceRun

        Future<GetMaintenanceRunResponse> getMaintenanceRun​(GetMaintenanceRunRequest request,
                                                            AsyncHandler<GetMaintenanceRunRequest,​GetMaintenanceRunResponse> handler)
        Gets information about the specified OCID.
        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.
      • getVmClusterNetwork

        Future<GetVmClusterNetworkResponse> getVmClusterNetwork​(GetVmClusterNetworkRequest request,
                                                                AsyncHandler<GetVmClusterNetworkRequest,​GetVmClusterNetworkResponse> handler)
        Obtain the VM cluster network on Database Infrastructure that has the specified OCID.
        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.
      • getVmInstance

        Future<GetVmInstanceResponse> getVmInstance​(GetVmInstanceRequest request,
                                                    AsyncHandler<GetVmInstanceRequest,​GetVmInstanceResponse> handler)
        Obtain the VM instance on Database Infrastructure that has the specified OCID.
        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)
        Get the status of the work request having the specified work request OCID.
        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.
      • listInfrastructures

        Future<ListInfrastructuresResponse> listInfrastructures​(ListInfrastructuresRequest request,
                                                                AsyncHandler<ListInfrastructuresRequest,​ListInfrastructuresResponse> handler)
        Obtain a list of Database Infrastructures.
        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.
      • listMaintenanceExecutions

        Future<ListMaintenanceExecutionsResponse> listMaintenanceExecutions​(ListMaintenanceExecutionsRequest request,
                                                                            AsyncHandler<ListMaintenanceExecutionsRequest,​ListMaintenanceExecutionsResponse> handler)
        Gets a list of the maintenance executions in the specified compartment.
        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.
      • listMaintenanceRuns

        Future<ListMaintenanceRunsResponse> listMaintenanceRuns​(ListMaintenanceRunsRequest request,
                                                                AsyncHandler<ListMaintenanceRunsRequest,​ListMaintenanceRunsResponse> handler)
        Gets a list of the maintenance runs in the specified compartment.
        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.
      • listVmClusterNetworks

        Future<ListVmClusterNetworksResponse> listVmClusterNetworks​(ListVmClusterNetworksRequest request,
                                                                    AsyncHandler<ListVmClusterNetworksRequest,​ListVmClusterNetworksResponse> handler)
        Obtain a list of VM cluster networks on Database Infrastructure.
        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.
      • listVmInstances

        Future<ListVmInstancesResponse> listVmInstances​(ListVmInstancesRequest request,
                                                        AsyncHandler<ListVmInstancesRequest,​ListVmInstancesResponse> handler)
        Obtain a list of VM instances.
        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.
      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                                    AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        View the list of errors for the work request that have the specified work request OCID.
        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.
      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                                AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        View the log entries for the work request that have the specified work request OCID.
        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)
        View a list of work request details in the specified compartment.
        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.
      • migrateVmInstance

        Future<MigrateVmInstanceResponse> migrateVmInstance​(MigrateVmInstanceRequest request,
                                                            AsyncHandler<MigrateVmInstanceRequest,​MigrateVmInstanceResponse> handler)
        Migrate the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • rescheduleMaintenanceRun

        Future<RescheduleMaintenanceRunResponse> rescheduleMaintenanceRun​(RescheduleMaintenanceRunRequest request,
                                                                          AsyncHandler<RescheduleMaintenanceRunRequest,​RescheduleMaintenanceRunResponse> handler)
        Reschedules the specified maintenance run by providing a new timeScheduled value.

        Only maintenance runs in eligible states may be rescheduled.

        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.
      • restartVmInstance

        Future<RestartVmInstanceResponse> restartVmInstance​(RestartVmInstanceRequest request,
                                                            AsyncHandler<RestartVmInstanceRequest,​RestartVmInstanceResponse> handler)
        Restart the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • scaleVmInstance

        Future<ScaleVmInstanceResponse> scaleVmInstance​(ScaleVmInstanceRequest request,
                                                        AsyncHandler<ScaleVmInstanceRequest,​ScaleVmInstanceResponse> handler)
        Scale the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • startVmInstance

        Future<StartVmInstanceResponse> startVmInstance​(StartVmInstanceRequest request,
                                                        AsyncHandler<StartVmInstanceRequest,​StartVmInstanceResponse> handler)
        Start the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • stopVmInstance

        Future<StopVmInstanceResponse> stopVmInstance​(StopVmInstanceRequest request,
                                                      AsyncHandler<StopVmInstanceRequest,​StopVmInstanceResponse> handler)
        Stop the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • updateInfrastructure

        Future<UpdateInfrastructureResponse> updateInfrastructure​(UpdateInfrastructureRequest request,
                                                                  AsyncHandler<UpdateInfrastructureRequest,​UpdateInfrastructureResponse> handler)
        Update the Database Infrastructure that has the specified OCID.
        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.
      • updateMaintenanceRun

        Future<UpdateMaintenanceRunResponse> updateMaintenanceRun​(UpdateMaintenanceRunRequest request,
                                                                  AsyncHandler<UpdateMaintenanceRunRequest,​UpdateMaintenanceRunResponse> handler)
        Update maintenance run attributes.
        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.
      • updateVmClusterNetwork

        Future<UpdateVmClusterNetworkResponse> updateVmClusterNetwork​(UpdateVmClusterNetworkRequest request,
                                                                      AsyncHandler<UpdateVmClusterNetworkRequest,​UpdateVmClusterNetworkResponse> handler)
        Update the VM cluster network on Database Infrastructure that has the specified OCID.
        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.
      • updateVmInstance

        Future<UpdateVmInstanceResponse> updateVmInstance​(UpdateVmInstanceRequest request,
                                                          AsyncHandler<UpdateVmInstanceRequest,​UpdateVmInstanceResponse> handler)
        Update the VM instance on Database Infrastructure that has the specified OCID.
        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.
      • validateInfrastructure

        Future<ValidateInfrastructureResponse> validateInfrastructure​(ValidateInfrastructureRequest request,
                                                                      AsyncHandler<ValidateInfrastructureRequest,​ValidateInfrastructureResponse> handler)
        Validate an Database Infrastructure using the specified 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.
      • validateVmClusterNetwork

        Future<ValidateVmClusterNetworkResponse> validateVmClusterNetwork​(ValidateVmClusterNetworkRequest request,
                                                                          AsyncHandler<ValidateVmClusterNetworkRequest,​ValidateVmClusterNetworkResponse> handler)
        Validates an VM cluster network on Database Infrastructure.
        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.