Package org.openstack4j.api.storage

Interface BlockVolumeTransferService

  • All Superinterfaces:
    RestService
    All Known Implementing Classes:
    BlockVolumeTransferServiceImpl
    public interface BlockVolumeTransferService
extends RestService
    Related services for managing volume transfers (os-volume-transfer). This service is used to transfer a volume from one tenant to another. In OpenStack4j you would create the request authenticated against one tenant and accept the request from the receiving tenant
    Author:
    Jeremy Unruh

    • Method Detail

      • list

        List<? extends VolumeTransfer> list()
        Gets ALL volume transfers in detailed form
        Returns:
        List of Volume Transfers

      • list

        List<? extends VolumeTransfer> list​(boolean detailed)
        Gets ALL volume transfers
        Parameters:
        detailed - if true all fields are populated otherwise just id, volumeId and name
        Returns:
        List of Volume Transfers

      • get

        VolumeTransfer get​(String transferId)
        Gets details about a specific transfer
        Parameters:
        transferId - the transfer identifier
        Returns:
        the transfer details or null

      • delete

        ActionResponse delete​(String transferId)
        Deletes a specific transfer
        Parameters:
        transferId - the transfer identifier to delete
        Returns:
        the action response

      • create

        VolumeTransfer create​(String volumeId)
        Creates a new Volume Transfer
        Parameters:
        volumeId - the identifier of the volume to transfer
        Returns:
        the created volume transfer containing the authorization key

      • create

        VolumeTransfer create​(String volumeId,
                      String name)
        Creates a new Volume Transfer
        Parameters:
        volumeId - the identifier of the volume to transfer
        name - the name of the transfer (optional)
        Returns:
        the created volume transfer containing the authorization key

      • accept

        VolumeTransfer accept​(String transferId,
                      String authKey)
        Accepts a pending volume transfer
        Parameters:
        transferId - the identifier of the transfer to accept
        authKey - the auth key of the transfer
        Returns:
        VolumeTransfer detailing the name and volume identifier that was transfer