org.apache.cassandra.sidecar.client.SidecarClientBlobRestoreExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of analytics-sidecar-client Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.cassandra.sidecar.client;

import java.util.UUID;
import java.util.concurrent.CompletableFuture;

import org.apache.cassandra.sidecar.common.request.data.AbortRestoreJobRequestPayload;
import org.apache.cassandra.sidecar.common.request.data.CreateRestoreJobRequestPayload;
import org.apache.cassandra.sidecar.common.request.data.CreateSliceRequestPayload;
import org.apache.cassandra.sidecar.common.request.data.RestoreJobProgressRequestParams;
import org.apache.cassandra.sidecar.common.request.data.UpdateRestoreJobRequestPayload;
import org.apache.cassandra.sidecar.common.response.data.CreateRestoreJobResponsePayload;
import org.apache.cassandra.sidecar.common.response.data.RestoreJobProgressResponsePayload;
import org.apache.cassandra.sidecar.common.response.data.RestoreJobSummaryResponsePayload;

/**
 * An extension to sidecar client interface.
 * It includes the APIs for invoking blob based restore.
 */
public interface SidecarClientBlobRestoreExtension
{
    /**
     * Create a new restore job
     *
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param payload  request payload
     * @return a completable future of {@link CreateRestoreJobResponsePayload}
     */
    CompletableFuture createRestoreJob(String keyspace, String table,
                                                                        CreateRestoreJobRequestPayload payload);

    /**
     * Update an existing restore job
     *
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param jobId    job ID of the restore job to be updated
     * @param payload  request payload
     * @return a completable future
     */
    CompletableFuture updateRestoreJob(String keyspace, String table, UUID jobId,
                                             UpdateRestoreJobRequestPayload payload);

    /**
     * Abort an existing restore job
     *
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param jobId    job ID of the restore job to be updated
     * @param payload  request payload
     * @return a completable future
     */
    CompletableFuture abortRestoreJob(String keyspace, String table, UUID jobId,
                                            AbortRestoreJobRequestPayload payload);

    /**
     * Abort an existing restore job with no reason
     * See {@link #abortRestoreJob(String, String, UUID, AbortRestoreJobRequestPayload)}
     */
    default CompletableFuture abortRestoreJob(String keyspace, String table, UUID jobId)
    {
        return abortRestoreJob(keyspace, table, jobId, null);
    }

    /**
     * Get the summary of an existing restore job
     *
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param jobId    job ID of the restore job to be updated
     * @return a completable future of {@link RestoreJobSummaryResponsePayload}
     */
    CompletableFuture restoreJobSummary(String keyspace, String table, UUID jobId);

    /**
     * Create a new slice in the restore job
     * or check the status of restore of an existing slice identified by the {@link CreateSliceRequestPayload}
     *
     * @param instance the instance where the request will be executed
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param jobId    job ID of the restore job to create slice
     * @param payload  request payload
     * @return a completable future
     */
    CompletableFuture createRestoreJobSlice(SidecarInstance instance,
                                                  String keyspace,
                                                  String table,
                                                  UUID jobId,
                                                  CreateSliceRequestPayload payload);

    /**
     * Create a new slice in the restore job on any sidecar instance.
     * Unlike {@link SidecarClientBlobRestoreExtension#createRestoreJobSlice(SidecarInstance, String, String, UUID, CreateSliceRequestPayload)},
     * it does _not_ check the status of the indicated slice. Instead, use {@code #restoreJobStatus} to fetch the job status.
     *
     * @param keyspace name of the keyspace in the cluster
     * @param table    name of the table in the cluster
     * @param jobId    job ID of the restore job to create slice
     * @param payload  request payload
     * @return a completable future
     */
    CompletableFuture createRestoreJobSlice(String keyspace,
                                                  String table,
                                                  UUID jobId,
                                                  CreateSliceRequestPayload payload);

    /**
     * Fetch the progress of the restore job
     *
     * @param params parameters to fetch the restore job progress
     * @return a completable future of {@link RestoreJobProgressResponsePayload}
     */
    CompletableFuture restoreJobProgress(RestoreJobProgressRequestParams params);
}