org.mozilla.taskcluster.client.awsprovisioner

Class GetWorkerTypeRequest

java.lang.Object

org.mozilla.taskcluster.client.awsprovisioner.GetWorkerTypeRequest

public class GetWorkerTypeRequest
extends Object

A worker launchSpecification and required metadata

See http://schemas.taskcluster.net/aws-provisioner/v1/get-worker-type-response.json#

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GetWorkerTypeRequest.InstanceTypes
class	GetWorkerTypeRequest.Regions

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canUseOndemand True if this worker type is allowed on demand instances.
boolean	canUseSpot True if this worker type is allowed spot instances.
GetWorkerTypeRequest.InstanceTypes[]	instanceTypes
Date	lastModified ISO Date string (e.g.
Object	launchSpec Launch Specification entries which are used in all regions and all instance types
int	maxCapacity Maximum number of capacity units to be provisioned.
int	maxPrice Maximum price we’ll pay.
int	minCapacity Minimum number of capacity units to be provisioned.
int	minPrice Minimum price to pay for an instance.
GetWorkerTypeRequest.Regions[]	regions
int	scalingRatio A scaling ratio of 0.2 means that the provisioner will attempt to keep the number of pending tasks around 20% of the provisioned capacity.
String[]	scopes Scopes to issue credentials to for all regions.
Object	secrets Static secrets entries which are used in all regions and all instance types
Object	userData UserData entries which are used in all regions and all instance types
String	workerType The ID of the workerType

Constructor Summary

Constructors

Constructor and Description
GetWorkerTypeRequest()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

canUseOndemand

public boolean canUseOndemand

True if this worker type is allowed on demand instances. Currently ignored

canUseSpot

public boolean canUseSpot

True if this worker type is allowed spot instances. Currently ignored as all instances are Spot

instanceTypes

public GetWorkerTypeRequest.InstanceTypes[] instanceTypes

lastModified

public Date lastModified

ISO Date string (e.g. new Date().toISOString()) which represents the time when this worker type definition was last altered (inclusive of creation)

launchSpec

public Object launchSpec

Launch Specification entries which are used in all regions and all instance types

maxCapacity

public int maxCapacity

Maximum number of capacity units to be provisioned.

maxPrice

public int maxPrice

Maximum price we’ll pay. Like minPrice, this takes into account the utility factor when figuring out what the actual SpotPrice submitted to Amazon will be

minCapacity

public int minCapacity

Minimum number of capacity units to be provisioned. A capacity unit is an abstract unit of capacity, where one capacity unit is roughly one task which should be taken off the queue

minPrice

public int minPrice

Minimum price to pay for an instance. A Price is considered to be the Amazon Spot Price multiplied by the utility factor of the InstantType as specified in the instanceTypes list. For example, if the minPrice is set to $0.5 and the utility factor is 2, the actual minimum bid used will be $0.25

regions

public GetWorkerTypeRequest.Regions[] regions

scalingRatio

public int scalingRatio

A scaling ratio of 0.2 means that the provisioner will attempt to keep the number of pending tasks around 20% of the provisioned capacity. This results in pending tasks waiting 20% of the average task execution time before starting to run. A higher scaling ratio often results in better utilization and longer waiting times. For workerTypes running long tasks a short scaling ratio may be prefered, but for workerTypes running quick tasks a higher scaling ratio may increase utilization without major delays. If using a scaling ratio of 0, the provisioner will attempt to keep the capacity of pending spot requests equal to the number of pending tasks.

scopes

public String[] scopes

Scopes to issue credentials to for all regions. Scopes must be composed of printable ASCII characters and spaces.

secrets

public Object secrets

Static secrets entries which are used in all regions and all instance types

userData

public Object userData

UserData entries which are used in all regions and all instance types

workerType

public String workerType

The ID of the workerType

Constructor Detail

GetWorkerTypeRequest

public GetWorkerTypeRequest()