com.netflix.fenzo

Interface VirtualMachineLease

All Known Implementing Classes:

VMLeaseObject

public interface VirtualMachineLease

A representation of a lease (resource offer). You describe each Mesos resource offer by means of an object that implements the VirtualMachineLease interface. You can get such an object by passing the Offer object that represents that Mesos offer (and that you received from Mesos) into the VMLeaseObject constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VirtualMachineLease.Range Describes a [beginning, end] range.

Method Summary

Modifier and Type	Method and Description
double	cpuCores() Get the number of cores (CPUs) on this host that are available for assigning.
double	diskMB() Get the amount of disk space, in MB, on this host that is avaialble for assigning.
java.util.Map<java.lang.String,org.apache.mesos.Protos.Attribute>	getAttributeMap() Get the map of Mesos attributes associated with this lease (offer).
java.lang.String	getId() Get the ID of the lease (offer ID).
org.apache.mesos.Protos.Offer	getOffer() Get the Mesos resource offer associated with this lease.
long	getOfferedTime() Get the time that this lease (offer) was obtained.
java.lang.Double	getScalarValue(java.lang.String name) Get the value of the scalar resource for the given name.
java.util.Map<java.lang.String,java.lang.Double>	getScalarValues() Get a map of all of the scalar resources with resource names as the key and resource value as the value.
java.lang.String	getVMID() Get the ID of the host (mesos slave ID).
java.lang.String	hostname() Get the name of the host offered in this lease.
double	memoryMB() Get the amount of memory, in MBs, on this host that is available for assigning.
double	networkMbps() Get the amount of network bandwidth, in Mbps, on this host that is available for assigning.
java.util.List<VirtualMachineLease.Range>	portRanges() Get the list of port ranges on this host that are available for assigning.

Method Detail

getId

java.lang.String getId()

Get the ID of the lease (offer ID).

Returns:

the lease ID

getOfferedTime

long getOfferedTime()

Get the time that this lease (offer) was obtained.

Returns:

the time when this lease was obtained, in mSecs since epoch

hostname

java.lang.String hostname()

Get the name of the host offered in this lease.

Returns:

the host name

getVMID

java.lang.String getVMID()

Get the ID of the host (mesos slave ID).

Returns:

the host ID

cpuCores

double cpuCores()

Get the number of cores (CPUs) on this host that are available for assigning.

Returns:

the number of CPUs

memoryMB

double memoryMB()

Get the amount of memory, in MBs, on this host that is available for assigning.

Returns:

the amount of memory, in MB

networkMbps

double networkMbps()

Get the amount of network bandwidth, in Mbps, on this host that is available for assigning.

Returns:

the network bandwidth, in Mbps

diskMB

double diskMB()

Get the amount of disk space, in MB, on this host that is avaialble for assigning.

Returns:

the amount of available disk space, in MB

portRanges

java.util.List<VirtualMachineLease.Range> portRanges()

Get the list of port ranges on this host that are available for assigning.

Returns:

a List of port ranges

getOffer

org.apache.mesos.Protos.Offer getOffer()

Get the Mesos resource offer associated with this lease.

Returns:

the Mesos resource offer

getAttributeMap

java.util.Map<java.lang.String,org.apache.mesos.Protos.Attribute> getAttributeMap()

Get the map of Mesos attributes associated with this lease (offer).

Returns:

a Map of attribute names to attribute values

getScalarValue

java.lang.Double getScalarValue(java.lang.String name)

Get the value of the scalar resource for the given name.

Parameters:

name - Name of the scalar resource.

Returns:

Value of the requested scalar resource if available, null otherwise.

getScalarValues

java.util.Map<java.lang.String,java.lang.Double> getScalarValues()

Get a map of all of the scalar resources with resource names as the key and resource value as the value. Although cpus, memory, networkMbps, and disk are scalar resources, Fenzo currently treats them separately. Use this scalar values collection to specify scalar resources other than those four.

Returns:

All of the scalar resources available.