A B C D E F G H I K L M N O P R S T V W

## A

ActiveMemberPredicate() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.ActiveMemberPredicate
AllocatedMachinePredicate() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.AllocatedMachinePredicate
ApiVersion - Class in com.elastisys.scale.cloudpool.api
  Constants for present and historical API versions.
ApiVersion() - Constructor for class com.elastisys.scale.cloudpool.api.ApiVersion
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.ActiveMemberPredicate
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.AllocatedMachinePredicate
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.EvictableMemberPredicate
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.InstanceHourStart
  Calculates the starting point of the machine's current hour.
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.MachineIdExtractor
  Extracts the id of a `Machine`.
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.MachineStateExtractor
  Extracts the state of a `Machine`.
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.MachineWithState
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.RemainingInstanceHourTime
  Calculates the remaining time (in seconds) of the machine's last started billing hour.
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.RequestAge
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.StartedMachinePredicate
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.ToShortMachineFormat
apply(Machine) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.ToShortMachineString
attachMachine(String) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
attachMachine(String) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Attaches an already running machine instance to the pool, growing the pool with a new member.
attachMachine(String) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Attaches an already running machine instance to the pool, growing the pool with a new member.
awaitingService() - Static method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a `MembershipStatus` that marks a machine as being non-functional (i.e.
AWS_AUTO_SCALING_GROUP - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders
AWS_EC2 - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders
AWS_SPOT - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders
AZURE - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders

## B

blessed() - Static method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a `MembershipStatus` that marks a machine as blessed (or a permanent pool member that cannot be evicted).
build() - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Creates a new `Machine` instance from the parameters passed thus far to the `Machine.Builder`.
builder() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Creates a `Machine.Builder` object for generating `Machine` instances.

## C

CITYCLOUD - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders
CloudPool - Interface in com.elastisys.scale.cloudpool.api
  A `CloudPool` is a management interface towards an elastic pool of machines for a particular cloud provider, handling communication with the cloud provider according to its API.
CloudPoolClient - Class in com.elastisys.scale.cloudpool.api.client
  A `CloudPool` REST API client.
CloudPoolClient(AuthenticatedHttpClient, String, int) - Constructor for class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
  Constructs a `CloudPoolClient` for a given `CloudPool` endpoint, using a given `AuthenticatedHttpClient` for communication.
CloudPoolException - Exception in com.elastisys.scale.cloudpool.api
  Thrown by a `CloudPool` to indicate an error condition.
CloudPoolException() - Constructor for exception com.elastisys.scale.cloudpool.api.CloudPoolException
  Constructs a new `CloudPoolException`.
CloudPoolException(String, Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.CloudPoolException
  Constructs a new `CloudPoolException`.
CloudPoolException(String) - Constructor for exception com.elastisys.scale.cloudpool.api.CloudPoolException
  Constructs a new `CloudPoolException`.
CloudPoolException(Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.CloudPoolException
  Constructs a new `CloudPoolException`.
CloudPoolHandler - Class in com.elastisys.scale.cloudpool.api.restapi
  Implements the cloud pool REST API, which is fully covered in the elastisys:scale cloud pool REST API documentation.
CloudPoolHandler(CloudPool) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
CloudPoolMetadata - Class in com.elastisys.scale.cloudpool.api.types
  Describes static properties about the cloud pool itself and the cloud it manages.
CloudPoolMetadata(String, List<String>) - Constructor for class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
  Creates a new instance describing the cloud pool and the cloud it manages.
CloudPoolOptions - Class in com.elastisys.scale.cloudpool.api.server
  Captures (command-line) options accepted by a `CloudPoolServer`.
CloudPoolOptions() - Constructor for class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
CloudPoolServer - Class in com.elastisys.scale.cloudpool.api.server
  Factory methods for creating a HTTPS server that publishes a REST API for a `CloudPool` instance.
CloudPoolServer() - Constructor for class com.elastisys.scale.cloudpool.api.server.CloudPoolServer
CloudPoolStatus - Class in com.elastisys.scale.cloudpool.api.types
  Represents an execution status for a `CloudPool`.
CloudPoolStatus(boolean, boolean) - Constructor for class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
  Creates a `CloudPoolStatus`.
cloudProvider(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  The name of the cloud provider that this `Machine` originates from.
CloudProviders - Class in com.elastisys.scale.cloudpool.api.types
  Enumeration of known cloud providers/platforms for which there are cloud pool implementations.
CloudProviders() - Constructor for class com.elastisys.scale.cloudpool.api.types.CloudProviders
com.elastisys.scale.cloudpool.api - package com.elastisys.scale.cloudpool.api
com.elastisys.scale.cloudpool.api.client - package com.elastisys.scale.cloudpool.api.client
com.elastisys.scale.cloudpool.api.restapi - package com.elastisys.scale.cloudpool.api.restapi
com.elastisys.scale.cloudpool.api.restapi.types - package com.elastisys.scale.cloudpool.api.restapi.types
com.elastisys.scale.cloudpool.api.server - package com.elastisys.scale.cloudpool.api.server
com.elastisys.scale.cloudpool.api.types - package com.elastisys.scale.cloudpool.api.types
config - Variable in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
ConfigHandler - Class in com.elastisys.scale.cloudpool.api.restapi
  A REST response handler that handles requests to get (`GET`) and set ( `POST`) the `CloudPool` configuration.
ConfigHandler(CloudPool, String) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Creates a `ConfigHandler` that will store set `CloudPool` configurations under a given storage directory with the `ConfigHandler.DEFAULT_CONFIG_FILE_NAME`.
ConfigHandler(CloudPool, String, String) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Creates a `ConfigHandler` that will store set `CloudPool` configurations under a given storage directory with a given file name.
configure(JsonObject) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
configure(JsonObject) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Updates the configuration for this `CloudPool`.
createServer(CloudPool, CloudPoolOptions) - Static method in class com.elastisys.scale.cloudpool.api.server.CloudPoolServer
  Creates a HTTPS server that serves REST API requests for a given `CloudPool`.

## D

DEFAULT_CONFIG_FILE_NAME - Static variable in class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Default file name (within the storage directory) in which `CloudPool` configuration is stored.
DEFAULT_STORAGE_DIR - Static variable in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
  The default directory where the `CloudPool` will store its runtime state.
defaultStatus() - Static method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a default `MembershipStatus` that marks a machine both active and evictable.
detachMachine(String, boolean) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
detachMachine(String, boolean) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Removes a member from the pool without terminating it.
detachMachine(String, DetachMachineRequest) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Removes a member from the pool without terminating it.
DetachMachineRequest - Class in com.elastisys.scale.cloudpool.api.restapi.types
  REST API request type that requests that a machine be detached from the machine pool.
DetachMachineRequest(boolean) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
disposable() - Static method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a `MembershipStatus` that marks a machine as being non-functional (i.e.

## E

emptyPool(DateTime) - Static method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Factory method for creating an empty machine pool.
enableExitHandler - Variable in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.Machine
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
equals(Object) - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
EvictableMemberPredicate() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.EvictableMemberPredicate

## F

fromJson(String) - Static method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Parses a JSON representation of a `MachinePool` to its Java counterpart.

## G

getActive() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
  The number of active machines in the pool `Machine.isActiveMember()`.
getActiveMachines() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns all active `Machine`s in the pool.
getAllocated() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
  Returns the number of allocated machines in the pool (see `Machine.isAllocated()`.
getAllocatedMachines() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns all allocated `Machine`s in the pool.
getCloudPoolConfigPath() - Method in class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Returns the file system path where the `ConfigHandler` stores received `CloudPool` configurations.
getCloudProvider() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns The name of the cloud provider that this machine originates from, for example `AWS-EC2`.
getConfig() - Method in class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Retrieves the configuration currently set for the `CloudPool`.
getConfiguration() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
getConfiguration() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Returns the configuration currently set for this `CloudPool`, if one has been set.
getDesiredSize() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
getDesiredSize() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
  Returns the desired size of the machine pool.
getId() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the identifier of the `Machine`.
getLaunchTime() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the launch time of the `Machine` if it has been launched.
getMachinePool() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
getMachinePool() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Returns a list of the members of the cloud pool.
getMachines() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns all `Machine`s in the pool.
getMachineSize() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Return the size (or type) of the `Machine`.
getMachineState() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the execution state of the `Machine`.
getMembershipStatus() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
getMembershipStatus() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the pool membership status of this `Machine`.
getMetadata() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
getMetadata() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
getMetadata() - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Returns metadata about the cloud pool and the cloud infrastructure it manages.
getMetadata() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns any additional cloud provider-specific meta data about the `Machine` if set, otherwise `null`.
getPool() - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Retrieves the current machine pool members.
getPoolSize() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
getPoolSize() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Returns the current size of the `MachinePool` -- both in terms of the desired size and the actual size (as these may differ at any time).
getPoolSize() - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Returns the current size of the machine pool -- both in terms of the desired size and the actual size (as these may differ at any time).
getPrivateIps() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the list of private IP addresses associated with this `Machine`.
getProtocolName() - Method in enum com.elastisys.scale.cloudpool.api.Protocol
  The protocol name to use in URIs.
getPublicIps() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the list of public IP addresses associated with this `Machine`.
getRegion() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the name of the cloud region/zone/data center where this machine is located.
getRequestTime() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the request time of the `Machine`.
getServiceState() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
getServiceState() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns the service state of the `Machine`.
getStartedMachines() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns all started `Machine`s in the pool.
getStatus() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
getStatus() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Returns the execution status for the `CloudPool`.
getStatus() - Method in class com.elastisys.scale.cloudpool.api.restapi.StartStopHandler
  Retrieves the execution status for the cloud pool.
getTimestamp() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns the time at which the pool observation was made.
getTimestamp() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
  Returns the time at which the pool size observation was made.
getVersion() - Method in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions

## H

hashCode() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
hashCode() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
hashCode() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
hashCode() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
hashCode() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
hashCode() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary

## I

id(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the identifier for the `Machine` being built.
instanceHourStart() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Function` that given a `Machine` (with a launch time set) returns the starting point of the `Machine`'s most recently started hour.
InstanceHourStart() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.InstanceHourStart
inState(MachineState) - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Predicate` that returns `true` when passed a `Machine` in a given `MachineState`.
isActive() - Method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Indicates if this is an active (working) `MachinePool` member.
isActiveMember() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Predicate` that returns `true` when passed a `Machine` that is an active pool member -- it has been allocated from the underlying infrastructure (`MachineState.REQUESTED`, `MachineState.PENDING` or `MachineState.RUNNING`) and is an active pool member (`MembershipStatus.isActive()`).
isAllocated() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Predicate` that returns `true` when passed a `Machine` that has been allocated from the underlying infrastructure (machine state `MachineState.REQUESTED`, `MachineState.PENDING` or `MachineState.RUNNING`).
isConfigured() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
  Indicates if the `CloudPool` is configured.
isDecrementDesiredSize() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
  Indicates if the desired size of the group should be decremented after terminating the machine.
isDecrementDesiredSize() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
  Indicates if the desired size of the group should be decremented after terminating the machine.
isEvictable() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Predicate` that returns `true` for any `Machine` with an evictable `MembershipStatus`.
isEvictable() - Method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Indicates if this `Machine` is a blessed member of the `MachinePool`.
isStarted() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
  Indicates if the `CloudPool` is in a started state.
isStarted() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  A `Predicate` that returns `true` when passed a `Machine` that has been started by the underlying infrastructure (machine state is `MachineState.PENDING` or `MachineState.RUNNING`).

## K

KUBERNETES - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders

## L

LATEST - Static variable in class com.elastisys.scale.cloudpool.api.ApiVersion
  The latest API version.
launchTime(DateTime) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the launchTime for the `Machine` being built.

## M

Machine - Class in com.elastisys.scale.cloudpool.api.types
  Represents a machine that is a member of a `MachinePool` managed by a `CloudPool`.
Machine(String, MachineState, MembershipStatus, ServiceState, String, String, String, DateTime, DateTime, List<String>, List<String>, JsonElement) - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine
  Constructs a new `Machine`.
Machine.ActiveMemberPredicate - Class in com.elastisys.scale.cloudpool.api.types
  A `Predicate` that returns `true` when passed a `Machine` that is an active pool member -- it has been allocated from the underlying infrastructure (`MachineState.REQUESTED`, `MachineState.PENDING` or `MachineState.RUNNING`) and is an active pool member (`MembershipStatus.isActive()`).
Machine.AllocatedMachinePredicate - Class in com.elastisys.scale.cloudpool.api.types
  A `Predicate` that returns `true` when passed a `Machine` that has been allocated from the underlying infrastructure (machine state `MachineState.REQUESTED`, `MachineState.PENDING` or `MachineState.RUNNING`).
Machine.Builder - Class in com.elastisys.scale.cloudpool.api.types
  A builder for creating `Machine` instances.
Machine.EvictableMemberPredicate - Class in com.elastisys.scale.cloudpool.api.types
  A `Predicate` that returns `true` when passed a `Machine` with an evictable `MembershipStatus`.
Machine.InstanceHourStart - Class in com.elastisys.scale.cloudpool.api.types
  A `Function` that for a given `Machine` calculates when the started its most recent hour.
Machine.MachineIdExtractor - Class in com.elastisys.scale.cloudpool.api.types
  A transformation `Function` that when applied to a `Machine` extracts the `Machine`'s id.
Machine.MachineStateExtractor - Class in com.elastisys.scale.cloudpool.api.types
  A transformation `Function` that when applied to a `Machine` extracts the `Machine`'s state.
Machine.MachineWithState - Class in com.elastisys.scale.cloudpool.api.types
  A `Predicate` that returns `true` when passed a `Machine` in a given `MachineState`.
Machine.RemainingInstanceHourTime - Class in com.elastisys.scale.cloudpool.api.types
  A `Function` that for a given `Machine` calculates the remaining time (in seconds) of the machine's current hour.
Machine.RequestAge - Class in com.elastisys.scale.cloudpool.api.types
  A `Function` that optionally returns the number of milliseconds of how long ago the request to start a given `Machine` was made.
Machine.StartedMachinePredicate - Class in com.elastisys.scale.cloudpool.api.types
  A `Predicate` that returns `true` when passed a `Machine` that has been started by the underlying infrastructure (machine state is `MachineState.PENDING` or `MachineState.RUNNING`).
Machine.ToShortMachineFormat - Class in com.elastisys.scale.cloudpool.api.types
  A `Function` that, for a given `Machine`, returns a clone of the `Machine` that excludes the meta data field of the original `Machine`.
Machine.ToShortMachineString - Class in com.elastisys.scale.cloudpool.api.types
  A `Function` that, for a given `Machine`, returns a string representation that excludes any `Machine` meta data (which can produce quite some log noise).
MachineIdExtractor() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.MachineIdExtractor
MachinePool - Class in com.elastisys.scale.cloudpool.api.types
  Represents a snapshot of the machine pool managed by a `CloudPool`.
MachinePool(List<? extends Machine>, DateTime) - Constructor for class com.elastisys.scale.cloudpool.api.types.MachinePool
  Constructs a new `MachinePool` snapshot.
machineSize(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  The size (or type) of the `Machine`.
machineState(MachineState) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the `MachineState` for the `Machine` being built.
MachineState - Enum in com.elastisys.scale.cloudpool.api.types
  The range of permissible execution states for a `Machine` in a `MachinePool`.
MachineStateExtractor() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.MachineStateExtractor
MachineWithState(MachineState) - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.MachineWithState
main(CloudPool, String[]) - Static method in class com.elastisys.scale.cloudpool.api.server.CloudPoolServer
  Parse command-line arguments and start an HTTPS server that serves REST API requests for a given `CloudPool`.
membershipStatus(MembershipStatus) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the `MembershipStatus` for the `Machine` being built.
MembershipStatus - Class in com.elastisys.scale.cloudpool.api.types
  The pool membership status indicates if a `Machine` needs to be given special treatment.
MembershipStatus() - Constructor for class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a default `MembershipStatus` that marks a machine both active and evictable.
MembershipStatus(boolean, boolean) - Constructor for class com.elastisys.scale.cloudpool.api.types.MembershipStatus
  Creates a `MembershipStatus` for a machine.
metadata(JsonElement) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the meta data for the `Machine` being built.

## N

NotConfiguredException - Exception in com.elastisys.scale.cloudpool.api
  Thrown by a `CloudPool` to indicate that an operation failed due to the `CloudPool` not being configured.
NotConfiguredException() - Constructor for exception com.elastisys.scale.cloudpool.api.NotConfiguredException
  Constructs a new `NotConfiguredException`.
NotConfiguredException(String, Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotConfiguredException
  Constructs a new `NotConfiguredException`.
NotConfiguredException(String) - Constructor for exception com.elastisys.scale.cloudpool.api.NotConfiguredException
  Constructs a new `NotConfiguredException`.
NotConfiguredException(Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotConfiguredException
  Constructs a new `NotConfiguredException`.
NotFoundException - Exception in com.elastisys.scale.cloudpool.api
  Thrown by a `CloudPool` to indicate that a requested resource (such as a machine pool member) could not be found.
NotFoundException() - Constructor for exception com.elastisys.scale.cloudpool.api.NotFoundException
  Constructs a new `NotFoundException`.
NotFoundException(String, Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotFoundException
  Constructs a new `NotFoundException`.
NotFoundException(String) - Constructor for exception com.elastisys.scale.cloudpool.api.NotFoundException
  Constructs a new `NotFoundException`.
NotFoundException(Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotFoundException
  Constructs a new `NotFoundException`.
NotStartedException - Exception in com.elastisys.scale.cloudpool.api
  Thrown by a `CloudPool` to indicate that a request won't be serviced due to the `CloudPool` being in a stopped state.
NotStartedException() - Constructor for exception com.elastisys.scale.cloudpool.api.NotStartedException
  Constructs a new `NotStartedException`.
NotStartedException(String, Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotStartedException
  Constructs a new `NotStartedException`.
NotStartedException(String) - Constructor for exception com.elastisys.scale.cloudpool.api.NotStartedException
  Constructs a new `NotStartedException`.
NotStartedException(Throwable) - Constructor for exception com.elastisys.scale.cloudpool.api.NotStartedException
  Constructs a new `NotStartedException`.

## O

OPENSTACK - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders

## P

parseArgs(String[]) - Static method in class com.elastisys.scale.cloudpool.api.server.CloudPoolServer
  Parses command-line arguments into `CloudPoolOptions`.
poolIdentifier() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
  An identifier for the cloud that this cloud pool manages.
PoolSizeSummary - Class in com.elastisys.scale.cloudpool.api.types
  Response message of the `CloudPool.getPoolSize()` operation that returns information about the pool size -- both desired and actual size.
PoolSizeSummary(int, int, int) - Constructor for class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
PoolSizeSummary(DateTime, int, int, int) - Constructor for class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary
privateIp(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Adds a single private IP address for the `Machine` being built.
privateIps(Collection<String>) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Adds several private IP address for the `Machine` being built.
Protocol - Enum in com.elastisys.scale.cloudpool.api
  Supported cloud pool protocols.
publicIp(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Adds a single public IP address for the `Machine` being built.
publicIps(Collection<String>) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Adds several public IP address for the `Machine` being built.

## R

region(String) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  The name of the cloud region/zone/data center where this machine is located.
remainingInstanceHourTime() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a `Function` that given a `Machine` returns the remaining time (in seconds) to the start of its next hour.
RemainingInstanceHourTime() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.RemainingInstanceHourTime
requestAge(DateTime) - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Optionally returns how many milliseconds ago a request was made.
RequestAge(DateTime) - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.RequestAge
  Creates a new instance that sets the current time to a particular value.
requestTime(DateTime) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the requestTime for the `Machine` being built.

## S

serviceState(ServiceState) - Method in class com.elastisys.scale.cloudpool.api.types.Machine.Builder
  Sets the `ServiceState` for the `Machine` being built.
ServiceState - Enum in com.elastisys.scale.cloudpool.api.types
  The range of permissible service states that a `Machine` can take on.
setAndStoreConfig(JsonObject) - Method in class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Sets the configuration for the `CloudPool`.
setDecrementDesiredSize(boolean) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
  Set to `true` if the desired size of the group should be decremented after terminating the machine.
setDecrementDesiredSize(boolean) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
  Set to `true` if the desired size of the group should be decremented after terminating the machine.
setDesiredSize(int) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
setDesiredSize(int) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Sets the desired number of machines in the machine pool.
setDesiredSize(SetDesiredSizeRequest) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Sets the desired number of machines in the machine pool.
setDesiredSize(int) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
SetDesiredSizeRequest - Class in com.elastisys.scale.cloudpool.api.restapi.types
  REST API request type that requests a certain desired size of the machine pool.
SetDesiredSizeRequest(int) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
setMachineState(MachineState) - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Sets the execution state of the `Machine`.
setMembershipStatus(String, MembershipStatus) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
setMembershipStatus(String, MembershipStatus) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Sets the membership status of a given pool member.
setMembershipStatus(String, SetMembershipStatusRequest) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
setMembershipStatus(MembershipStatus) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
SetMembershipStatusRequest - Class in com.elastisys.scale.cloudpool.api.restapi.types
  REST API request type that requests a certain membership status be set for a machine in the pool.
SetMembershipStatusRequest(MembershipStatus) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
setServiceState(String, ServiceState) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
setServiceState(String, ServiceState) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Sets the service state of a given machine pool member.
setServiceState(String, SetServiceStateRequest) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Sets the service state of a given machine pool member.
setServiceState(ServiceState) - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
SetServiceStateRequest - Class in com.elastisys.scale.cloudpool.api.restapi.types
  REST API request type that requests a certain service state be set for a machine in the pool.
SetServiceStateRequest(ServiceState) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
sort(Collection<Machine>, Comparator<Machine>) - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Sorts a collection of `Machine`s according to the order prescribed by a certain `Comparator`.
SPLITTER - Static variable in class com.elastisys.scale.cloudpool.api.types.CloudProviders
start() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
start() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Starts the `CloudPool`.
start() - Method in class com.elastisys.scale.cloudpool.api.restapi.StartStopHandler
  Starts the cloud pool.
StartedMachinePredicate() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.StartedMachinePredicate
StartStopHandler - Class in com.elastisys.scale.cloudpool.api.restapi
  A REST response handler that handles requests to start `POST /start`, stop `POST /stop`, and get the execution status of `GET /status` a `CloudPool`.
StartStopHandler(CloudPool) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.StartStopHandler
  Creates a `StartStopHandler` for a given `CloudPool`.
stop() - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
stop() - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Stops the `CloudPool`.
stop() - Method in class com.elastisys.scale.cloudpool.api.restapi.StartStopHandler
  Stops the cloud pool.
stopped - Variable in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
storageDir - Variable in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
storeConfig(JsonObject) - Method in class com.elastisys.scale.cloudpool.api.restapi.ConfigHandler
  Stores a configuration in the `ConfigHandler.storageDir`, to allow it to be restored when the `CloudPool` is restarted.
supportedApiVersions() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
  A list of supported API versions.

## T

terminateMachine(String, boolean) - Method in class com.elastisys.scale.cloudpool.api.client.CloudPoolClient
terminateMachine(String, boolean) - Method in interface com.elastisys.scale.cloudpool.api.CloudPool
  Terminates a particular machine pool member.
terminateMachine(String, TerminateMachineRequest) - Method in class com.elastisys.scale.cloudpool.api.restapi.CloudPoolHandler
  Terminates a particular machine pool member.
TerminateMachineRequest - Class in com.elastisys.scale.cloudpool.api.restapi.types
  REST API request type that requests that a machine be terminated.
TerminateMachineRequest(boolean) - Constructor for class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
toId() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a transformation `Function` that given a `Machine` extracts its identifier.
toJson() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
  Returns the JSON representation for this `MachinePool`.
toShortFormat() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Factory method for the `Machine.ToShortMachineFormat` `Function`.
ToShortMachineFormat() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.ToShortMachineFormat
ToShortMachineString() - Constructor for class com.elastisys.scale.cloudpool.api.types.Machine.ToShortMachineString
toShortString() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Factory method for the `Machine.ToShortMachineString` `Function`.
toState() - Static method in class com.elastisys.scale.cloudpool.api.types.Machine
  Returns a transformation `Function` that given a `Machine` extracts its `MachineState`.
toString() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.DetachMachineRequest
toString() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetDesiredSizeRequest
toString() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetMembershipStatusRequest
toString() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.SetServiceStateRequest
toString() - Method in class com.elastisys.scale.cloudpool.api.restapi.types.TerminateMachineRequest
toString() - Method in class com.elastisys.scale.cloudpool.api.server.CloudPoolOptions
toString() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolMetadata
toString() - Method in class com.elastisys.scale.cloudpool.api.types.CloudPoolStatus
toString() - Method in class com.elastisys.scale.cloudpool.api.types.Machine
toString() - Method in class com.elastisys.scale.cloudpool.api.types.MachinePool
toString() - Method in class com.elastisys.scale.cloudpool.api.types.MembershipStatus
toString() - Method in class com.elastisys.scale.cloudpool.api.types.PoolSizeSummary

## V

V1 - Static variable in class com.elastisys.scale.cloudpool.api.ApiVersion
V2 - Static variable in class com.elastisys.scale.cloudpool.api.ApiVersion
V3 - Static variable in class com.elastisys.scale.cloudpool.api.ApiVersion
V4 - Static variable in class com.elastisys.scale.cloudpool.api.ApiVersion
valueOf(String) - Static method in enum com.elastisys.scale.cloudpool.api.Protocol
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.elastisys.scale.cloudpool.api.types.MachineState
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.elastisys.scale.cloudpool.api.types.ServiceState
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.elastisys.scale.cloudpool.api.Protocol
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.elastisys.scale.cloudpool.api.types.MachineState
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.elastisys.scale.cloudpool.api.types.ServiceState
  Returns an array containing the constants of this enum type, in the order they are declared.

## W

withMetadata(JsonObject) - Method in class com.elastisys.scale.cloudpool.api.types.Machine
  Creates a copy of this `Machine` with a different value for the metadata field.

A B C D E F G H I K L M N O P R S T V W