Package org.openstack4j.openstack.storage.block.internal

Class BlockVolumeTransferServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.storage.block.internal.BaseBlockStorageServices

org.openstack4j.openstack.storage.block.internal.BlockVolumeTransferServiceImpl

All Implemented Interfaces:

BlockVolumeTransferService, RestService

public class BlockVolumeTransferServiceImpl
extends BaseBlockStorageServices
implements BlockVolumeTransferService

Related services for managing volume transfers (os-volume-transfer)

Author:

Jeremy Unruh

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
BlockVolumeTransferServiceImpl()

Method Summary

Modifier and Type	Method	Description
VolumeTransfer	accept(String transferId, String authKey)	Accepts a pending volume transfer
VolumeTransfer	create(String volumeId)	Creates a new Volume Transfer
VolumeTransfer	create(String volumeId, String name)	Creates a new Volume Transfer
ActionResponse	delete(String transferId)	Deletes a specific transfer
VolumeTransfer	get(String transferId)	Gets details about a specific transfer
List<? extends VolumeTransfer>	list()	Gets ALL volume transfers in detailed form
List<? extends VolumeTransfer>	list(boolean detailed)	Gets ALL volume transfers

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getWithResponse, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, putWithResponse, request, toList, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockVolumeTransferServiceImpl

public BlockVolumeTransferServiceImpl()

Method Detail

list

public List<? extends VolumeTransfer> list()

Description copied from interface: BlockVolumeTransferService

Gets ALL volume transfers in detailed form

Specified by:

list in interface BlockVolumeTransferService

Returns:

List of Volume Transfers

list

public List<? extends VolumeTransfer> list(boolean detailed)

Description copied from interface: BlockVolumeTransferService

Gets ALL volume transfers

Specified by:

list in interface BlockVolumeTransferService

Parameters:

detailed - if true all fields are populated otherwise just id, volumeId and name

Returns:

List of Volume Transfers

get

public VolumeTransfer get(String transferId)

Description copied from interface: BlockVolumeTransferService

Gets details about a specific transfer

Specified by:

get in interface BlockVolumeTransferService

Parameters:

transferId - the transfer identifier

Returns:

the transfer details or null

create

public VolumeTransfer create(String volumeId)

Description copied from interface: BlockVolumeTransferService

Creates a new Volume Transfer

Specified by:

create in interface BlockVolumeTransferService

Parameters:

volumeId - the identifier of the volume to transfer

Returns:

the created volume transfer containing the authorization key

create

public VolumeTransfer create(String volumeId,
                             String name)

Description copied from interface: BlockVolumeTransferService

Creates a new Volume Transfer

Specified by:

create in interface BlockVolumeTransferService

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

public VolumeTransfer accept(String transferId,
                             String authKey)

Description copied from interface: BlockVolumeTransferService

Accepts a pending volume transfer

Specified by:

accept in interface BlockVolumeTransferService

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

delete

public ActionResponse delete(String transferId)

Description copied from interface: BlockVolumeTransferService

Deletes a specific transfer

Specified by:

delete in interface BlockVolumeTransferService

Parameters:

transferId - the transfer identifier to delete

Returns:

the action response