com.morpheusdata.model

Class NetworkPoolType

java.lang.Object

com.morpheusdata.model.MorpheusModel

com.morpheusdata.model.NetworkPoolType

public class NetworkPoolType
extends MorpheusModel

Each implementation of IPAM Typically define a pool type for human readable reference. This enables the user to correctly select the pool of the appropriate type. It is also possible for some IPAMProvider implementations to provide multiple types (for example IPV6 vs. IPV4).

See Also:

IPAMProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	code A Unique Code string for easier programmatic reference and API Use.
protected java.lang.Boolean	creatable Defines whether or not a Pool can be created from the UI (Currently not supported by the IPAMProvider implementation).
protected java.lang.String	description An optional description can be provided if absolutely necessary.
protected java.lang.String	name Human Readable name of the Pool Type.

Fields inherited from class com.morpheusdata.model.MorpheusModel

config, id

Constructor Summary

Constructors

Constructor and Description
NetworkPoolType()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Fetches the unique code pertaining to this particular network pool type.
java.lang.Boolean	getCreatable() Gets creatable flag from this particular pool type.
java.lang.String	getDescription() Gets the description of the network pool type if it is necessary for further clarification.
java.lang.String	getName() Gets the human readable name of the Pool Type that will be displayed in the Morpheus UI for reference.
void	setCode(java.lang.String code) Used for assigning a unique code for the NetworkPoolType.
void	setCreatable(java.lang.Boolean creatable) Sets creatable flag from this particular pool type.
void	setDescription(java.lang.String description) Sets the description text of the current pool type.
void	setName(java.lang.String name) Allows one to set the human readable name of the Pool Type that will be displayed in the Morpheus UI for reference.

Methods inherited from class com.morpheusdata.model.MorpheusModel

getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getId, getProperties, markClean, markDirty, setConfig, setConfigMap, setId

Methods inherited from class java.lang.Object

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

Field Detail

code

protected java.lang.String code

A Unique Code string for easier programmatic reference and API Use. Should be unique globally

name

protected java.lang.String name

Human Readable name of the Pool Type. (can be overridden with i18n schemas).

description

protected java.lang.String description

An optional description can be provided if absolutely necessary.

creatable

protected java.lang.Boolean creatable

Defines whether or not a Pool can be created from the UI (Currently not supported by the IPAMProvider implementation).

Constructor Detail

NetworkPoolType

public NetworkPoolType()

Method Detail

getCode

public java.lang.String getCode()

Fetches the unique code pertaining to this particular network pool type. Morpheus uses codes for easier reference instead of simply using database ids as these can change from appliance to appliance where as the code is static and unique.

Returns:

The unique string code representation of the pool type

setCode

public void setCode(java.lang.String code)

Used for assigning a unique code for the NetworkPoolType. These should be globally unique and are typically provided via the relevant IPAMProvider.

Parameters:

code - a Unique code representation of a pool type. (i.e. 'infoblox').

getName

public java.lang.String getName()

Gets the human readable name of the Pool Type that will be displayed in the Morpheus UI for reference. This should ideally be unique but is not mandatory.

Returns:

name

setName

public void setName(java.lang.String name)

Allows one to set the human readable name of the Pool Type that will be displayed in the Morpheus UI for reference.

Parameters:

name - A human readable name representing the provided network type.

getDescription

public java.lang.String getDescription()

Gets the description of the network pool type if it is necessary for further clarification. In most cases this is not necessary and can be left blank since the pool type name should be descriptive enough.

Returns:

A description of the current pool type is returned.

setDescription

public void setDescription(java.lang.String description)

Sets the description text of the current pool type. This description information can be used

Parameters:

description - description

getCreatable

public java.lang.Boolean getCreatable()

Gets creatable flag from this particular pool type. It informs the UI whether or not this pool type can be created from the UI. This is currently not supported by third party IPAMProvider implementations.

Returns:

whether or not this pool type can be created directly from the Morpheus UI

setCreatable

public void setCreatable(java.lang.Boolean creatable)

Sets creatable flag from this particular pool type. It informs the UI whether or not this pool type can be created from the UI. This is currently not supported by third party IPAMProvider implementations.

Parameters:

creatable - whether or not this pool type can be created directly from the Morpheus UI