nomad.getJob

Explore with Pulumi AI

Nomad v2.3.0 published on Wednesday, Jun 5, 2024 by Pulumi

pulumi/pulumi-nomad

Example Usage

Get the data about a snapshot:

import * as pulumi from "@pulumi/pulumi";
import * as nomad from "@pulumi/nomad";

const example = nomad.getJob({
    jobId: "example",
    namespace: "dev",
});

import pulumi
import pulumi_nomad as nomad

example = nomad.get_job(job_id="example",
    namespace="dev")

package main

import (
	"github.com/pulumi/pulumi-nomad/sdk/v2/go/nomad"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nomad.LookupJob(ctx, &nomad.LookupJobArgs{
			JobId:     "example",
			Namespace: pulumi.StringRef("dev"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nomad = Pulumi.Nomad;

return await Deployment.RunAsync(() => 
{
    var example = Nomad.GetJob.Invoke(new()
    {
        JobId = "example",
        Namespace = "dev",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nomad.NomadFunctions;
import com.pulumi.nomad.inputs.GetJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NomadFunctions.getJob(GetJobArgs.builder()
            .jobId("example")
            .namespace("dev")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: nomad:getJob
      Arguments:
        jobId: example
        namespace: dev

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>

def get_job(job_id: Optional[str] = None,
            namespace: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_id: Optional[pulumi.Input[str]] = None,
            namespace: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]

func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: nomad:index/getJob:getJob
  arguments:
    # arguments dictionary

The following arguments are supported:

JobId string: (string) ID of the job.
Namespace string: (string) Namespace of the specified job.

JobId string: (string) ID of the job.
Namespace string: (string) Namespace of the specified job.

jobId String: (string) ID of the job.
namespace String: (string) Namespace of the specified job.

jobId string: (string) ID of the job.
namespace string: (string) Namespace of the specified job.

job_id str: (string) ID of the job.
namespace str: (string) Namespace of the specified job.

jobId String: (string) ID of the job.
namespace String: (string) Namespace of the specified job.

getJob Result

The following output properties are available:

AllAtOnce bool: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
Constraints List<GetJobConstraint>
CreateIndex int: (integer) Creation Index.
Datacenters List<string>: (list of strings) Datacenters allowed to run the specified job.
Id string: The provider-assigned unique ID for this managed resource.
JobId string
JobModifyIndex int: (integer) Job modify index (used for version verification).
ModifyIndex int: (integer) Modification Index.
Name string: (string) Name of the job.
ParentId string: (string) Job's parent ID.
PeriodicConfigs List<GetJobPeriodicConfig>: (list of maps) Job's periodic configuration (time based scheduling).
Priority int: (integer) Used for the prioritization of scheduling and resource access.
Region string: (string) Region where the Nomad cluster resides.
Stable bool: (boolean) Job stability status.
Status string: (string) Execution status of the specified job.
StatusDescription string: (string) Status description of the specified job.
Stop bool: (boolean) Job enabled status.
SubmitTime int: (integer) Job submission date.
TaskGroups List<GetJobTaskGroup>: (list of maps) A list of of the job's task groups.
Type string: (string) Scheduler type used during job creation.
Version int: (integer) Version of the specified job.
Namespace string

AllAtOnce bool: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
Constraints []GetJobConstraint
CreateIndex int: (integer) Creation Index.
Datacenters []string: (list of strings) Datacenters allowed to run the specified job.
Id string: The provider-assigned unique ID for this managed resource.
JobId string
JobModifyIndex int: (integer) Job modify index (used for version verification).
ModifyIndex int: (integer) Modification Index.
Name string: (string) Name of the job.
ParentId string: (string) Job's parent ID.
PeriodicConfigs []GetJobPeriodicConfig: (list of maps) Job's periodic configuration (time based scheduling).
Priority int: (integer) Used for the prioritization of scheduling and resource access.
Region string: (string) Region where the Nomad cluster resides.
Stable bool: (boolean) Job stability status.
Status string: (string) Execution status of the specified job.
StatusDescription string: (string) Status description of the specified job.
Stop bool: (boolean) Job enabled status.
SubmitTime int: (integer) Job submission date.
TaskGroups []GetJobTaskGroup: (list of maps) A list of of the job's task groups.
Type string: (string) Scheduler type used during job creation.
Version int: (integer) Version of the specified job.
Namespace string

allAtOnce Boolean: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
constraints List<GetJobConstraint>
createIndex Integer: (integer) Creation Index.
datacenters List<String>: (list of strings) Datacenters allowed to run the specified job.
id String: The provider-assigned unique ID for this managed resource.
jobId String
jobModifyIndex Integer: (integer) Job modify index (used for version verification).
modifyIndex Integer: (integer) Modification Index.
name String: (string) Name of the job.
parentId String: (string) Job's parent ID.
periodicConfigs List<GetJobPeriodicConfig>: (list of maps) Job's periodic configuration (time based scheduling).
priority Integer: (integer) Used for the prioritization of scheduling and resource access.
region String: (string) Region where the Nomad cluster resides.
stable Boolean: (boolean) Job stability status.
status String: (string) Execution status of the specified job.
statusDescription String: (string) Status description of the specified job.
stop Boolean: (boolean) Job enabled status.
submitTime Integer: (integer) Job submission date.
taskGroups List<GetJobTaskGroup>: (list of maps) A list of of the job's task groups.
type String: (string) Scheduler type used during job creation.
version Integer: (integer) Version of the specified job.
namespace String

allAtOnce boolean: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
constraints GetJobConstraint[]
createIndex number: (integer) Creation Index.
datacenters string[]: (list of strings) Datacenters allowed to run the specified job.
id string: The provider-assigned unique ID for this managed resource.
jobId string
jobModifyIndex number: (integer) Job modify index (used for version verification).
modifyIndex number: (integer) Modification Index.
name string: (string) Name of the job.
parentId string: (string) Job's parent ID.
periodicConfigs GetJobPeriodicConfig[]: (list of maps) Job's periodic configuration (time based scheduling).
priority number: (integer) Used for the prioritization of scheduling and resource access.
region string: (string) Region where the Nomad cluster resides.
stable boolean: (boolean) Job stability status.
status string: (string) Execution status of the specified job.
statusDescription string: (string) Status description of the specified job.
stop boolean: (boolean) Job enabled status.
submitTime number: (integer) Job submission date.
taskGroups GetJobTaskGroup[]: (list of maps) A list of of the job's task groups.
type string: (string) Scheduler type used during job creation.
version number: (integer) Version of the specified job.
namespace string

all_at_once bool: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
constraints Sequence[GetJobConstraint]
create_index int: (integer) Creation Index.
datacenters Sequence[str]: (list of strings) Datacenters allowed to run the specified job.
id str: The provider-assigned unique ID for this managed resource.
job_id str
job_modify_index int: (integer) Job modify index (used for version verification).
modify_index int: (integer) Modification Index.
name str: (string) Name of the job.
parent_id str: (string) Job's parent ID.
periodic_configs Sequence[GetJobPeriodicConfig]: (list of maps) Job's periodic configuration (time based scheduling).
priority int: (integer) Used for the prioritization of scheduling and resource access.
region str: (string) Region where the Nomad cluster resides.
stable bool: (boolean) Job stability status.
status str: (string) Execution status of the specified job.
status_description str: (string) Status description of the specified job.
stop bool: (boolean) Job enabled status.
submit_time int: (integer) Job submission date.
task_groups Sequence[GetJobTaskGroup]: (list of maps) A list of of the job's task groups.
type str: (string) Scheduler type used during job creation.
version int: (integer) Version of the specified job.
namespace str

allAtOnce Boolean: (boolean) If the scheduler can make partial placements on oversubscribed nodes.
constraints List<Property Map>
createIndex Number: (integer) Creation Index.
datacenters List<String>: (list of strings) Datacenters allowed to run the specified job.
id String: The provider-assigned unique ID for this managed resource.
jobId String
jobModifyIndex Number: (integer) Job modify index (used for version verification).
modifyIndex Number: (integer) Modification Index.
name String: (string) Name of the job.
parentId String: (string) Job's parent ID.
periodicConfigs List<Property Map>: (list of maps) Job's periodic configuration (time based scheduling).
priority Number: (integer) Used for the prioritization of scheduling and resource access.
region String: (string) Region where the Nomad cluster resides.
stable Boolean: (boolean) Job stability status.
status String: (string) Execution status of the specified job.
statusDescription String: (string) Status description of the specified job.
stop Boolean: (boolean) Job enabled status.
submitTime Number: (integer) Job submission date.
taskGroups List<Property Map>: (list of maps) A list of of the job's task groups.
type String: (string) Scheduler type used during job creation.
version Number: (integer) Version of the specified job.
namespace String

Supporting Types

GetJobConstraint

Ltarget string: (string) Attribute being constrained.
Operand string: (string) Operator used to compare the attribute to the constraint.
Rtarget string: (string) Constraint value.

Ltarget string: (string) Attribute being constrained.
Operand string: (string) Operator used to compare the attribute to the constraint.
Rtarget string: (string) Constraint value.

ltarget String: (string) Attribute being constrained.
operand String: (string) Operator used to compare the attribute to the constraint.
rtarget String: (string) Constraint value.

ltarget string: (string) Attribute being constrained.
operand string: (string) Operator used to compare the attribute to the constraint.
rtarget string: (string) Constraint value.

ltarget str: (string) Attribute being constrained.
operand str: (string) Operator used to compare the attribute to the constraint.
rtarget str: (string) Constraint value.

ltarget String: (string) Attribute being constrained.
operand String: (string) Operator used to compare the attribute to the constraint.
rtarget String: (string) Constraint value.

GetJobPeriodicConfig

Enabled bool: (boolean) If periodic scheduling is enabled for the specified job.
ProhibitOverlap bool: (boolean) If the specified job should wait until previous instances of the job have completed.
Spec string: (string)
SpecType string: (string)
Timezone string: (string) Time zone to evaluate the next launch interval against.

Enabled bool: (boolean) If periodic scheduling is enabled for the specified job.
ProhibitOverlap bool: (boolean) If the specified job should wait until previous instances of the job have completed.
Spec string: (string)
SpecType string: (string)
Timezone string: (string) Time zone to evaluate the next launch interval against.

enabled Boolean: (boolean) If periodic scheduling is enabled for the specified job.
prohibitOverlap Boolean: (boolean) If the specified job should wait until previous instances of the job have completed.
spec String: (string)
specType String: (string)
timezone String: (string) Time zone to evaluate the next launch interval against.

enabled boolean: (boolean) If periodic scheduling is enabled for the specified job.
prohibitOverlap boolean: (boolean) If the specified job should wait until previous instances of the job have completed.
spec string: (string)
specType string: (string)
timezone string: (string) Time zone to evaluate the next launch interval against.

enabled bool: (boolean) If periodic scheduling is enabled for the specified job.
prohibit_overlap bool: (boolean) If the specified job should wait until previous instances of the job have completed.
spec str: (string)
spec_type str: (string)
timezone str: (string) Time zone to evaluate the next launch interval against.

enabled Boolean: (boolean) If periodic scheduling is enabled for the specified job.
prohibitOverlap Boolean: (boolean) If the specified job should wait until previous instances of the job have completed.
spec String: (string)
specType String: (string)
timezone String: (string) Time zone to evaluate the next launch interval against.