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

oci.GenerativeAi.getAgentDataIngestionJob

Explore with Pulumi AI

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

    This data source provides details about a specific Data Ingestion Job resource in Oracle Cloud Infrastructure Generative Ai Agent service.

    GetDataIngestionJob

    Gets information about a data ingestion job.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDataIngestionJob = oci.GenerativeAi.getAgentDataIngestionJob({
        dataIngestionJobId: testDataIngestionJobOciGenerativeAiAgentDataIngestionJob.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_data_ingestion_job = oci.GenerativeAi.get_agent_data_ingestion_job(data_ingestion_job_id=test_data_ingestion_job_oci_generative_ai_agent_data_ingestion_job["id"])
    
    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.GetAgentDataIngestionJob(ctx, &generativeai.GetAgentDataIngestionJobArgs{
    			DataIngestionJobId: testDataIngestionJobOciGenerativeAiAgentDataIngestionJob.Id,
    		}, 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 testDataIngestionJob = Oci.GenerativeAi.GetAgentDataIngestionJob.Invoke(new()
        {
            DataIngestionJobId = testDataIngestionJobOciGenerativeAiAgentDataIngestionJob.Id,
        });
    
    });
    
    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.GetAgentDataIngestionJobArgs;
    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 testDataIngestionJob = GenerativeAiFunctions.getAgentDataIngestionJob(GetAgentDataIngestionJobArgs.builder()
                .dataIngestionJobId(testDataIngestionJobOciGenerativeAiAgentDataIngestionJob.id())
                .build());
    
        }
    }
    
    variables:
      testDataIngestionJob:
        fn::invoke:
          Function: oci:GenerativeAi:getAgentDataIngestionJob
          Arguments:
            dataIngestionJobId: ${testDataIngestionJobOciGenerativeAiAgentDataIngestionJob.id}
    

    Using getAgentDataIngestionJob

    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 getAgentDataIngestionJob(args: GetAgentDataIngestionJobArgs, opts?: InvokeOptions): Promise<GetAgentDataIngestionJobResult>
    function getAgentDataIngestionJobOutput(args: GetAgentDataIngestionJobOutputArgs, opts?: InvokeOptions): Output<GetAgentDataIngestionJobResult>
    def get_agent_data_ingestion_job(data_ingestion_job_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAgentDataIngestionJobResult
    def get_agent_data_ingestion_job_output(data_ingestion_job_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetAgentDataIngestionJobResult]
    func GetAgentDataIngestionJob(ctx *Context, args *GetAgentDataIngestionJobArgs, opts ...InvokeOption) (*GetAgentDataIngestionJobResult, error)
    func GetAgentDataIngestionJobOutput(ctx *Context, args *GetAgentDataIngestionJobOutputArgs, opts ...InvokeOption) GetAgentDataIngestionJobResultOutput

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

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

    The following arguments are supported:

    DataIngestionJobId string
    The OCID of the data ingestion job.
    DataIngestionJobId string
    The OCID of the data ingestion job.
    dataIngestionJobId String
    The OCID of the data ingestion job.
    dataIngestionJobId string
    The OCID of the data ingestion job.
    data_ingestion_job_id str
    The OCID of the data ingestion job.
    dataIngestionJobId String
    The OCID of the data ingestion job.

    getAgentDataIngestionJob Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    DataIngestionJobId string
    DataIngestionJobStatistics List<GetAgentDataIngestionJobDataIngestionJobStatistic>
    DataIngestionJobStatistics
    DataSourceId string
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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.
    DataIngestionJobId string
    DataIngestionJobStatistics []GetAgentDataIngestionJobDataIngestionJobStatistic
    DataIngestionJobStatistics
    DataSourceId string
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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.
    dataIngestionJobId String
    dataIngestionJobStatistics List<GetAgentDataIngestionJobDataIngestionJobStatistic>
    DataIngestionJobStatistics
    dataSourceId String
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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.
    dataIngestionJobId string
    dataIngestionJobStatistics GetAgentDataIngestionJobDataIngestionJobStatistic[]
    DataIngestionJobStatistics
    dataSourceId string
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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.
    data_ingestion_job_id str
    data_ingestion_job_statistics Sequence[generativeai.GetAgentDataIngestionJobDataIngestionJobStatistic]
    DataIngestionJobStatistics
    data_source_id str
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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.
    dataIngestionJobId String
    dataIngestionJobStatistics List<Property Map>
    DataIngestionJobStatistics
    dataSourceId String
    The OCID of the parent DataSource.
    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 user-friendly name. Does not have to be unique, and it's changeable.
    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
    The current state of the data ingestion job.
    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

    Supporting Types

    GetAgentDataIngestionJobDataIngestionJobStatistic

    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.

    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