Method Detail

• getAllDataCenters

  @Named(value="datacenter:getall")
  List<DataCenter> getAllDataCenters()

  Returns:

  Returns a list of all Virtual Data Centers created by the user, including ID, name and version number.

• getDataCenter

  @Named(value="datacenter:get")
  DataCenter getDataCenter(String identifier)

  Parameters:

  identifier - Data Center identifier

  Returns:

  Returns information about an existing virtual data center's state and configuration or null if it doesn't exist.

• getDataCenterState

  @Named(value="datacenter:getstate")
  ProvisioningState getDataCenterState(String identifier)

  This is a lightweight function for polling the current provisioning state of the Virtual Data Center. It is recommended to use this function for large Virtual Data Centers to query request results.

  Parameters:

  identifier - Data Center identifier

• createDataCenter

  @Named(value="datacenter:create")
  DataCenter createDataCenter(DataCenter.Request.CreatePayload createRequest)

  Creates and saves a new, empty Virtual Data Center. Returns its identifier for further reference.

  Note: Data center names cannot start with or contain (@, /, \, |, ‘’, ‘)

  Parameters:

  createRequest - VDC payload containing dataCenterName, region

  Returns:

  Response containing requestId, dataCenterId, version, and location

• updateDataCenter

  @Named(value="datacenter:update")
  DataCenter updateDataCenter(DataCenter.Request.UpdatePayload updateRequest)

  Updates the information associated to an existing Virtual Data Center.

  Parameters:

  updateRequest - VDC payload containing dataCenterId, and name

  Returns:

  Response containing requestId, dataCenterId, version

• clearDataCenter

  @Named(value="datacenter:clear")
  DataCenter clearDataCenter(String identifier)

  Removes all components from an existing Virtual Data Center.

  Parameters:

  identifier - Identifier of the virtual data center

  Returns:

  Response containing requestId, dataCenterId, version

• deleteDataCenter

  @Named(value="datacenter:delete")
  boolean deleteDataCenter(String identifier)

  Deletes an Virtual Data Center. If a previous request on the target data center is still in progress, the data center is going to be deleted after this request has been completed. Once a Data Center has been deleted, no further request can be performed on it.

  Parameters:

  identifier - Identifier of the virtual data center

  Returns:

  Returns a boolean indicating whether delete operation was made