Groovy Documentation

com.ace.mws.vpcs
[Groovy] Class VirtualPrivateCluster

java.lang.Object
  com.ace.mws.vpcs.VirtualPrivateCluster

class VirtualPrivateCluster

Note: Virtual Private Clusters are not supported with Moab Workload Manager 7.0 or later.

A Virtual Private Cluster is a artificial partitioning of resources represented by a group of Reservations.

VPCs allow sites to group resources as a named package, which allows users to select the name of the package they need instead of requesting each resource individually. When a user requests a package, Moab schedules all of the resources required and lets the user know when the package is available for use.

Resources such as network, data, and security objects can be packaged together as a single VPC. Users must then just request the primary resource needed, such as a compute node, and other pre-configured resources such as storage and network are automatically added.

Additional setup and teardown steps can also be added to the VPC. Moab runs these extra steps automatically without the need for administrator action. Users request a package, wait for notification that the package is ready, and start using it while Moab, behind the scenes, takes care of scheduling, configuration and provisioning.

NOTE: the use of VPCs for cloud computing is being deprecated in favor of a Job-centric model. Please contact your Adaptive Computing representative about the "Workload-Driven Cloud" before depending on this API.

Authors:
tfrench, vrb


Field Summary
private Set aclRules

(AclRule collection) The set of access control rules associated with this virtual private cluster.

private Double cost

The cost of this virtual private cluster.

private Long durationInSecs

The duration of this virtual private cluster in seconds.

private String id

The ID of this virtual private cluster.

private Set messages

(MessageVersion1 collection) The set of messages attached to this virtual private cluster.

private Set nodeNames

(String collection) The nodes hosting this virtual private cluster.

private EmbeddedCredential owner

The credential that owns this virtual private cluster.

private String profile

The name of the profile used when creating this virtual private cluster.

private Date purgeDate

The time when the virtual private cluster will be destroyed.

private String reqResources

The required resources associated with this virtual private cluster.

private String resProfile

The reservation profile of this virtual private cluster.

private Reservation reservation

The reservation associated with the virtual private cluster.

private String resources

The resources associated with this virtual private cluster.

private Date startDate

The start time for this virtual private cluster.

private VPCState state

The state of this virtual private cluster.

private Map variables

(Map of String => String) The variables associated with this virtual private cluster.

 
Constructor Summary
VirtualPrivateCluster()

 
Method Summary
Set getAclRules()

(AclRule collection) The set of access control rules associated with this virtual private cluster.

Double getCost()

The cost of this virtual private cluster.

Long getDurationInSecs()

The duration of this virtual private cluster in seconds.

String getId()

The ID of this virtual private cluster.

Set getMessages()

(MessageVersion1 collection) The set of messages attached to this virtual private cluster.

Set getNodeNames()

(String collection) The nodes hosting this virtual private cluster.

EmbeddedCredential getOwner()

The credential that owns this virtual private cluster.

String getProfile()

The name of the profile used when creating this virtual private cluster.

Date getPurgeDate()

The time when the virtual private cluster will be destroyed.

String getReqResources()

The required resources associated with this virtual private cluster.

String getResProfile()

The reservation profile of this virtual private cluster.

Reservation getReservation()

The reservation associated with the virtual private cluster.

String getResources()

The resources associated with this virtual private cluster.

Date getStartDate()

The start time for this virtual private cluster.

VPCState getState()

The state of this virtual private cluster.

Map getVariables()

(Map of String => String) The variables associated with this virtual private cluster.

void setAclRules(Set aclRules)

(AclRule collection) The set of access control rules associated with this virtual private cluster.

void setCost(Double cost)

The cost of this virtual private cluster.

void setDurationInSecs(Long durationInSecs)

The duration of this virtual private cluster in seconds.

void setId(String id)

The ID of this virtual private cluster.

void setMessages(Set messages)

(MessageVersion1 collection) The set of messages attached to this virtual private cluster.

void setNodeNames(Set nodeNames)

(String collection) The nodes hosting this virtual private cluster.

void setOwner(EmbeddedCredential owner)

The credential that owns this virtual private cluster.

void setProfile(String profile)

The name of the profile used when creating this virtual private cluster.

void setPurgeDate(Date purgeDate)

The time when the virtual private cluster will be destroyed.

void setReqResources(String reqResources)

The required resources associated with this virtual private cluster.

void setResProfile(String resProfile)

The reservation profile of this virtual private cluster.

void setReservation(Reservation reservation)

The reservation associated with the virtual private cluster.

void setResources(String resources)

The resources associated with this virtual private cluster.

void setStartDate(Date startDate)

The start time for this virtual private cluster.

void setState(VPCState state)

The state of this virtual private cluster.

void setVariables(Map variables)

(Map of String => String) The variables associated with this virtual private cluster.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

aclRules

private Set aclRules
(AclRule collection) The set of access control rules associated with this virtual private cluster.
See Also:
AclRule


cost

private Double cost
The cost of this virtual private cluster.


durationInSecs

private Long durationInSecs
The duration of this virtual private cluster in seconds. Valid during PUT.


id

private String id
The ID of this virtual private cluster.


messages

private Set messages
(MessageVersion1 collection) The set of messages attached to this virtual private cluster. Valid during PUT.
See Also:
MessageVersion1


nodeNames

private Set nodeNames
(String collection) The nodes hosting this virtual private cluster.
See Also:
String


owner

private EmbeddedCredential owner
The credential that owns this virtual private cluster. Valid during PUT.


profile

private String profile
The name of the profile used when creating this virtual private cluster. Valid during PUT.


purgeDate

private Date purgeDate
The time when the virtual private cluster will be destroyed.


reqResources

private String reqResources
The required resources associated with this virtual private cluster. Valid during PUT.


resProfile

private String resProfile
The reservation profile of this virtual private cluster. Valid during PUT.


reservation

private Reservation reservation
The reservation associated with the virtual private cluster. Usually, this will be the object returned by the resources String.


resources

private String resources
The resources associated with this virtual private cluster. This is usually the name of the reservation associated with the virtual private cluster. Valid during PUT.


startDate

private Date startDate
The start time for this virtual private cluster. Valid during PUT.


state

private VPCState state
The state of this virtual private cluster.


variables

private Map variables
(Map of String => String) The variables associated with this virtual private cluster. Valid during PUT.
See Also:
Map


 
Constructor Detail

VirtualPrivateCluster

VirtualPrivateCluster()


 
Method Detail

getAclRules

Set getAclRules()
(AclRule collection) The set of access control rules associated with this virtual private cluster.
See Also:
AclRule


getCost

Double getCost()
The cost of this virtual private cluster.


getDurationInSecs

Long getDurationInSecs()
The duration of this virtual private cluster in seconds. Valid during PUT.


getId

String getId()
The ID of this virtual private cluster.


getMessages

Set getMessages()
(MessageVersion1 collection) The set of messages attached to this virtual private cluster. Valid during PUT.
See Also:
MessageVersion1


getNodeNames

Set getNodeNames()
(String collection) The nodes hosting this virtual private cluster.
See Also:
String


getOwner

EmbeddedCredential getOwner()
The credential that owns this virtual private cluster. Valid during PUT.


getProfile

String getProfile()
The name of the profile used when creating this virtual private cluster. Valid during PUT.


getPurgeDate

Date getPurgeDate()
The time when the virtual private cluster will be destroyed.


getReqResources

String getReqResources()
The required resources associated with this virtual private cluster. Valid during PUT.


getResProfile

String getResProfile()
The reservation profile of this virtual private cluster. Valid during PUT.


getReservation

Reservation getReservation()
The reservation associated with the virtual private cluster. Usually, this will be the object returned by the resources String.


getResources

String getResources()
The resources associated with this virtual private cluster. This is usually the name of the reservation associated with the virtual private cluster. Valid during PUT.


getStartDate

Date getStartDate()
The start time for this virtual private cluster. Valid during PUT.


getState

VPCState getState()
The state of this virtual private cluster.


getVariables

Map getVariables()
(Map of String => String) The variables associated with this virtual private cluster. Valid during PUT.
See Also:
Map


setAclRules

void setAclRules(Set aclRules)
(AclRule collection) The set of access control rules associated with this virtual private cluster.
See Also:
AclRule


setCost

void setCost(Double cost)
The cost of this virtual private cluster.


setDurationInSecs

void setDurationInSecs(Long durationInSecs)
The duration of this virtual private cluster in seconds. Valid during PUT.


setId

void setId(String id)
The ID of this virtual private cluster.


setMessages

void setMessages(Set messages)
(MessageVersion1 collection) The set of messages attached to this virtual private cluster. Valid during PUT.
See Also:
MessageVersion1


setNodeNames

void setNodeNames(Set nodeNames)
(String collection) The nodes hosting this virtual private cluster.
See Also:
String


setOwner

void setOwner(EmbeddedCredential owner)
The credential that owns this virtual private cluster. Valid during PUT.


setProfile

void setProfile(String profile)
The name of the profile used when creating this virtual private cluster. Valid during PUT.


setPurgeDate

void setPurgeDate(Date purgeDate)
The time when the virtual private cluster will be destroyed.


setReqResources

void setReqResources(String reqResources)
The required resources associated with this virtual private cluster. Valid during PUT.


setResProfile

void setResProfile(String resProfile)
The reservation profile of this virtual private cluster. Valid during PUT.


setReservation

void setReservation(Reservation reservation)
The reservation associated with the virtual private cluster. Usually, this will be the object returned by the resources String.


setResources

void setResources(String resources)
The resources associated with this virtual private cluster. This is usually the name of the reservation associated with the virtual private cluster. Valid during PUT.


setStartDate

void setStartDate(Date startDate)
The start time for this virtual private cluster. Valid during PUT.


setState

void setState(VPCState state)
The state of this virtual private cluster.


setVariables

void setVariables(Map variables)
(Map of String => String) The variables associated with this virtual private cluster. Valid during PUT.
See Also:
Map


toString

String toString()


 

Groovy Documentation