Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AgentRecovery() - Constructor for class sh.createos.jenkins.sandbox.CreateOSCloud.AgentRecovery
B
- buildApiClient() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
-
Builds an authenticated API client from this cloud's configured Jenkins credential.
C
- canProvision(Cloud.CloudState) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- cloudName() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Returns the value of the
cloudNamerecord component. - createComputer() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
- CreateOSApiClient - Class in sh.createos.jenkins.sandbox
-
HTTP client for the CreateOS Sandbox control plane API.
- CreateOSApiClient(String, String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Creates a client for the given CreateOS API endpoint and API key.
- CreateOSApiClient.ExecResult - Record Class in sh.createos.jenkins.sandbox
-
Result from a CreateOS exec call.
- CreateOSApiClient.SandboxSummary - Record Class in sh.createos.jenkins.sandbox
-
Identity of one sandbox as the list endpoint reports it.
- CreateOSCloud - Class in sh.createos.jenkins.sandbox
-
Jenkins cloud implementation that provisions ephemeral CreateOS sandbox agents.
- CreateOSCloud(String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSCloud
-
Creates a cloud with the default CreateOS API endpoint and capacity.
- CreateOSCloud.AgentRecovery - Class in sh.createos.jenkins.sandbox
-
Runs
CreateOSCloud.recoverStaleAgents()once Jenkins has finished starting. - CreateOSCloud.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Exposes CreateOS cloud metadata, options, and validation to Jenkins.
- CreateOSComputer - Class in sh.createos.jenkins.sandbox
-
Tracks task lifecycle events for a CreateOS agent.
- CreateOSComputer(CreateOSSlave) - Constructor for class sh.createos.jenkins.sandbox.CreateOSComputer
-
Creates the Jenkins computer for a registered CreateOS agent node.
- CreateOSDeclarativeAgent - Class in sh.createos.jenkins.sandbox
-
Declarative Pipeline agent for CreateOS sandboxes.
- CreateOSDeclarativeAgent(String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
-
Creates a declarative CreateOS agent.
- CreateOSDeclarativeAgent.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Describes the CreateOS declarative Pipeline agent.
- CreateOSDiskAttachment - Class in sh.createos.jenkins.sandbox
-
User-facing CreateOS disk attachment configuration.
- CreateOSDiskAttachment(String, String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSDiskAttachment
-
Creates a disk attachment with the required disk id/name and mount path.
- CreateOSDiskAttachment.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Exposes disk attachment metadata and validation to Jenkins.
- CreateOSDownloadStep - Class in sh.createos.jenkins.sandbox
-
Pipeline step that downloads one file from the active CreateOS sandbox.
- CreateOSDownloadStep(String, String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSDownloadStep
-
Creates a download step from an absolute sandbox source to a workspace target.
- CreateOSDownloadStep.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Descriptor for the createosDownload Pipeline step.
- CreateOSLauncher - Class in sh.createos.jenkins.sandbox
-
Creates a CreateOS sandbox and launches a Jenkins agent inside it.
- CreateOSLauncher() - Constructor for class sh.createos.jenkins.sandbox.CreateOSLauncher
-
Creates a launcher that connects the inbound agent over WebSocket.
- CreateOSLaunchMethod - Class in sh.createos.jenkins.sandbox
-
How a CreateOS agent connects back to the controller.
- CreateOSLaunchMethod() - Constructor for class sh.createos.jenkins.sandbox.CreateOSLaunchMethod
- CreateOSLaunchMethod.CreateOSLaunchMethodDescriptor - Class in sh.createos.jenkins.sandbox
-
Base descriptor so the template form lists only CreateOS transports.
- CreateOSLaunchMethodDescriptor() - Constructor for class sh.createos.jenkins.sandbox.CreateOSLaunchMethod.CreateOSLaunchMethodDescriptor
- CreateOSPipelineSupport - Class in sh.createos.jenkins.sandbox
-
Helper methods called by the trusted declarative Pipeline agent script.
- CreateOSQueueListener - Class in sh.createos.jenkins.sandbox
-
Requests an immediate provisioning review when matching work becomes buildable.
- CreateOSQueueListener() - Constructor for class sh.createos.jenkins.sandbox.CreateOSQueueListener
- CreateOSSandboxContext - Record Class in sh.createos.jenkins.sandbox
-
Pipeline body context for exec-mode CreateOS steps.
- CreateOSSandboxContext(String, String) - Constructor for record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Creates an instance of a
CreateOSSandboxContextrecord class. - CreateOSSandboxRequest - Record Class in sh.createos.jenkins.sandbox
-
Immutable inputs for a CreateOS sandbox create request.
- CreateOSSandboxRequest(String, String, String, String, int, List<String>, List<CreateOSDiskAttachment>) - Constructor for record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Copies the collections so a caller cannot mutate a request after it is built.
- CreateOSSandboxStep - Class in sh.createos.jenkins.sandbox
-
Pipeline block step that creates a CreateOS sandbox for exec-mode child steps.
- CreateOSSandboxStep() - Constructor for class sh.createos.jenkins.sandbox.CreateOSSandboxStep
-
Creates a Pipeline step configured by databound setters.
- CreateOSSandboxStep.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Descriptor for the createosSandbox Pipeline step.
- CreateOSSandboxSweep - Class in sh.createos.jenkins.sandbox
-
Destroys sandboxes this controller created but no longer has an agent for.
- CreateOSSandboxSweep() - Constructor for class sh.createos.jenkins.sandbox.CreateOSSandboxSweep
-
Registers the sweep with Jenkins' periodic work scheduler.
- CreateOSShStep - Class in sh.createos.jenkins.sandbox
-
Pipeline step that runs a shell script inside the active CreateOS sandbox.
- CreateOSShStep(String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSShStep
-
Creates a shell step with the script to execute inside the sandbox.
- CreateOSShStep.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Descriptor for the createosSh Pipeline step.
- CreateOSSlave - Class in sh.createos.jenkins.sandbox
-
A one-executor Jenkins agent backed by an ephemeral CreateOS sandbox.
- CreateOSSlave(String, SandboxTemplate, CreateOSCloud) - Constructor for class sh.createos.jenkins.sandbox.CreateOSSlave
-
Creates an agent node from a sandbox template owned by the given cloud.
- CreateOSSlave.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Describes CreateOS agent nodes to Jenkins.
- CreateOSUploadStep - Class in sh.createos.jenkins.sandbox
-
Pipeline step that uploads workspace files into the active CreateOS sandbox.
- CreateOSUploadStep(String, String) - Constructor for class sh.createos.jenkins.sandbox.CreateOSUploadStep
-
Creates an upload step from a workspace source to an absolute sandbox target.
- CreateOSUploadStep.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Descriptor for the createosUpload Pipeline step.
- createSandbox(CreateOSSandboxRequest) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Create a new sandbox and return its ID.
D
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSCloud.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSDiskAttachment.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSDownloadStep.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSShStep.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSSlave.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.CreateOSUploadStep.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.InboundLaunchMethod.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.SandboxTemplate.DescriptorImpl
- DescriptorImpl() - Constructor for class sh.createos.jenkins.sandbox.SshLaunchMethod.DescriptorImpl
- destroySandbox(String) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Destroy a sandbox.
- diskMiB() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
diskMiBrecord component. - disks() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
disksrecord component. - doCheckApiUrl(String) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud.DescriptorImpl
-
Validates that the configured API endpoint uses TLS, except for local test servers.
- doCheckCredentialsId(String) - Method in class sh.createos.jenkins.sandbox.SshLaunchMethod.DescriptorImpl
-
Reports whether the public key can be derived from the selected credential.
- doCheckDiskMiB(int) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate.DescriptorImpl
-
Validates the optional root disk size override.
- doCheckIdleMinutes(int, boolean) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate.DescriptorImpl
-
Rejects an idle timeout that would delete an agent before it could take a build.
- doCheckMountPath(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment.DescriptorImpl
-
Validates that the mount path is absolute.
- doCheckSubPath(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment.DescriptorImpl
-
Validates that the optional sub-path stays within the disk prefix.
- doFillCredentialsIdItems() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud.DescriptorImpl
-
Returns the secret-text credentials available to Jenkins administrators.
- doFillCredentialsIdItems(String) - Method in class sh.createos.jenkins.sandbox.SshLaunchMethod.DescriptorImpl
-
Returns SSH credentials available to Jenkins administrators.
- doTestConnection(String, String) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud.DescriptorImpl
-
Tests the configured credential against the CreateOS API.
- downloadFile(String, String, OutputStream) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Downloads raw bytes from an absolute path inside the sandbox.
E
- equals(Object) - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Indicates whether some other object is "equal to" this one.
- ExecResult(int, String) - Constructor for record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Creates an instance of a
ExecResultrecord class. - execute(TaskListener) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxSweep
- exitCode() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Returns the value of the
exitCoderecord component.
F
- fromTemplate(SandboxTemplate, String) - Static method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Builds a sandbox create request that names the sandbox after the agent it will back.
G
- getApiUrl() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- getCloud() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getCloud() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getContainerCap() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- getCreateOSCloud() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
- getCredentialsId() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- getCredentialsId() - Method in class sh.createos.jenkins.sandbox.SshLaunchMethod
- getDescriptor() - Method in class sh.createos.jenkins.sandbox.CreateOSLauncher
- getDiskMiB() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getDiskMiB() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getDiskMiB() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getDisks() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getDisks() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getDisks() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.InboundLaunchMethod.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate.DescriptorImpl
- getDisplayName() - Method in class sh.createos.jenkins.sandbox.SshLaunchMethod.DescriptorImpl
- getExcludes() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep
- getExecSandboxCap() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- getFunctionName() - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep.DescriptorImpl
- getFunctionName() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- getFunctionName() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep.DescriptorImpl
- getFunctionName() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep.DescriptorImpl
- getId() - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment
- getIdleMinutes() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
-
0 means never idle out, which only a reused agent may do: a one-shot agent would leak.
- getInheritFrom() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getInheritFrom() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getInitialDelay() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxSweep
-
Gives resumed Pipelines time to restore their exec reservations before the first orphan sweep.
- getLabel() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getLauncher() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getMountPath() - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment
- getNetworkIdList() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
-
Returns configured private network ids or names as normalized request values.
- getNetworks() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getNetworks() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getNetworks() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getProvidedContext() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- getRecurrencePeriod() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxSweep
- getRegion() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getRegion() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getRegion() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getRemoteFs() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getRemoteFs() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getRemoteFs() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getRequiredContext() - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep.DescriptorImpl
- getRequiredContext() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- getRequiredContext() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep.DescriptorImpl
- getRequiredContext() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep.DescriptorImpl
- getRootfs() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getRootfs() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getRootfs() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getSandboxId() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
- getSandboxStatus(String) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Get the current status of a sandbox.
- getScript() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- getShape() - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- getShape() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- getShape() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- getSource() - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep
- getSource() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep
- getSubPath() - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment
- getTarget() - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep
- getTarget() - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep
- getTemplate() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
- getTemplates() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
H
- hashCode() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Returns a hash code value for this object.
- hashCode() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns a hash code value for this object.
I
- id() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Returns the value of the
idrecord component. - InboundLaunchMethod - Class in sh.createos.jenkins.sandbox
-
Agent connects back to the controller over the inbound WebSocket protocol.
- InboundLaunchMethod() - Constructor for class sh.createos.jenkins.sandbox.InboundLaunchMethod
-
Creates the inbound transport; it has nothing to configure.
- InboundLaunchMethod.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Exposes the inbound transport to the template form, first so it stays the default.
- isAllowPipelineOverrides() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- isDeleteOnRestart() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- isInstantiable() - Method in class sh.createos.jenkins.sandbox.CreateOSSlave.DescriptorImpl
- isReturnStatus() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- isReturnStdout() - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- isReuseAgent() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- isRunning(String) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Reports whether a sandbox is still running.
L
- launch(SlaveComputer, TaskListener) - Method in class sh.createos.jenkins.sandbox.CreateOSLauncher
- listSandboxes() - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Lists every sandbox visible to this API key.
N
- name() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Returns the value of the
namerecord component. - name() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
namerecord component. - networkIds() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
networkIdsrecord component. - newInstance(StaplerRequest2, JSONObject) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- newInstance(StaplerRequest2, JSONObject) - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep.DescriptorImpl
O
- onEnterBuildable(Queue.BuildableItem) - Method in class sh.createos.jenkins.sandbox.CreateOSQueueListener
- onLoaded() - Method in class sh.createos.jenkins.sandbox.CreateOSCloud.AgentRecovery
P
- provision(Cloud.CloudState, int) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
R
- readResolve() - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
-
Migrates templates written before the launch method became describable.
- recoverStaleAgents() - Static method in class sh.createos.jenkins.sandbox.CreateOSCloud
-
Decides what to do with each CreateOS agent restored from an earlier controller process.
- region() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
regionrecord component. - register(CreateOSDeclarativeAgent, String) - Static method in class sh.createos.jenkins.sandbox.CreateOSPipelineSupport
-
Registers a generated-label template for one Pipeline agent body.
- rootfs() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
rootfsrecord component. - runBash(String, String) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Run a bash script inside a sandbox and return once it exits.
- runShellScript(String, String, PrintStream, boolean) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Runs a shell script inside the sandbox and streams output into the Jenkins log.
S
- sandboxId() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Returns the value of the
sandboxIdrecord component. - SandboxSummary(String, String, String) - Constructor for record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Creates an instance of a
SandboxSummaryrecord class. - SandboxTemplate - Class in sh.createos.jenkins.sandbox
-
Configuration template for a CreateOS Sandbox agent.
- SandboxTemplate(String, String, String) - Constructor for class sh.createos.jenkins.sandbox.SandboxTemplate
-
Creates a sandbox template with its required Jenkins label, shape, and root filesystem.
- SandboxTemplate.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Exposes sandbox template metadata and validation to Jenkins.
- setAllowPipelineOverrides(boolean) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setApiUrl(String) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- setCloud(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setCloud(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setContainerCap(int) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- setCredentialsId(String) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- setDeleteOnRestart(boolean) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setDiskMiB(int) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setDiskMiB(int) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setDiskMiB(int) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setDisks(List<CreateOSDiskAttachment>) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setDisks(List<CreateOSDiskAttachment>) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setDisks(List<CreateOSDiskAttachment>) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setDisplayName(String) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- setExcludes(List<String>) - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep
- setExecSandboxCap(int) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- setIdleMinutes(int) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setInheritFrom(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setLauncher(CreateOSLaunchMethod) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setNetworks(String) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setNetworks(List<String>) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setNetworks(List<String>) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setRegion(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setRegion(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setRegion(String) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setRemoteFs(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setRemoteFs(String) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setReturnStatus(boolean) - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- setReturnStdout(boolean) - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- setReuseAgent(boolean) - Method in class sh.createos.jenkins.sandbox.SandboxTemplate
- setRootfs(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setRootfs(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setSandboxId(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
-
Records which sandbox backs this agent, and writes it to disk immediately.
- setShape(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDeclarativeAgent
- setShape(String) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- setSubPath(String) - Method in class sh.createos.jenkins.sandbox.CreateOSDiskAttachment
- setTemplates(List<SandboxTemplate>) - Method in class sh.createos.jenkins.sandbox.CreateOSCloud
- sh.createos.jenkins.sandbox - package sh.createos.jenkins.sandbox
- shape() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns the value of the
shaperecord component. - SshLaunchMethod - Class in sh.createos.jenkins.sandbox
-
Controller connects to sandbox port 22 through a CreateOS tunnel.
- SshLaunchMethod(String) - Constructor for class sh.createos.jenkins.sandbox.SshLaunchMethod
-
Creates the SSH transport backed by the given Jenkins SSH private key credential.
- SshLaunchMethod.DescriptorImpl - Class in sh.createos.jenkins.sandbox
-
Exposes the SSH transport and its credential picker to the template form.
- start(StepContext) - Method in class sh.createos.jenkins.sandbox.CreateOSDownloadStep
- start(StepContext) - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep
- start(StepContext) - Method in class sh.createos.jenkins.sandbox.CreateOSShStep
- start(StepContext) - Method in class sh.createos.jenkins.sandbox.CreateOSUploadStep
- status() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Returns the value of the
statusrecord component. - stdout() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Returns the value of the
stdoutrecord component.
T
- takesImplicitBlockArgument() - Method in class sh.createos.jenkins.sandbox.CreateOSSandboxStep.DescriptorImpl
- taskAccepted(Executor, Queue.Task) - Method in class sh.createos.jenkins.sandbox.CreateOSComputer
- testConnection() - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Verify that this API key can access the CreateOS sandbox endpoint.
- toString() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.ExecResult
-
Returns a string representation of this record class.
- toString() - Method in record class sh.createos.jenkins.sandbox.CreateOSApiClient.SandboxSummary
-
Returns a string representation of this record class.
- toString() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxContext
-
Returns a string representation of this record class.
- toString() - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns a string representation of this record class.
U
- unregister(String) - Static method in class sh.createos.jenkins.sandbox.CreateOSPipelineSupport
-
Removes a generated-label template after the Pipeline agent body exits.
- uploadFile(String, String, InputStream) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Uploads raw bytes to an absolute path inside the sandbox.
W
- waitForRunning(String, Duration) - Method in class sh.createos.jenkins.sandbox.CreateOSApiClient
-
Poll until sandbox reaches "running" state.
- withName(String) - Method in record class sh.createos.jenkins.sandbox.CreateOSSandboxRequest
-
Returns this request with a controller-owned sandbox name.
_
- _terminate(TaskListener) - Method in class sh.createos.jenkins.sandbox.CreateOSSlave
All Classes and Interfaces|All Packages|Serialized Form