Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getJobs

This data source provides the list of Jobs in Oracle Cloud Infrastructure Data Science service.

List jobs in the specified compartment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testJobs = Output.Create(Oci.DataScience.GetJobs.InvokeAsync(new Oci.DataScience.GetJobsArgs
        {
            CompartmentId = @var.Compartment_id,
            CreatedBy = @var.Job_created_by,
            DisplayName = @var.Job_display_name,
            Id = @var.Job_id,
            ProjectId = oci_datascience_project.Test_project.Id,
            State = @var.Job_state,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataScience"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataScience.GetJobs(ctx, &datascience.GetJobsArgs{
			CompartmentId: _var.Compartment_id,
			CreatedBy:     pulumi.StringRef(_var.Job_created_by),
			DisplayName:   pulumi.StringRef(_var.Job_display_name),
			Id:            pulumi.StringRef(_var.Job_id),
			ProjectId:     pulumi.StringRef(oci_datascience_project.Test_project.Id),
			State:         pulumi.StringRef(_var.Job_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_jobs = oci.DataScience.get_jobs(compartment_id=var["compartment_id"],
    created_by=var["job_created_by"],
    display_name=var["job_display_name"],
    id=var["job_id"],
    project_id=oci_datascience_project["test_project"]["id"],
    state=var["job_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testJobs = oci.DataScience.getJobs({
    compartmentId: _var.compartment_id,
    createdBy: _var.job_created_by,
    displayName: _var.job_display_name,
    id: _var.job_id,
    projectId: oci_datascience_project.test_project.id,
    state: _var.job_state,
});

Coming soon!

Using getJobs

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 getJobs(args: GetJobsArgs, opts?: InvokeOptions): Promise<GetJobsResult>
function getJobsOutput(args: GetJobsOutputArgs, opts?: InvokeOptions): Output<GetJobsResult>
def get_jobs(compartment_id: Optional[str] = None,
             created_by: Optional[str] = None,
             display_name: Optional[str] = None,
             filters: Optional[Sequence[_datascience.GetJobsFilter]] = None,
             id: Optional[str] = None,
             project_id: Optional[str] = None,
             state: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetJobsResult
def get_jobs_output(compartment_id: Optional[pulumi.Input[str]] = None,
             created_by: Optional[pulumi.Input[str]] = None,
             display_name: Optional[pulumi.Input[str]] = None,
             filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datascience.GetJobsFilterArgs]]]] = None,
             id: Optional[pulumi.Input[str]] = None,
             project_id: Optional[pulumi.Input[str]] = None,
             state: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetJobsResult]
func GetJobs(ctx *Context, args *GetJobsArgs, opts ...InvokeOption) (*GetJobsResult, error)
func GetJobsOutput(ctx *Context, args *GetJobsOutputArgs, opts ...InvokeOption) GetJobsResultOutput

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

public static class GetJobs 
{
    public static Task<GetJobsResult> InvokeAsync(GetJobsArgs args, InvokeOptions? opts = null)
    public static Output<GetJobsResult> Invoke(GetJobsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetJobsResult> getJobs(GetJobsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataScience/getJobs:getJobs
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

Filter results by the OCID of the compartment.

CreatedBy string

Filter results by the OCID of the user who created the resource.

DisplayName string

Filter results by its user-friendly name.

Filters List<GetJobsFilter>
Id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

ProjectId string

Filter results by the OCID of the project.

State string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

CompartmentId string

Filter results by the OCID of the compartment.

CreatedBy string

Filter results by the OCID of the user who created the resource.

DisplayName string

Filter results by its user-friendly name.

Filters []GetJobsFilter
Id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

ProjectId string

Filter results by the OCID of the project.

State string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String

Filter results by the OCID of the compartment.

createdBy String

Filter results by the OCID of the user who created the resource.

displayName String

Filter results by its user-friendly name.

filters List<GetJobsFilter>
id String

Filter results by OCID. Must be an OCID of the correct type for the resource type.

projectId String

Filter results by the OCID of the project.

state String

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId string

Filter results by the OCID of the compartment.

createdBy string

Filter results by the OCID of the user who created the resource.

displayName string

Filter results by its user-friendly name.

filters GetJobsFilter[]
id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

projectId string

Filter results by the OCID of the project.

state string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartment_id str

Filter results by the OCID of the compartment.

created_by str

Filter results by the OCID of the user who created the resource.

display_name str

Filter results by its user-friendly name.

filters GetJobsFilter]
id str

Filter results by OCID. Must be an OCID of the correct type for the resource type.

project_id str

Filter results by the OCID of the project.

state str

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String

Filter results by the OCID of the compartment.

createdBy String

Filter results by the OCID of the user who created the resource.

displayName String

Filter results by its user-friendly name.

filters List<Property Map>
id String

Filter results by OCID. Must be an OCID of the correct type for the resource type.

projectId String

Filter results by the OCID of the project.

state String

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getJobs Result

The following output properties are available:

CompartmentId string

The OCID of the compartment where you want to create the job.

Jobs List<GetJobsJob>

The list of jobs.

CreatedBy string

The OCID of the user who created the project.

DisplayName string

A user-friendly display name for the resource.

Filters List<GetJobsFilter>
Id string

The OCID of the job.

ProjectId string

The OCID of the project to associate the job with.

State string

The state of the job.

CompartmentId string

The OCID of the compartment where you want to create the job.

Jobs []GetJobsJob

The list of jobs.

CreatedBy string

The OCID of the user who created the project.

DisplayName string

A user-friendly display name for the resource.

Filters []GetJobsFilter
Id string

The OCID of the job.

ProjectId string

The OCID of the project to associate the job with.

State string

The state of the job.

compartmentId String

The OCID of the compartment where you want to create the job.

jobs List<GetJobsJob>

The list of jobs.

createdBy String

The OCID of the user who created the project.

displayName String

A user-friendly display name for the resource.

filters List<GetJobsFilter>
id String

The OCID of the job.

projectId String

The OCID of the project to associate the job with.

state String

The state of the job.

compartmentId string

The OCID of the compartment where you want to create the job.

jobs GetJobsJob[]

The list of jobs.

createdBy string

The OCID of the user who created the project.

displayName string

A user-friendly display name for the resource.

filters GetJobsFilter[]
id string

The OCID of the job.

projectId string

The OCID of the project to associate the job with.

state string

The state of the job.

compartment_id str

The OCID of the compartment where you want to create the job.

jobs GetJobsJob]

The list of jobs.

created_by str

The OCID of the user who created the project.

display_name str

A user-friendly display name for the resource.

filters GetJobsFilter]
id str

The OCID of the job.

project_id str

The OCID of the project to associate the job with.

state str

The state of the job.

compartmentId String

The OCID of the compartment where you want to create the job.

jobs List<Property Map>

The list of jobs.

createdBy String

The OCID of the user who created the project.

displayName String

A user-friendly display name for the resource.

filters List<Property Map>
id String

The OCID of the job.

projectId String

The OCID of the project to associate the job with.

state String

The state of the job.

Supporting Types

GetJobsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetJobsJob

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
CompartmentId string

Filter results by the OCID of the compartment.

CreatedBy string

Filter results by the OCID of the user who created the resource.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

DeleteRelatedJobRuns bool
Description string

A short description of the job.

DisplayName string

Filter results by its user-friendly name.

EmptyArtifact bool
FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

JobArtifact string
JobConfigurationDetails List<GetJobsJobJobConfigurationDetail>

The job configuration details

JobInfrastructureConfigurationDetails List<GetJobsJobJobInfrastructureConfigurationDetail>

The job infrastructure configuration details (shape, block storage, etc.)

JobLogConfigurationDetails List<GetJobsJobJobLogConfigurationDetail>

Logging configuration for resource.

LifecycleDetails string

The state of the job.

ProjectId string

Filter results by the OCID of the project.

State string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
CompartmentId string

Filter results by the OCID of the compartment.

CreatedBy string

Filter results by the OCID of the user who created the resource.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

DeleteRelatedJobRuns bool
Description string

A short description of the job.

DisplayName string

Filter results by its user-friendly name.

EmptyArtifact bool
FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

JobArtifact string
JobConfigurationDetails []GetJobsJobJobConfigurationDetail

The job configuration details

JobInfrastructureConfigurationDetails []GetJobsJobJobInfrastructureConfigurationDetail

The job infrastructure configuration details (shape, block storage, etc.)

JobLogConfigurationDetails []GetJobsJobJobLogConfigurationDetail

Logging configuration for resource.

LifecycleDetails string

The state of the job.

ProjectId string

Filter results by the OCID of the project.

State string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
compartmentId String

Filter results by the OCID of the compartment.

createdBy String

Filter results by the OCID of the user who created the resource.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

deleteRelatedJobRuns Boolean
description String

A short description of the job.

displayName String

Filter results by its user-friendly name.

emptyArtifact Boolean
freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

Filter results by OCID. Must be an OCID of the correct type for the resource type.

jobArtifact String
jobConfigurationDetails List<GetJobsJobJobConfigurationDetail>

The job configuration details

jobInfrastructureConfigurationDetails List<GetJobsJobJobInfrastructureConfigurationDetail>

The job infrastructure configuration details (shape, block storage, etc.)

jobLogConfigurationDetails List<GetJobsJobJobLogConfigurationDetail>

Logging configuration for resource.

lifecycleDetails String

The state of the job.

projectId String

Filter results by the OCID of the project.

state String

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

artifactContentDisposition string
artifactContentLength string
artifactContentMd5 string
artifactLastModified string
compartmentId string

Filter results by the OCID of the compartment.

createdBy string

Filter results by the OCID of the user who created the resource.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

deleteRelatedJobRuns boolean
description string

A short description of the job.

displayName string

Filter results by its user-friendly name.

emptyArtifact boolean
freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id string

Filter results by OCID. Must be an OCID of the correct type for the resource type.

jobArtifact string
jobConfigurationDetails GetJobsJobJobConfigurationDetail[]

The job configuration details

jobInfrastructureConfigurationDetails GetJobsJobJobInfrastructureConfigurationDetail[]

The job infrastructure configuration details (shape, block storage, etc.)

jobLogConfigurationDetails GetJobsJobJobLogConfigurationDetail[]

Logging configuration for resource.

lifecycleDetails string

The state of the job.

projectId string

Filter results by the OCID of the project.

state string

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

timeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

artifact_content_disposition str
artifact_content_length str
artifact_content_md5 str
artifact_last_modified str
compartment_id str

Filter results by the OCID of the compartment.

created_by str

Filter results by the OCID of the user who created the resource.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

delete_related_job_runs bool
description str

A short description of the job.

display_name str

Filter results by its user-friendly name.

empty_artifact bool
freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id str

Filter results by OCID. Must be an OCID of the correct type for the resource type.

job_artifact str
job_configuration_details GetJobsJobJobConfigurationDetail]

The job configuration details

job_infrastructure_configuration_details GetJobsJobJobInfrastructureConfigurationDetail]

The job infrastructure configuration details (shape, block storage, etc.)

job_log_configuration_details GetJobsJobJobLogConfigurationDetail]

Logging configuration for resource.

lifecycle_details str

The state of the job.

project_id str

Filter results by the OCID of the project.

state str

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

time_created str

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
compartmentId String

Filter results by the OCID of the compartment.

createdBy String

Filter results by the OCID of the user who created the resource.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

deleteRelatedJobRuns Boolean
description String

A short description of the job.

displayName String

Filter results by its user-friendly name.

emptyArtifact Boolean
freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

Filter results by OCID. Must be an OCID of the correct type for the resource type.

jobArtifact String
jobConfigurationDetails List<Property Map>

The job configuration details

jobInfrastructureConfigurationDetails List<Property Map>

The job infrastructure configuration details (shape, block storage, etc.)

jobLogConfigurationDetails List<Property Map>

Logging configuration for resource.

lifecycleDetails String

The state of the job.

projectId String

Filter results by the OCID of the project.

state String

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

GetJobsJobJobConfigurationDetail

CommandLineArguments string

The arguments to pass to the job.

EnvironmentVariables Dictionary<string, object>

Environment variables to set for the job.

JobType string

The type of job.

MaximumRuntimeInMinutes string

A time bound for the execution of the job. Timer starts when the job becomes active.

CommandLineArguments string

The arguments to pass to the job.

EnvironmentVariables map[string]interface{}

Environment variables to set for the job.

JobType string

The type of job.

MaximumRuntimeInMinutes string

A time bound for the execution of the job. Timer starts when the job becomes active.

commandLineArguments String

The arguments to pass to the job.

environmentVariables Map<String,Object>

Environment variables to set for the job.

jobType String

The type of job.

maximumRuntimeInMinutes String

A time bound for the execution of the job. Timer starts when the job becomes active.

commandLineArguments string

The arguments to pass to the job.

environmentVariables {[key: string]: any}

Environment variables to set for the job.

jobType string

The type of job.

maximumRuntimeInMinutes string

A time bound for the execution of the job. Timer starts when the job becomes active.

command_line_arguments str

The arguments to pass to the job.

environment_variables Mapping[str, Any]

Environment variables to set for the job.

job_type str

The type of job.

maximum_runtime_in_minutes str

A time bound for the execution of the job. Timer starts when the job becomes active.

commandLineArguments String

The arguments to pass to the job.

environmentVariables Map<Any>

Environment variables to set for the job.

jobType String

The type of job.

maximumRuntimeInMinutes String

A time bound for the execution of the job. Timer starts when the job becomes active.

GetJobsJobJobInfrastructureConfigurationDetail

BlockStorageSizeInGbs int

The size of the block storage volume to attach to the instance running the job

JobInfrastructureType string

The infrastructure type used for job run.

ShapeName string

The shape used to launch the job run instances.

SubnetId string

The subnet to create a secondary vnic in to attach to the instance running the job

BlockStorageSizeInGbs int

The size of the block storage volume to attach to the instance running the job

JobInfrastructureType string

The infrastructure type used for job run.

ShapeName string

The shape used to launch the job run instances.

SubnetId string

The subnet to create a secondary vnic in to attach to the instance running the job

blockStorageSizeInGbs Integer

The size of the block storage volume to attach to the instance running the job

jobInfrastructureType String

The infrastructure type used for job run.

shapeName String

The shape used to launch the job run instances.

subnetId String

The subnet to create a secondary vnic in to attach to the instance running the job

blockStorageSizeInGbs number

The size of the block storage volume to attach to the instance running the job

jobInfrastructureType string

The infrastructure type used for job run.

shapeName string

The shape used to launch the job run instances.

subnetId string

The subnet to create a secondary vnic in to attach to the instance running the job

block_storage_size_in_gbs int

The size of the block storage volume to attach to the instance running the job

job_infrastructure_type str

The infrastructure type used for job run.

shape_name str

The shape used to launch the job run instances.

subnet_id str

The subnet to create a secondary vnic in to attach to the instance running the job

blockStorageSizeInGbs Number

The size of the block storage volume to attach to the instance running the job

jobInfrastructureType String

The infrastructure type used for job run.

shapeName String

The shape used to launch the job run instances.

subnetId String

The subnet to create a secondary vnic in to attach to the instance running the job

GetJobsJobJobLogConfigurationDetail

EnableAutoLogCreation bool

If automatic on-behalf-of log object creation is enabled for job runs.

EnableLogging bool

If customer logging is enabled for job runs.

LogGroupId string

The log group id for where log objects are for job runs.

LogId string

The log id the job run will push logs too.

EnableAutoLogCreation bool

If automatic on-behalf-of log object creation is enabled for job runs.

EnableLogging bool

If customer logging is enabled for job runs.

LogGroupId string

The log group id for where log objects are for job runs.

LogId string

The log id the job run will push logs too.

enableAutoLogCreation Boolean

If automatic on-behalf-of log object creation is enabled for job runs.

enableLogging Boolean

If customer logging is enabled for job runs.

logGroupId String

The log group id for where log objects are for job runs.

logId String

The log id the job run will push logs too.

enableAutoLogCreation boolean

If automatic on-behalf-of log object creation is enabled for job runs.

enableLogging boolean

If customer logging is enabled for job runs.

logGroupId string

The log group id for where log objects are for job runs.

logId string

The log id the job run will push logs too.

enable_auto_log_creation bool

If automatic on-behalf-of log object creation is enabled for job runs.

enable_logging bool

If customer logging is enabled for job runs.

log_group_id str

The log group id for where log objects are for job runs.

log_id str

The log id the job run will push logs too.

enableAutoLogCreation Boolean

If automatic on-behalf-of log object creation is enabled for job runs.

enableLogging Boolean

If customer logging is enabled for job runs.

logGroupId String

The log group id for where log objects are for job runs.

logId String

The log id the job run will push logs too.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.