Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.AiLanguage.getJobs

Start a Neo task

Explain and create an oci.AiLanguage.getJobs resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

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

const testJobs = oci.AiLanguage.getJobs({
    compartmentId: compartmentId,
    displayName: jobDisplayName,
    id: jobId,
    state: jobState,
});

import pulumi
import pulumi_oci as oci

test_jobs = oci.AiLanguage.get_jobs(compartment_id=compartment_id,
    display_name=job_display_name,
    id=job_id,
    state=job_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ailanguage.GetJobs(ctx, &ailanguage.GetJobsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(jobDisplayName),
			Id:            pulumi.StringRef(jobId),
			State:         pulumi.StringRef(jobState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testJobs = Oci.AiLanguage.GetJobs.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = jobDisplayName,
        Id = jobId,
        State = jobState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiLanguage.AiLanguageFunctions;
import com.pulumi.oci.AiLanguage.inputs.GetJobsArgs;
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 testJobs = AiLanguageFunctions.getJobs(GetJobsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(jobDisplayName)
            .id(jobId)
            .state(jobState)
            .build());

    }
}

variables:
  testJobs:
    fn::invoke:
      function: oci:AiLanguage:getJobs
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${jobDisplayName}
        id: ${jobId}
        state: ${jobState}

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,
             display_name: Optional[str] = None,
             filters: Optional[Sequence[GetJobsFilter]] = None,
             id: Optional[str] = None,
             state: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetJobsResult
def get_jobs_output(compartment_id: Optional[pulumi.Input[str]] = None,
             display_name: Optional[pulumi.Input[str]] = None,
             filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetJobsFilterArgs]]]] = None,
             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)
public static Output<GetJobsResult> getJobs(GetJobsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:AiLanguage/getJobs:getJobs
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetJobsFilter>
Id string: Unique identifier(OCID).
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetJobsFilter
Id string: Unique identifier(OCID).
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetJobsFilter>
id String: Unique identifier(OCID).
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId string: The ID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the entire display name given.
filters GetJobsFilter[]
id string: Unique identifier(OCID).
state string: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartment_id str: The ID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the entire display name given.
filters Sequence[GetJobsFilter]
id str: Unique identifier(OCID).
state str: A filter to return only resources whose lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
id String: Unique identifier(OCID).
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.

getJobs Result

The following output properties are available:

CompartmentId string: The OCID of the compartment where you want to create the job.
JobCollections List<GetJobsJobCollection>: The list of job_collection.
DisplayName string: A user-friendly display name for the job.
Filters List<GetJobsFilter>
Id string: The OCID of the job.
State string: The current state of the Job.

CompartmentId string: The OCID of the compartment where you want to create the job.
JobCollections []GetJobsJobCollection: The list of job_collection.
DisplayName string: A user-friendly display name for the job.
Filters []GetJobsFilter
Id string: The OCID of the job.
State string: The current state of the Job.

compartmentId String: The OCID of the compartment where you want to create the job.
jobCollections List<GetJobsJobCollection>: The list of job_collection.
displayName String: A user-friendly display name for the job.
filters List<GetJobsFilter>
id String: The OCID of the job.
state String: The current state of the Job.

compartmentId string: The OCID of the compartment where you want to create the job.
jobCollections GetJobsJobCollection[]: The list of job_collection.
displayName string: A user-friendly display name for the job.
filters GetJobsFilter[]
id string: The OCID of the job.
state string: The current state of the Job.

compartment_id str: The OCID of the compartment where you want to create the job.
job_collections Sequence[GetJobsJobCollection]: The list of job_collection.
display_name str: A user-friendly display name for the job.
filters Sequence[GetJobsFilter]
id str: The OCID of the job.
state str: The current state of the Job.

compartmentId String: The OCID of the compartment where you want to create the job.
jobCollections List<Property Map>: The list of job_collection.
displayName String: A user-friendly display name for the job.
filters List<Property Map>
id String: The OCID of the job.
state String: The current 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

GetJobsJobCollection

Items List<GetJobsJobCollectionItem>

Items []GetJobsJobCollectionItem

items List<GetJobsJobCollectionItem>

items GetJobsJobCollectionItem[]

items Sequence[GetJobsJobCollectionItem]

items List<Property Map>

GetJobsJobCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
CompletedDocuments int: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
CreatedBy string: The OCID of the user who created the job.
Description string: A short description of the job.
DisplayName string: A filter to return only resources that match the entire display name given.
FailedDocuments int: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
Id string: Unique identifier(OCID).
InputConfigurations List<GetJobsJobCollectionItemInputConfiguration>: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
InputLocations List<GetJobsJobCollectionItemInputLocation>: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ModelMetadataDetails List<GetJobsJobCollectionItemModelMetadataDetail>: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
OutputLocations List<GetJobsJobCollectionItemOutputLocation>: Object storage output location to write inference results
PendingDocuments int: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
PercentComplete int: How much progress the operation has made, vs the total amount of work that must be performed.
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
TimeAccepted string: Job accepted time.
TimeCompleted string: Job finished time.
TimeStarted string: Job started time.
TotalDocuments int: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
TtlInDays int: Time to live duration in days for Job. Job will be available till max 90 days.
WarningsCount int: warnings count

CompartmentId string: The ID of the compartment in which to list resources.
CompletedDocuments int: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
CreatedBy string: The OCID of the user who created the job.
Description string: A short description of the job.
DisplayName string: A filter to return only resources that match the entire display name given.
FailedDocuments int: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
Id string: Unique identifier(OCID).
InputConfigurations []GetJobsJobCollectionItemInputConfiguration: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
InputLocations []GetJobsJobCollectionItemInputLocation: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ModelMetadataDetails []GetJobsJobCollectionItemModelMetadataDetail: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
OutputLocations []GetJobsJobCollectionItemOutputLocation: Object storage output location to write inference results
PendingDocuments int: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
PercentComplete int: How much progress the operation has made, vs the total amount of work that must be performed.
State string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
TimeAccepted string: Job accepted time.
TimeCompleted string: Job finished time.
TimeStarted string: Job started time.
TotalDocuments int: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
TtlInDays int: Time to live duration in days for Job. Job will be available till max 90 days.
WarningsCount int: warnings count

compartmentId String: The ID of the compartment in which to list resources.
completedDocuments Integer: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
createdBy String: The OCID of the user who created the job.
description String: A short description of the job.
displayName String: A filter to return only resources that match the entire display name given.
failedDocuments Integer: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
id String: Unique identifier(OCID).
inputConfigurations List<GetJobsJobCollectionItemInputConfiguration>: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
inputLocations List<GetJobsJobCollectionItemInputLocation>: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
modelMetadataDetails List<GetJobsJobCollectionItemModelMetadataDetail>: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
outputLocations List<GetJobsJobCollectionItemOutputLocation>: Object storage output location to write inference results
pendingDocuments Integer: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
percentComplete Integer: How much progress the operation has made, vs the total amount of work that must be performed.
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.
timeAccepted String: Job accepted time.
timeCompleted String: Job finished time.
timeStarted String: Job started time.
totalDocuments Integer: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
ttlInDays Integer: Time to live duration in days for Job. Job will be available till max 90 days.
warningsCount Integer: warnings count

compartmentId string: The ID of the compartment in which to list resources.
completedDocuments number: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
createdBy string: The OCID of the user who created the job.
description string: A short description of the job.
displayName string: A filter to return only resources that match the entire display name given.
failedDocuments number: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
id string: Unique identifier(OCID).
inputConfigurations GetJobsJobCollectionItemInputConfiguration[]: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
inputLocations GetJobsJobCollectionItemInputLocation[]: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
modelMetadataDetails GetJobsJobCollectionItemModelMetadataDetail[]: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
outputLocations GetJobsJobCollectionItemOutputLocation[]: Object storage output location to write inference results
pendingDocuments number: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
percentComplete number: How much progress the operation has made, vs the total amount of work that must be performed.
state string: A filter to return only resources whose lifecycleState matches the given lifecycleState.
timeAccepted string: Job accepted time.
timeCompleted string: Job finished time.
timeStarted string: Job started time.
totalDocuments number: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
ttlInDays number: Time to live duration in days for Job. Job will be available till max 90 days.
warningsCount number: warnings count

compartment_id str: The ID of the compartment in which to list resources.
completed_documents int: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
created_by str: The OCID of the user who created the job.
description str: A short description of the job.
display_name str: A filter to return only resources that match the entire display name given.
failed_documents int: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
id str: Unique identifier(OCID).
input_configurations Sequence[GetJobsJobCollectionItemInputConfiguration]: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
input_locations Sequence[GetJobsJobCollectionItemInputLocation]: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
model_metadata_details Sequence[GetJobsJobCollectionItemModelMetadataDetail]: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
output_locations Sequence[GetJobsJobCollectionItemOutputLocation]: Object storage output location to write inference results
pending_documents int: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
percent_complete int: How much progress the operation has made, vs the total amount of work that must be performed.
state str: A filter to return only resources whose lifecycleState matches the given lifecycleState.
time_accepted str: Job accepted time.
time_completed str: Job finished time.
time_started str: Job started time.
total_documents int: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
ttl_in_days int: Time to live duration in days for Job. Job will be available till max 90 days.
warnings_count int: warnings count

compartmentId String: The ID of the compartment in which to list resources.
completedDocuments Number: Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
createdBy String: The OCID of the user who created the job.
description String: A short description of the job.
displayName String: A filter to return only resources that match the entire display name given.
failedDocuments Number: Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
id String: Unique identifier(OCID).
inputConfigurations List<Property Map>: input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types
inputLocations List<Property Map>: document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
modelMetadataDetails List<Property Map>: training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API
outputLocations List<Property Map>: Object storage output location to write inference results
pendingDocuments Number: Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
percentComplete Number: How much progress the operation has made, vs the total amount of work that must be performed.
state String: A filter to return only resources whose lifecycleState matches the given lifecycleState.
timeAccepted String: Job accepted time.
timeCompleted String: Job finished time.
timeStarted String: Job started time.
totalDocuments Number: Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
ttlInDays Number: Time to live duration in days for Job. Job will be available till max 90 days.
warningsCount Number: warnings count

GetJobsJobCollectionItemInputConfiguration

Configuration Dictionary<string, ImmutableDictionary<string, string>>: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
DocumentTypes List<string>: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

Configuration map[string]map[string]string: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
DocumentTypes []string: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

configuration Map<String,Map<String,String>>: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
documentTypes List<String>: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

configuration {[key: string]: {[key: string]: string}}: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
documentTypes string[]: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

configuration Mapping[str, Mapping[str, str]]: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
document_types Sequence[str]: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

configuration Map<Map<String>>: model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}
documentTypes List<String>: Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

GetJobsJobCollectionItemInputLocation

Bucket string: Object Storage bucket name.
LocationType string: locationType
Namespace string: Object Storage namespace name.
ObjectNames List<string>: List of objects to be processed

Bucket string: Object Storage bucket name.
LocationType string: locationType
Namespace string: Object Storage namespace name.
ObjectNames []string: List of objects to be processed

bucket String: Object Storage bucket name.
locationType String: locationType
namespace String: Object Storage namespace name.
objectNames List<String>: List of objects to be processed

bucket string: Object Storage bucket name.
locationType string: locationType
namespace string: Object Storage namespace name.
objectNames string[]: List of objects to be processed

bucket str: Object Storage bucket name.
location_type str: locationType
namespace str: Object Storage namespace name.
object_names Sequence[str]: List of objects to be processed

bucket String: Object Storage bucket name.
locationType String: locationType
namespace String: Object Storage namespace name.
objectNames List<String>: List of objects to be processed

GetJobsJobCollectionItemModelMetadataDetail

Configuration Dictionary<string, ImmutableDictionary<string, string>>

model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}

EndpointId string

Unique identifier endpoint OCID that should be used for inference

LanguageCode string