io.jenkins.plugins.aws.lambda.cloud

Class LambdaCloud

java.lang.Object

hudson.model.AbstractModelObject

hudson.slaves.Cloud

io.jenkins.plugins.aws.lambda.cloud.LambdaCloud

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.slaves.Cloud>, hudson.model.ModelObject, hudson.search.SearchableModelObject, hudson.search.SearchItem, hudson.security.AccessControlled

public class LambdaCloud
extends hudson.slaves.Cloud

This is the root class that contains all configuration state about the Lambda cloud agents. Jenkins calls provision(Label label, int excessWorkload) on this class to create new nodes.

Author:

jlamande

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LambdaCloud.LambdaCloudDescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.slaves.Cloud

ALL, name, PROVISION

Constructor Summary

Constructors

Constructor and Description
LambdaCloud(String name, String credentialsId, String region) Constructor for LambdaCloud.

Method Summary

Modifier and Type	Method and Description
boolean	canProvision(hudson.model.Label label)
int	getAgentTimeout() Getter for the field agentTimeout.
static LambdaCloud	getByName(String name)
com.amazonaws.services.lambda.AWSLambda	getClient() Getter for the field client.
static int	getDefaultAgentTimeout()
static String	getDefaultRegion()
List<LambdaFunction>	getFunctions()
String	getJenkinsUrl() Getter for the field jenkinsUrl.
int	getMaxConcurrentExecutions() Getter for the field maxConcurrentExecutions.
String	getRegion() Getter for the field region.
Collection<hudson.slaves.NodeProvisioner.PlannedNode>	provision(hudson.model.Label label, int excessWorkload)
void	setAgentTimeout(int agentTimeout) Setter for the field agentTimeout.
void	setFunctions(List<LambdaFunction> functions)
void	setJenkinsUrl(String jenkinsUrl) Setter for the field jenkinsUrl.
void	setMaxConcurrentExecutions(int maxConcurrentExecutions) Setter for the field maxConcurrentExecutions.
String	toString()

Methods inherited from class hudson.slaves.Cloud

all, checkPermission, getACL, getDescriptor, getDisplayName, getSearchUrl, hasPermission

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Detail

LambdaCloud

@DataBoundConstructor
public LambdaCloud(@Nonnull
                                         String name,
                                         @Nullable
                                         String credentialsId,
                                         @Nonnull
                                         String region)
                                  throws InterruptedException

Constructor for LambdaCloud.

Parameters:

name - the name of the cloud or null if you want it auto-generated.

credentialsId - the credentials ID to use or null/empty if pulled from environment.

region - the AWS region to use.

Throws:

InterruptedException - if any.

Method Detail

getByName

@Nonnull
public static LambdaCloud getByName(@Nonnull
                                             String name)
                                      throws IllegalArgumentException

Throws:

IllegalArgumentException

toString

public String toString()

Overrides:

toString in class Object

getDefaultRegion

public static String getDefaultRegion()

getDefaultAgentTimeout

public static int getDefaultAgentTimeout()

getRegion

@Nonnull
public String getRegion()

Getter for the field region.

Returns:

a String object.

getJenkinsUrl

@Nonnull
public String getJenkinsUrl()

Getter for the field jenkinsUrl.

Returns:

a String object.

setJenkinsUrl

@DataBoundSetter
public void setJenkinsUrl(String jenkinsUrl)

Setter for the field jenkinsUrl.

Parameters:

jenkinsUrl - a String object.

getAgentTimeout

@Nonnull
public int getAgentTimeout()

Getter for the field agentTimeout.

Returns:

a int.

setAgentTimeout

@DataBoundSetter
public void setAgentTimeout(int agentTimeout)

Setter for the field agentTimeout.

Parameters:

agentTimeout - a int.

getMaxConcurrentExecutions

@Nonnull
public int getMaxConcurrentExecutions()

Getter for the field maxConcurrentExecutions.

Returns:

a int.

setMaxConcurrentExecutions

@DataBoundSetter
public void setMaxConcurrentExecutions(int maxConcurrentExecutions)

Setter for the field maxConcurrentExecutions.

Parameters:

maxConcurrentExecutions - a int.

getFunctions

@Nonnull
public List<LambdaFunction> getFunctions()

setFunctions

@DataBoundSetter
public void setFunctions(List<LambdaFunction> functions)

getClient

public com.amazonaws.services.lambda.AWSLambda getClient()

Getter for the field client.

Returns:

a AWSLambda object.

canProvision

public boolean canProvision(hudson.model.Label label)

Specified by:

canProvision in class hudson.slaves.Cloud

provision

public Collection<hudson.slaves.NodeProvisioner.PlannedNode> provision(hudson.model.Label label,
                                                                       int excessWorkload)

Specified by:

provision in class hudson.slaves.Cloud