Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.policies
[Groovy] Class Policy

java.lang.Object
  com.ace.mws.policies.Policy

class Policy

A Moab Workload Manager policy which can affect scheduling decisions such as resource allocation. A policy contains state, identifying information, a priority, and metadata about the policy.

Available policies:

Authors:
bsaville

Field Summary
private Boolean conflicted

Signifies whether any other policies are currently activated that potentially conflict with this policy.

private String description

The user friendly description of the policy.
private String id

The unique identifier for the policy.

private String name

The user friendly name of the policy.
private Set potentialConflicts

(String collection) A set of policy IDs that may potentially conflict with this policy.
private Integer priority

Indicates the absolute priority of the policy with respect to others.

private PolicyState state

Defines the current state of the policy: enabled or disabled.

private Set tags

(String collection) A set of strings that can be used to aid in filtering or querying policies.
private Set types

(String collection) A set of categories or types that the policy is included in.

 
Constructor Summary
Policy()

 
Method Summary
Boolean getConflicted()

Signifies whether any other policies are currently activated that potentially conflict with this policy.

String getDescription()

The user friendly description of the policy.
String getId()

The unique identifier for the policy.

String getName()

The user friendly name of the policy.
Set getPotentialConflicts()

(String collection) A set of policy IDs that may potentially conflict with this policy.
Integer getPriority()

Indicates the absolute priority of the policy with respect to others.

PolicyState getState()

Defines the current state of the policy: enabled or disabled.

Set getTags()

(String collection) A set of strings that can be used to aid in filtering or querying policies.
Set getTypes()

(String collection) A set of categories or types that the policy is included in.

void setConflicted(Boolean conflicted)

Signifies whether any other policies are currently activated that potentially conflict with this policy.

void setDescription(String description)

The user friendly description of the policy.
void setId(String id)

The unique identifier for the policy.

void setName(String name)

The user friendly name of the policy.
void setPotentialConflicts(Set potentialConflicts)

(String collection) A set of policy IDs that may potentially conflict with this policy.
void setPriority(Integer priority)

Indicates the absolute priority of the policy with respect to others.

void setState(PolicyState state)

Defines the current state of the policy: enabled or disabled.

void setTags(Set tags)

(String collection) A set of strings that can be used to aid in filtering or querying policies.
void setTypes(Set types)

(String collection) A set of categories or types that the policy is included in.

String toString()

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

Field Detail

conflicted

private Boolean conflicted
Signifies whether any other policies are currently activated that potentially conflict with this policy. If true, it signifies a potential conflict.

description

private String description
The user friendly description of the policy.

id

private String id
The unique identifier for the policy. Must contain only lowercase letters and dashes, such as 'auto-vm-migration'.

name

private String name
The user friendly name of the policy.

potentialConflicts

private Set potentialConflicts
(String collection) A set of policy IDs that may potentially conflict with this policy.
See Also:
String

priority

private Integer priority
Indicates the absolute priority of the policy with respect to others. It is possible that more than one policy has the same priority.
The higher the number, the greater the priority. Minimum is 0.

state

private PolicyState state
Defines the current state of the policy: enabled or disabled. Defaults to PolicyState#DISABLED#DISABLED.

tags

private Set tags
(String collection) A set of strings that can be used to aid in filtering or querying policies.
See Also:
String

types

private Set types
(String collection) A set of categories or types that the policy is included in. This may be used to filter or query on groups of policies.
See Also:
String

 
Constructor Detail

Policy

Policy()

 
Method Detail

getConflicted

Boolean getConflicted()
Signifies whether any other policies are currently activated that potentially conflict with this policy. If true, it signifies a potential conflict.

getDescription

String getDescription()
The user friendly description of the policy.

getId

String getId()
The unique identifier for the policy. Must contain only lowercase letters and dashes, such as 'auto-vm-migration'.

getName

String getName()
The user friendly name of the policy.

getPotentialConflicts

Set getPotentialConflicts()
(String collection) A set of policy IDs that may potentially conflict with this policy.
See Also:
String

getPriority

Integer getPriority()
Indicates the absolute priority of the policy with respect to others. It is possible that more than one policy has the same priority.
The higher the number, the greater the priority. Minimum is 0.

getState

PolicyState getState()
Defines the current state of the policy: enabled or disabled. Defaults to PolicyState#DISABLED#DISABLED.

getTags

Set getTags()
(String collection) A set of strings that can be used to aid in filtering or querying policies.
See Also:
String

getTypes

Set getTypes()
(String collection) A set of categories or types that the policy is included in. This may be used to filter or query on groups of policies.
See Also:
String

setConflicted

void setConflicted(Boolean conflicted)
Signifies whether any other policies are currently activated that potentially conflict with this policy. If true, it signifies a potential conflict.

setDescription

void setDescription(String description)
The user friendly description of the policy.

setId

void setId(String id)
The unique identifier for the policy. Must contain only lowercase letters and dashes, such as 'auto-vm-migration'.

setName

void setName(String name)
The user friendly name of the policy.

setPotentialConflicts

void setPotentialConflicts(Set potentialConflicts)
(String collection) A set of policy IDs that may potentially conflict with this policy.
See Also:
String

setPriority

void setPriority(Integer priority)
Indicates the absolute priority of the policy with respect to others. It is possible that more than one policy has the same priority.
The higher the number, the greater the priority. Minimum is 0.

setState

void setState(PolicyState state)
Defines the current state of the policy: enabled or disabled. Defaults to PolicyState#DISABLED#DISABLED.

setTags

void setTags(Set tags)
(String collection) A set of strings that can be used to aid in filtering or querying policies.
See Also:
String

setTypes

void setTypes(Set types)
(String collection) A set of categories or types that the policy is included in. This may be used to filter or query on groups of policies.
See Also:
String

toString

String toString()

 

Groovy Documentation