org.openstack4j.model.manila.builder.ShareSnapshotCreateBuilder Maven / Gradle / Ivy
package org.openstack4j.model.manila.builder;
import org.openstack4j.common.Buildable;
import org.openstack4j.model.manila.ShareSnapshotCreate;
/**
* Builds a {@link org.openstack4j.model.manila.ShareSnapshotCreate}.
*
* @author Daniel Gonzalez Nothnagel
*/
public interface ShareSnapshotCreateBuilder extends Buildable.Builder {
/**
* Set the UUID of the share from which to create a snapshot.
*
* @param shareId the share ID
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder shareId(String shareId);
/**
* Set whether snapshot creation is enabled when a share is busy.
*
* @param force whether snapshot creation is forced
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder force(boolean force);
/**
* Set the snapshot name.
*
* @param name the snapshot name
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder name(String name);
/**
* Set the snapshot name.
*
* The Shared File Systems API supports the use of both name and display_name attributes,
* which are inherited attributes from the Block Storage API.
*
* @param displayName the snapshot name
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder displayName(String displayName);
/**
* Set the snapshot description.
*
* @param description the snapshot description
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder description(String description);
/**
* Set the snapshot description.
*
* The Shared File Systems API supports the use of both description and
* display_description parameters, which are inherited attributes from the Block Storage API.
*
* @param displayDescription the snapshot description
* @return ShareSnapshotCreateBuilder
*/
ShareSnapshotCreateBuilder displayDescription(String displayDescription);
}