NFS3 protocol specific snapshot workflows #36
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /* | ||
| * 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.cloudstack.storage.feign.client; | ||
|
|
||
| import feign.Headers; | ||
| import feign.Param; | ||
| import feign.QueryMap; | ||
| import feign.RequestLine; | ||
| import org.apache.cloudstack.storage.feign.model.FlexVolSnapshot; | ||
| import org.apache.cloudstack.storage.feign.model.SnapshotFileRestoreRequest; | ||
| import org.apache.cloudstack.storage.feign.model.response.JobResponse; | ||
| import org.apache.cloudstack.storage.feign.model.response.OntapResponse; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Feign client for ONTAP FlexVolume snapshot operations. | ||
| * | ||
| * <p>Maps to the ONTAP REST API endpoint: | ||
| * {@code /api/storage/volumes/{volume_uuid}/snapshots}</p> | ||
| * | ||
| * <p>FlexVolume snapshots are point-in-time, space-efficient copies of an entire | ||
| * FlexVolume. Unlike file-level clones, a single FlexVolume snapshot atomically | ||
| * captures <b>all</b> files/LUNs within the volume, making it ideal for VM-level | ||
| * snapshots when multiple CloudStack disks reside on the same FlexVolume.</p> | ||
| */ | ||
| public interface SnapshotFeignClient { | ||
|
|
||
| /** | ||
| * Creates a new snapshot for the specified FlexVolume. | ||
| * | ||
| * <p>ONTAP REST: {@code POST /api/storage/volumes/{volume_uuid}/snapshots}</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param snapshot Snapshot request body (at minimum, the {@code name} field) | ||
| * @return JobResponse containing the async job reference | ||
| */ | ||
| @RequestLine("POST /api/storage/volumes/{volumeUuid}/snapshots") | ||
| @Headers({"Authorization: {authHeader}", "Content-Type: application/json"}) | ||
| JobResponse createSnapshot(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| FlexVolSnapshot snapshot); | ||
|
|
||
| /** | ||
| * Lists snapshots for the specified FlexVolume. | ||
| * | ||
| * <p>ONTAP REST: {@code GET /api/storage/volumes/{volume_uuid}/snapshots}</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param queryParams Optional query parameters (e.g., {@code name}, {@code fields}) | ||
| * @return Paginated response of FlexVolSnapshot records | ||
| */ | ||
| @RequestLine("GET /api/storage/volumes/{volumeUuid}/snapshots") | ||
| @Headers({"Authorization: {authHeader}"}) | ||
| OntapResponse<FlexVolSnapshot> getSnapshots(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| @QueryMap Map<String, Object> queryParams); | ||
|
|
||
| /** | ||
| * Retrieves a specific snapshot by UUID. | ||
| * | ||
| * <p>ONTAP REST: {@code GET /api/storage/volumes/{volume_uuid}/snapshots/{uuid}}</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param snapshotUuid UUID of the snapshot | ||
| * @return The FlexVolSnapshot object | ||
| */ | ||
| @RequestLine("GET /api/storage/volumes/{volumeUuid}/snapshots/{snapshotUuid}") | ||
| @Headers({"Authorization: {authHeader}"}) | ||
| FlexVolSnapshot getSnapshotByUuid(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| @Param("snapshotUuid") String snapshotUuid); | ||
|
|
||
| /** | ||
| * Deletes a specific snapshot. | ||
| * | ||
| * <p>ONTAP REST: {@code DELETE /api/storage/volumes/{volume_uuid}/snapshots/{uuid}}</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param snapshotUuid UUID of the snapshot to delete | ||
| * @return JobResponse containing the async job reference | ||
| */ | ||
| @RequestLine("DELETE /api/storage/volumes/{volumeUuid}/snapshots/{snapshotUuid}") | ||
| @Headers({"Authorization: {authHeader}"}) | ||
| JobResponse deleteSnapshot(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| @Param("snapshotUuid") String snapshotUuid); | ||
|
|
||
| /** | ||
| * Restores a volume to a specific snapshot. | ||
| * | ||
| * <p>ONTAP REST: {@code PATCH /api/storage/volumes/{volume_uuid}/snapshots/{uuid}} | ||
| * with body {@code {"restore": true}} triggers a snapshot restore operation.</p> | ||
| * | ||
| * <p><b>Note:</b> This is a destructive operation — all data written after the | ||
| * snapshot was taken will be lost.</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param snapshotUuid UUID of the snapshot to restore to | ||
| * @param body Request body, typically {@code {"restore": true}} | ||
| * @return JobResponse containing the async job reference | ||
| */ | ||
| @RequestLine("PATCH /api/storage/volumes/{volumeUuid}/snapshots/{snapshotUuid}?restore_to_snapshot=true") | ||
| @Headers({"Authorization: {authHeader}", "Content-Type: application/json"}) | ||
| JobResponse restoreSnapshot(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| @Param("snapshotUuid") String snapshotUuid); | ||
|
|
||
| /** | ||
| * Restores a single file or LUN from a FlexVolume snapshot. | ||
| * | ||
| * <p>ONTAP REST: | ||
| * {@code POST /api/storage/volumes/{volume_uuid}/snapshots/{snapshot_uuid}/files/{file_path}/restore}</p> | ||
| * | ||
| * <p>This restores only the specified file/LUN from the snapshot to the | ||
| * given {@code destination_path}, without reverting the entire FlexVolume. | ||
| * Ideal when multiple VMs share the same FlexVolume.</p> | ||
| * | ||
| * @param authHeader Basic auth header | ||
| * @param volumeUuid UUID of the ONTAP FlexVolume | ||
| * @param snapshotUuid UUID of the snapshot containing the file | ||
| * @param filePath path of the file within the snapshot (URL-encoded if needed) | ||
| * @param request request body with {@code destination_path} | ||
| * @return JobResponse containing the async job reference | ||
| */ | ||
| @RequestLine("POST /api/storage/volumes/{volumeUuid}/snapshots/{snapshotUuid}/files/{filePath}/restore") | ||
| @Headers({"Authorization: {authHeader}", "Content-Type: application/json"}) | ||
| JobResponse restoreFileFromSnapshot(@Param("authHeader") String authHeader, | ||
| @Param("volumeUuid") String volumeUuid, | ||
| @Param("snapshotUuid") String snapshotUuid, | ||
| @Param("filePath") String filePath, | ||
| SnapshotFileRestoreRequest request); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why this change is required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am returning the failure reasons through the exception.