Package com.oracle.bmc.dts

Interface TransferJobAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    TransferJobAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 1.0.017")
public interface TransferJobAsync
extends AutoCloseable
    Data Transfer Service API Specification

    • 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

      • createTransferJob

        Future<CreateTransferJobResponse> createTransferJob​(CreateTransferJobRequest request,
                                                    AsyncHandler<CreateTransferJobRequest,​CreateTransferJobResponse> handler)
        Create a new Transfer Job that corresponds with customer’s logical dataset e.g.

        a DB or a filesystem.

        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.

      • deleteTransferJob

        Future<DeleteTransferJobResponse> deleteTransferJob​(DeleteTransferJobRequest request,
                                                    AsyncHandler<DeleteTransferJobRequest,​DeleteTransferJobResponse> handler)
        deletes a transfer 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.

      • getTransferJob

        Future<GetTransferJobResponse> getTransferJob​(GetTransferJobRequest request,
                                              AsyncHandler<GetTransferJobRequest,​GetTransferJobResponse> handler)
        Describes a transfer job in detail
        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.

      • listTransferJobs

        Future<ListTransferJobsResponse> listTransferJobs​(ListTransferJobsRequest request,
                                                  AsyncHandler<ListTransferJobsRequest,​ListTransferJobsResponse> handler)
        Lists Transfer Jobs in a given 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.

      • updateTransferJob

        Future<UpdateTransferJobResponse> updateTransferJob​(UpdateTransferJobRequest request,
                                                    AsyncHandler<UpdateTransferJobRequest,​UpdateTransferJobResponse> handler)
        Updates a Transfer Job that corresponds with customer’s logical dataset e.g.

        a DB or a filesystem.

        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.