com.huawei.openstack4j.api.manila.ShareSnapshotService Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* Licensed 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 com.huawei.openstack4j.api.manila;
import java.util.List;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.manila.ShareSnapshot;
import com.huawei.openstack4j.model.manila.ShareSnapshotCreate;
import com.huawei.openstack4j.model.manila.ShareSnapshotUpdateOptions;
/**
* Share Snapshot Service for Manila SHared Filesystems.
*
* @author Daniel Gonzalez Nothnagel
*/
public interface ShareSnapshotService extends RestService {
/**
* Creates a snapshot from a share.
*
* @param snapshotCreate the snapshot to create
* @return the snapshot
*/
ShareSnapshot create(ShareSnapshotCreate snapshotCreate);
/**
* Lists all share snapshots.
*
* @return a list of all snapshots
*/
List list();
/**
* Lists all share snapshots with details.
*
* @return a list of all snapshots with details
*/
List listDetails();
/**
* Shows details for a share snapshot.
*
* @param snapshotId the snapshot ID
* @return the snapshot
*/
ShareSnapshot get(String snapshotId);
/**
* Updates a share snapshot.
*
* @param snapshotId the snapshot ID
* @param snapshotUpdateOptions the options to update on the snapshot
* @return the snapshot
*/
ShareSnapshot update(String snapshotId, ShareSnapshotUpdateOptions snapshotUpdateOptions);
/**
* Deletes a share snapshot.
*
* @param snapshotId the snapshot ID
* @return the action response
*/
ActionResponse delete(String snapshotId);
/**
* Administrator only. Explicitly updates the state of a share snapshot.
*
* @param snapshotId the snapshot ID
* @param status the status to set
* @return the action response
*/
ActionResponse resetState(String snapshotId, ShareSnapshot.Status status);
/**
* Administrator only. Force-deletes a share snapshot in any state.
*
* @param snapshotId the snapshot ID
* @return the action response
*/
ActionResponse forceDelete(String snapshotId);
}