1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentDataIngestionJobs
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

oci.GenerativeAi.getAgentDataIngestionJobs

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

    This data source provides the list of Data Ingestion Jobs in Oracle Cloud Infrastructure Generative Ai Agent service.

    ListDataIngestionJobs

    Gets a list of data ingestion jobs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDataIngestionJobs = oci.GenerativeAi.getAgentDataIngestionJobs({
        compartmentId: compartmentId,
        dataSourceId: testDataSource.id,
        displayName: dataIngestionJobDisplayName,
        state: dataIngestionJobState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_data_ingestion_jobs = oci.GenerativeAi.get_agent_data_ingestion_jobs(compartment_id=compartment_id,
        data_source_id=test_data_source["id"],
        display_name=data_ingestion_job_display_name,
        state=data_ingestion_job_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/GenerativeAi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := GenerativeAi.GetAgentDataIngestionJobs(ctx, &generativeai.GetAgentDataIngestionJobsArgs{
    			CompartmentId: pulumi.StringRef(compartmentId),
    			DataSourceId:  pulumi.StringRef(testDataSource.Id),
    			DisplayName:   pulumi.StringRef(dataIngestionJobDisplayName),
    			State:         pulumi.StringRef(dataIngestionJobState),
    		}, 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 testDataIngestionJobs = Oci.GenerativeAi.GetAgentDataIngestionJobs.Invoke(new()
        {
            CompartmentId = compartmentId,
            DataSourceId = testDataSource.Id,
            DisplayName = dataIngestionJobDisplayName,
            State = dataIngestionJobState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
    import com.pulumi.oci.GenerativeAi.inputs.GetAgentDataIngestionJobsArgs;
    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 testDataIngestionJobs = GenerativeAiFunctions.getAgentDataIngestionJobs(GetAgentDataIngestionJobsArgs.builder()
                .compartmentId(compartmentId)
                .dataSourceId(testDataSource.id())
                .displayName(dataIngestionJobDisplayName)
                .state(dataIngestionJobState)
                .build());
    
        }
    }
    
    variables:
      testDataIngestionJobs:
        fn::invoke:
          Function: oci:GenerativeAi:getAgentDataIngestionJobs
          Arguments:
            compartmentId: ${compartmentId}
            dataSourceId: ${testDataSource.id}
            displayName: ${dataIngestionJobDisplayName}
            state: ${dataIngestionJobState}
    

    Using getAgentDataIngestionJobs

    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 getAgentDataIngestionJobs(args: GetAgentDataIngestionJobsArgs, opts?: InvokeOptions): Promise<GetAgentDataIngestionJobsResult>
    function getAgentDataIngestionJobsOutput(args: GetAgentDataIngestionJobsOutputArgs, opts?: InvokeOptions): Output<GetAgentDataIngestionJobsResult>
    def get_agent_data_ingestion_jobs(compartment_id: Optional[str] = None,
                                      data_source_id: Optional[str] = None,
                                      display_name: Optional[str] = None,
                                      filters: Optional[Sequence[_generativeai.GetAgentDataIngestionJobsFilter]] = None,
                                      state: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetAgentDataIngestionJobsResult
    def get_agent_data_ingestion_jobs_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                      data_source_id: Optional[pulumi.Input[str]] = None,
                                      display_name: Optional[pulumi.Input[str]] = None,
                                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetAgentDataIngestionJobsFilterArgs]]]] = None,
                                      state: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetAgentDataIngestionJobsResult]
    func GetAgentDataIngestionJobs(ctx *Context, args *GetAgentDataIngestionJobsArgs, opts ...InvokeOption) (*GetAgentDataIngestionJobsResult, error)
    func GetAgentDataIngestionJobsOutput(ctx *Context, args *GetAgentDataIngestionJobsOutputArgs, opts ...InvokeOption) GetAgentDataIngestionJobsResultOutput

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

    public static class GetAgentDataIngestionJobs 
    {
        public static Task<GetAgentDataIngestionJobsResult> InvokeAsync(GetAgentDataIngestionJobsArgs args, InvokeOptions? opts = null)
        public static Output<GetAgentDataIngestionJobsResult> Invoke(GetAgentDataIngestionJobsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAgentDataIngestionJobsResult> getAgentDataIngestionJobs(GetAgentDataIngestionJobsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:GenerativeAi/getAgentDataIngestionJobs:getAgentDataIngestionJobs
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataSourceId string
    The OCID of the data source.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetAgentDataIngestionJobsFilter>
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataSourceId string
    The OCID of the data source.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetAgentDataIngestionJobsFilter
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataSourceId String
    The OCID of the data source.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetAgentDataIngestionJobsFilter>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment in which to list resources.
    dataSourceId string
    The OCID of the data source.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetAgentDataIngestionJobsFilter[]
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment in which to list resources.
    data_source_id str
    The OCID of the data source.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[generativeai.GetAgentDataIngestionJobsFilter]
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataSourceId String
    The OCID of the data source.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getAgentDataIngestionJobs Result

    The following output properties are available:

    DataIngestionJobCollections List<GetAgentDataIngestionJobsDataIngestionJobCollection>
    The list of data_ingestion_job_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment.
    DataSourceId string
    The OCID of the parent DataSource.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetAgentDataIngestionJobsFilter>
    State string
    The current state of the data ingestion job.
    DataIngestionJobCollections []GetAgentDataIngestionJobsDataIngestionJobCollection
    The list of data_ingestion_job_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment.
    DataSourceId string
    The OCID of the parent DataSource.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetAgentDataIngestionJobsFilter
    State string
    The current state of the data ingestion job.
    dataIngestionJobCollections List<GetAgentDataIngestionJobsDataIngestionJobCollection>
    The list of data_ingestion_job_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment.
    dataSourceId String
    The OCID of the parent DataSource.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetAgentDataIngestionJobsFilter>
    state String
    The current state of the data ingestion job.
    dataIngestionJobCollections GetAgentDataIngestionJobsDataIngestionJobCollection[]
    The list of data_ingestion_job_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    compartmentId string
    The OCID of the compartment.
    dataSourceId string
    The OCID of the parent DataSource.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetAgentDataIngestionJobsFilter[]
    state string
    The current state of the data ingestion job.
    data_ingestion_job_collections Sequence[generativeai.GetAgentDataIngestionJobsDataIngestionJobCollection]
    The list of data_ingestion_job_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    compartment_id str
    The OCID of the compartment.
    data_source_id str
    The OCID of the parent DataSource.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters Sequence[generativeai.GetAgentDataIngestionJobsFilter]
    state str
    The current state of the data ingestion job.
    dataIngestionJobCollections List<Property Map>
    The list of data_ingestion_job_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment.
    dataSourceId String
    The OCID of the parent DataSource.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    state String
    The current state of the data ingestion job.

    Supporting Types

    GetAgentDataIngestionJobsDataIngestionJobCollection

    GetAgentDataIngestionJobsDataIngestionJobCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataIngestionJobStatistics List<GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic>
    DataIngestionJobStatistics
    DataSourceId string
    The OCID of the data source.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A user-friendly name. Does not have to be unique, and it's changeable.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the DataIngestionJob.
    LifecycleDetails string
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DataIngestionJobStatistics []GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic
    DataIngestionJobStatistics
    DataSourceId string
    The OCID of the data source.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A user-friendly name. Does not have to be unique, and it's changeable.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the DataIngestionJob.
    LifecycleDetails string
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataIngestionJobStatistics List<GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic>
    DataIngestionJobStatistics
    dataSourceId String
    The OCID of the data source.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A user-friendly name. Does not have to be unique, and it's changeable.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the DataIngestionJob.
    lifecycleDetails String
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment in which to list resources.
    dataIngestionJobStatistics GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic[]
    DataIngestionJobStatistics
    dataSourceId string
    The OCID of the data source.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A user-friendly name. Does not have to be unique, and it's changeable.
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the DataIngestionJob.
    lifecycleDetails string
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment in which to list resources.
    data_ingestion_job_statistics Sequence[generativeai.GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic]
    DataIngestionJobStatistics
    data_source_id str
    The OCID of the data source.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A user-friendly name. Does not have to be unique, and it's changeable.
    display_name str
    A filter to return only resources that match the given display name exactly.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the DataIngestionJob.
    lifecycle_details str
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment in which to list resources.
    dataIngestionJobStatistics List<Property Map>
    DataIngestionJobStatistics
    dataSourceId String
    The OCID of the data source.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A user-friendly name. Does not have to be unique, and it's changeable.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the DataIngestionJob.
    lifecycleDetails String
    A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the data ingestion job was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the data ingestion job was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic

    DurationInSeconds int
    The duration of this ingestion job.
    NumberOfFailedFiles int
    The number of files that have failed during the ingestion.
    NumberOfIngestedFiles int
    The number of files that have been successfully ingested during the ingestion.
    DurationInSeconds int
    The duration of this ingestion job.
    NumberOfFailedFiles int
    The number of files that have failed during the ingestion.
    NumberOfIngestedFiles int
    The number of files that have been successfully ingested during the ingestion.
    durationInSeconds Integer
    The duration of this ingestion job.
    numberOfFailedFiles Integer
    The number of files that have failed during the ingestion.
    numberOfIngestedFiles Integer
    The number of files that have been successfully ingested during the ingestion.
    durationInSeconds number
    The duration of this ingestion job.
    numberOfFailedFiles number
    The number of files that have failed during the ingestion.
    numberOfIngestedFiles number
    The number of files that have been successfully ingested during the ingestion.
    duration_in_seconds int
    The duration of this ingestion job.
    number_of_failed_files int
    The number of files that have failed during the ingestion.
    number_of_ingested_files int
    The number of files that have been successfully ingested during the ingestion.
    durationInSeconds Number
    The duration of this ingestion job.
    numberOfFailedFiles Number
    The number of files that have failed during the ingestion.
    numberOfIngestedFiles Number
    The number of files that have been successfully ingested during the ingestion.

    GetAgentDataIngestionJobsFilter

    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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi