NomadFunctions

Functions

Link copied to clipboard

Retrieve a list of ACL Policies.

suspend fun getAclPolicies(prefix: String? = null): GetAclPoliciesResult
Link copied to clipboard

Retrieve information on an ACL Policy.

Link copied to clipboard

Get information on an ACL Role.

suspend fun getAclRole(argument: suspend GetAclRolePlainArgsBuilder.() -> Unit): GetAclRoleResult
Link copied to clipboard

Retrieve a list of ACL Roles.

suspend fun getAclRoles(prefix: String? = null): GetAclRolesResult
suspend fun getAclRoles(argument: suspend GetAclRolesPlainArgsBuilder.() -> Unit): GetAclRolesResult
Link copied to clipboard
suspend fun getAclToken(accessorId: String): GetAclTokenResult
suspend fun getAclToken(argument: suspend GetAclTokenPlainArgsBuilder.() -> Unit): GetAclTokenResult
Link copied to clipboard

Get a list of ACL tokens.

suspend fun getAclTokens(prefix: String? = null): GetAclTokensResult
Link copied to clipboard

Retrieve a list of allocations from Nomad.

suspend fun getAllocations(filter: String? = null, namespace: String? = null, prefix: String? = null): GetAllocationsResult
Link copied to clipboard

Retrieve a list of datacenters.

suspend fun getDatacenters(ignoreDownNodes: Boolean? = null, prefix: String? = null): GetDatacentersResult
Link copied to clipboard

Retrieve a list of deployments in Nomad.

Link copied to clipboard

Get information on a dynamic host volume from Nomad.

suspend fun getDynamicHostVolume(id: String, namespace: String? = null): GetDynamicHostVolumeResult
Link copied to clipboard
suspend fun getJob(argument: GetJobPlainArgs): GetJobResult

Get information on a job ID. The aim of this datasource is to enable you to act on various settings and states of a particular job. An error is triggered if zero or more than one result is returned by the query.

suspend fun getJob(argument: suspend GetJobPlainArgsBuilder.() -> Unit): GetJobResult
suspend fun getJob(jobId: String, namespace: String? = null): GetJobResult
Link copied to clipboard

Parse a HCL jobspec and produce the equivalent JSON encoded job.

suspend fun getJobParser(canonicalize: Boolean? = null, hcl: String): GetJobParserResult
Link copied to clipboard
suspend fun getJwks(): GetJwksResult

Retrieve the cluster JWKS public keys. The keys are returned both as a list of maps (keys), and as a list of PEM-encoded strings (pem_keys), which may be more convenient for use.

Link copied to clipboard

Get information about a namespace in Nomad.

Link copied to clipboard

Retrieve a list of namespaces available in Nomad.

Link copied to clipboard

Get information about a node pool in Nomad.

suspend fun getNodePool(argument: suspend GetNodePoolPlainArgsBuilder.() -> Unit): GetNodePoolResult
Link copied to clipboard

Retrieve a list of node pools available in Nomad.

suspend fun getNodePools(filter: String? = null, prefix: String? = null): GetNodePoolsResult
Link copied to clipboard

Lookup a plugin by ID. The aim of this datasource is to determine whether a particular plugin exists on the cluster, to find information on the health and availability of the plugin, and to optionally wait for the plugin before performing actions the require an available plugin controller. If a plugin with the specified ID does not exist and the datasource is not configured to wait, it will result in an error. For simple existence checks, use the nomad.getPlugins listing datasource.

suspend fun getPlugin(argument: suspend GetPluginPlainArgsBuilder.() -> Unit): GetPluginResult
suspend fun getPlugin(pluginId: String, waitForHealthy: Boolean? = null, waitForRegistration: Boolean? = null): GetPluginResult
Link copied to clipboard

Retrieve a list of dynamic plugins in Nomad.

suspend fun getPlugins(type: String? = null): GetPluginsResult
suspend fun getPlugins(argument: suspend GetPluginsPlainArgsBuilder.() -> Unit): GetPluginsResult
Link copied to clipboard

Retrieve a list of regions available in Nomad.

Link copied to clipboard

Retrieve a list of Scaling Policies.

suspend fun getScalingPolicies(jobId: String? = null, type: String? = null): GetScalingPoliciesResult
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun getVariable(argument: suspend GetVariablePlainArgsBuilder.() -> Unit): GetVariableResult
suspend fun getVariable(namespace: String? = null, path: String): GetVariableResult
Link copied to clipboard

Retrieve a list of volumes in Nomad.

suspend fun getVolumes(argument: suspend GetVolumesPlainArgsBuilder.() -> Unit): GetVolumesResult
suspend fun getVolumes(namespace: String? = null, nodeId: String? = null, pluginId: String? = null, type: String? = null): GetVolumesResult