Package com.vmware.vra.jenkinsplugin.vra

Class VraApi

java.lang.Object

com.vmware.vra.jenkinsplugin.vra.VraApi

All Implemented Interfaces:

Serializable

public class VraApi
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
VraApi(VraClient vraClient)
VraApi(String url, String token, boolean trustSelfSignedCert)
VraApi(String url, String domain, String username, String password, boolean trustSelfSignedCert)

Method Summary

Modifier and Type	Method	Description
DeploymentRequest	deleteCatalogDeployment(String deploymentId)
CatalogItemRequestResponse[]	deployFromCatalog(String ciName, String version, String project, String deploymentName, String reason, Map<String,Object> inputs, int count)
Deployment	getCatalogDeploymentById(String deploymentId, boolean expandResources)
Deployment	getCatalogDeploymentByName(String deploymentName, boolean expandResources)
CatalogItem	getCatalogItemById(String id)
CatalogItem	getCatalogItemByName(String name)
DeploymentRequest	getDeploymentRequest(String id)
CatalogItemVersion	getLatestCatalogItemVersion(String id)
List<Resource>	getNamedResourcesForDeployment(String deploymentId, String resourceName)
Project	getProjectById(String id)
Project	getProjectByName(String name)
ResourceAction	getResourceActionDetails(String deploymentId, String resourceId, String actionName)
ResourceAction[]	getResourceActions(String deploymentId, String resourceId)
static Pattern	getResourcePattern(String resourceName)
List<Resource>	getResourcesForDeployment(String deploymentId)
DeploymentRequest	submitDeploymentAction(String deploymentId, String actionId, String reason, Map<String,Object> inputs)
DeploymentRequest	submitResourceAction(String deploymentId, String resourceId, String actionId, String reason, Map<String,Object> inputs)
Deployment	waitForCatalogDeployment(String deploymentId, long timeout)
List<String>	waitForIPAddresses(String deploymentId, String resourceName, long timeout)
DeploymentRequest	waitForRequestCompletion(String id, long timeout)
List<DeploymentRequest>	waitForRequestCompletion(List<String> ids, long timeout)

Methods inherited from class java.lang.Object

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

Constructor Details

VraApi

public VraApi(String url, String token, boolean trustSelfSignedCert) throws VRAException

Throws:

VRAException

VraApi

public VraApi(String url, String domain, String username, String password, boolean trustSelfSignedCert) throws VRAException

Throws:

VRAException

VraApi

public VraApi(VraClient vraClient)

Method Details

getResourcePattern

public static Pattern getResourcePattern(String resourceName)

getCatalogItemByName

public CatalogItem getCatalogItemByName(String name) throws VRAException

Throws:

VRAException

getLatestCatalogItemVersion

public CatalogItemVersion getLatestCatalogItemVersion(String id) throws VRAException

Throws:

VRAException

getProjectByName

public Project getProjectByName(String name) throws VRAException

Throws:

VRAException

getProjectById

public Project getProjectById(String id) throws VRAException

Throws:

VRAException

getCatalogItemById

public CatalogItem getCatalogItemById(String id) throws VRAException

Throws:

VRAException

waitForIPAddresses

public List<String> waitForIPAddresses(String deploymentId, String resourceName, long timeout) throws VRAException, InterruptedException, TimeoutException

Throws:

VRAException

InterruptedException

TimeoutException

deployFromCatalog

public CatalogItemRequestResponse[] deployFromCatalog(String ciName, String version, String project, String deploymentName, String reason, Map<String,Object> inputs, int count) throws VRAException

Throws:

VRAException

getCatalogDeploymentById

public Deployment getCatalogDeploymentById(String deploymentId, boolean expandResources) throws VRAException

Throws:

VRAException

getCatalogDeploymentByName

public Deployment getCatalogDeploymentByName(String deploymentName, boolean expandResources) throws VRAException

Throws:

VRAException

deleteCatalogDeployment

public DeploymentRequest deleteCatalogDeployment(String deploymentId) throws VRAException

Throws:

VRAException

waitForCatalogDeployment

public Deployment waitForCatalogDeployment(String deploymentId, long timeout) throws TimeoutException, VRAException, InterruptedException

Throws:

TimeoutException

VRAException

InterruptedException

getDeploymentRequest

public DeploymentRequest getDeploymentRequest(String id) throws VRAException

Throws:

VRAException

waitForRequestCompletion

public DeploymentRequest waitForRequestCompletion(String id, long timeout) throws VRAException, TimeoutException, InterruptedException

Throws:

VRAException

TimeoutException

InterruptedException

waitForRequestCompletion

public List<DeploymentRequest> waitForRequestCompletion(List<String> ids, long timeout) throws VRAException, TimeoutException, InterruptedException

Throws:

VRAException

TimeoutException

InterruptedException

submitDeploymentAction

public DeploymentRequest submitDeploymentAction(String deploymentId, String actionId, String reason, Map<String,Object> inputs) throws VRAException

Throws:

VRAException

submitResourceAction

public DeploymentRequest submitResourceAction(String deploymentId, String resourceId, String actionId, String reason, Map<String,Object> inputs) throws VRAException

Throws:

VRAException

getResourcesForDeployment

public List<Resource> getResourcesForDeployment(String deploymentId) throws VRAException

Throws:

VRAException

getNamedResourcesForDeployment

public List<Resource> getNamedResourcesForDeployment(String deploymentId, String resourceName) throws VRAException

Throws:

VRAException

getResourceActionDetails

public ResourceAction getResourceActionDetails(String deploymentId, String resourceId, String actionName) throws VRAException

Throws:

VRAException

getResourceActions

public ResourceAction[] getResourceActions(String deploymentId, String resourceId) throws VRAException

Throws:

VRAException