Package com.yahoo.config.provision

Class NodeResources

java.lang.Object

com.yahoo.config.provision.NodeResources

public class NodeResources
extends Object

The node resources required by an application cluster

Author:

bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NodeResources.Architecture
static enum	NodeResources.DiskSpeed
static final record	NodeResources.GpuResources
static enum	NodeResources.GpuType
static enum	NodeResources.StorageType

Constructor Summary

Constructors

Constructor	Description
NodeResources(double vcpu, double memoryGiB, double diskGb, double bandwidthGbps)
NodeResources(double vcpu, double memoryGiB, double diskGb, double bandwidthGbps, NodeResources.DiskSpeed diskSpeed)
NodeResources(double vcpu, double memoryGiB, double diskGb, double bandwidthGbps, NodeResources.DiskSpeed diskSpeed, NodeResources.StorageType storageType)
NodeResources(double vcpu, double memoryGiB, double diskGb, double bandwidthGbps, NodeResources.DiskSpeed diskSpeed, NodeResources.StorageType storageType, NodeResources.Architecture architecture)
NodeResources(double vcpu, double memoryGiB, double diskGb, double bandwidthGbps, NodeResources.DiskSpeed diskSpeed, NodeResources.StorageType storageType, NodeResources.Architecture architecture, NodeResources.GpuResources gpuResources)

Method Summary

Modifier and Type	Method	Description
NodeResources	add(NodeResources other)
NodeResources.Architecture	architecture()
Optional<NodeResources>	asOptional()	Returns this.isUnspecified() ?
double	bandwidthGbps()
boolean	bandwidthGbpsIsUnspecified()
boolean	compatibleWith(NodeResources requested)	Returns true if all the resources of this are the same as or compatible with the requested resources: - Equal numbers only where request implies it (i.e not for disk if storage is any/remote, and not for bandwidth where we don't enforce constraints), - Compatible non-numbers.
double	cost()	Returns the standard cost of these resources, in dollars per hour
double	diskGb()
boolean	diskIsUnspecified()
NodeResources.DiskSpeed	diskSpeed()
double	distanceTo(NodeResources other)
boolean	equals(Object o)
boolean	equalsWhereSpecified(NodeResources other)	Returns true if all the resources of this are the same as or compatible with the given resources: - Equal numbers
NodeResources.GpuResources	gpuResources()
int	hashCode()
boolean	isUnspecified()
boolean	isZero()
NodeResources	justNonNumbers()	Returns this with all numbers set to 0
NodeResources	justNumbers()	Returns this with disk speed, storage type and architecture set to any
double	memoryGiB()
boolean	memoryIsUnspecified()
NodeResources	multipliedBy(double factor)
boolean	satisfies(NodeResources other)	Returns true if all the resources of this are the same or larger than the given resources
NodeResources.StorageType	storageType()
NodeResources	subtract(NodeResources other)
String	toString()
static NodeResources	unspecified()
double	vcpu()
boolean	vcpuIsUnspecified()
NodeResources	with(NodeResources.Architecture architecture)
NodeResources	with(NodeResources.DiskSpeed diskSpeed)
NodeResources	with(NodeResources.GpuResources gpuResources)
NodeResources	with(NodeResources.StorageType storageType)
NodeResources	withBandwidthGbps(double bandwidthGbps)
NodeResources	withDiskGb(double diskGb)
NodeResources	withMemoryGiB(double memoryGiB)
NodeResources	withUnspecifiedFieldsFrom(NodeResources fullySpecified)
NodeResources	withVcpu(double vcpu)
static NodeResources	zero()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NodeResources

public NodeResources(double vcpu,
 double memoryGiB,
 double diskGb,
 double bandwidthGbps)

NodeResources

public NodeResources(double vcpu,
 double memoryGiB,
 double diskGb,
 double bandwidthGbps,
 NodeResources.DiskSpeed diskSpeed)

NodeResources

public NodeResources(double vcpu,
 double memoryGiB,
 double diskGb,
 double bandwidthGbps,
 NodeResources.DiskSpeed diskSpeed,
 NodeResources.StorageType storageType)

NodeResources

public NodeResources(double vcpu,
 double memoryGiB,
 double diskGb,
 double bandwidthGbps,
 NodeResources.DiskSpeed diskSpeed,
 NodeResources.StorageType storageType,
 NodeResources.Architecture architecture)

NodeResources

public NodeResources(double vcpu,
 double memoryGiB,
 double diskGb,
 double bandwidthGbps,
 NodeResources.DiskSpeed diskSpeed,
 NodeResources.StorageType storageType,
 NodeResources.Architecture architecture,
 NodeResources.GpuResources gpuResources)

Method Details

vcpu

public double vcpu()

memoryGiB

public double memoryGiB()

diskGb

public double diskGb()

bandwidthGbps

public double bandwidthGbps()

diskSpeed

public NodeResources.DiskSpeed diskSpeed()

storageType

public NodeResources.StorageType storageType()

architecture

public NodeResources.Architecture architecture()

gpuResources

public NodeResources.GpuResources gpuResources()

vcpuIsUnspecified

public boolean vcpuIsUnspecified()

memoryIsUnspecified

public boolean memoryIsUnspecified()

diskIsUnspecified

public boolean diskIsUnspecified()

bandwidthGbpsIsUnspecified

public boolean bandwidthGbpsIsUnspecified()

cost

public double cost()

Returns the standard cost of these resources, in dollars per hour

withVcpu

public NodeResources withVcpu(double vcpu)

withMemoryGiB

public NodeResources withMemoryGiB(double memoryGiB)

withDiskGb

public NodeResources withDiskGb(double diskGb)

withBandwidthGbps

public NodeResources withBandwidthGbps(double bandwidthGbps)

with

public NodeResources with(NodeResources.DiskSpeed diskSpeed)

with

public NodeResources with(NodeResources.StorageType storageType)

with

public NodeResources with(NodeResources.Architecture architecture)

with

public NodeResources with(NodeResources.GpuResources gpuResources)

withUnspecifiedFieldsFrom

public NodeResources withUnspecifiedFieldsFrom(NodeResources fullySpecified)

justNumbers

public NodeResources justNumbers()

Returns this with disk speed, storage type and architecture set to any

justNonNumbers

public NodeResources justNonNumbers()

Returns this with all numbers set to 0

subtract

public NodeResources subtract(NodeResources other)

add

public NodeResources add(NodeResources other)

multipliedBy

public NodeResources multipliedBy(double factor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

satisfies

public boolean satisfies(NodeResources other)

Returns true if all the resources of this are the same or larger than the given resources

compatibleWith

public boolean compatibleWith(NodeResources requested)

Returns true if all the resources of this are the same as or compatible with the requested resources: - Equal numbers only where request implies it (i.e not for disk if storage is any/remote, and not for bandwidth where we don't enforce constraints), - Compatible non-numbers.

equalsWhereSpecified

public boolean equalsWhereSpecified(NodeResources other)

Returns true if all the resources of this are the same as or compatible with the given resources: - Equal numbers. - Compatible non-numbers.

unspecified

public static NodeResources unspecified()

isUnspecified

public boolean isUnspecified()

distanceTo

public double distanceTo(NodeResources other)

asOptional

public Optional<NodeResources> asOptional()

Returns this.isUnspecified() ? Optional.empty() : Optional.of(this)

isZero

public boolean isZero()

zero

public static NodeResources zero()