Package org.apache.cassandra.spark.bulkwriter.cloudstorage

Interface CloudStorageDataTransferApi

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void abortRestoreJob()  
      void createRestoreJob​(o.a.c.sidecar.client.shaded.common.request.data.CreateRestoreJobRequestPayload createRestoreJobRequestPayload)  
      java.util.concurrent.CompletableFuture<java.lang.Void> createRestoreSliceFromDriver​(o.a.c.sidecar.client.shaded.client.SidecarInstance sidecarInstance, o.a.c.sidecar.client.shaded.common.request.data.CreateSliceRequestPayload createSliceRequestPayload)
      Called from driver level to create a restore slice asynchronously.
      void createRestoreSliceFromExecutor​(o.a.c.sidecar.client.shaded.client.SidecarInstance sidecarInstance, o.a.c.sidecar.client.shaded.common.request.data.CreateSliceRequestPayload createSliceRequestPayload)
      Called from task level to create a restore slice.
      default void handleInterruption​(java.lang.Exception cause)  
      o.a.c.sidecar.client.shaded.common.response.data.RestoreJobSummaryResponsePayload restoreJobSummary()  
      void updateRestoreJob​(o.a.c.sidecar.client.shaded.common.request.data.UpdateRestoreJobRequestPayload updateRestoreJobRequestPayload)  
      BundleStorageObject uploadBundle​(StorageCredentials writeCredentials, Bundle bundle)  

    • Method Detail

      • uploadBundle

        BundleStorageObject uploadBundle​(StorageCredentials writeCredentials,
                                 Bundle bundle)
                          throws org.apache.cassandra.spark.exception.S3ApiCallException
        Throws:
        org.apache.cassandra.spark.exception.S3ApiCallException

      • createRestoreJob

        void createRestoreJob​(o.a.c.sidecar.client.shaded.common.request.data.CreateRestoreJobRequestPayload createRestoreJobRequestPayload)
               throws org.apache.cassandra.spark.exception.SidecarApiCallException
        Throws:
        org.apache.cassandra.spark.exception.SidecarApiCallException

      • restoreJobSummary

        o.a.c.sidecar.client.shaded.common.response.data.RestoreJobSummaryResponsePayload restoreJobSummary()
                                                                                             throws org.apache.cassandra.spark.exception.SidecarApiCallException
        Throws:
        org.apache.cassandra.spark.exception.SidecarApiCallException

      • createRestoreSliceFromExecutor

        void createRestoreSliceFromExecutor​(o.a.c.sidecar.client.shaded.client.SidecarInstance sidecarInstance,
                                    o.a.c.sidecar.client.shaded.common.request.data.CreateSliceRequestPayload createSliceRequestPayload)
                             throws org.apache.cassandra.spark.exception.SidecarApiCallException
        Called from task level to create a restore slice. The request retries until the slice is created (201) or retry has exhausted.
        Parameters:
        sidecarInstance - the sidecar instance where we will create the slice
        createSliceRequestPayload - the payload to create the slice
        Throws:
        org.apache.cassandra.spark.exception.SidecarApiCallException - when an error occurs during the slice creation

      • createRestoreSliceFromDriver

        java.util.concurrent.CompletableFuture<java.lang.Void> createRestoreSliceFromDriver​(o.a.c.sidecar.client.shaded.client.SidecarInstance sidecarInstance,
                                                                                    o.a.c.sidecar.client.shaded.common.request.data.CreateSliceRequestPayload createSliceRequestPayload)
        Called from driver level to create a restore slice asynchronously. The request retries until the slice succeeds (200), failed (550) or retry has exhausted.
        Parameters:
        sidecarInstance - the sidecar instance where we will create the slice
        createSliceRequestPayload - the payload to create the slice
        Returns:
        future of create restore slice request

      • updateRestoreJob

        void updateRestoreJob​(o.a.c.sidecar.client.shaded.common.request.data.UpdateRestoreJobRequestPayload updateRestoreJobRequestPayload)
               throws org.apache.cassandra.spark.exception.SidecarApiCallException
        Throws:
        org.apache.cassandra.spark.exception.SidecarApiCallException

      • abortRestoreJob

        void abortRestoreJob()
              throws org.apache.cassandra.spark.exception.SidecarApiCallException
        Throws:
        org.apache.cassandra.spark.exception.SidecarApiCallException

      • handleInterruption

        default void handleInterruption​(java.lang.Exception cause)