DataIngestionJob (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiagent.model.DataIngestionJob

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class DataIngestionJob
extends ExplicitlySetBmcModel
```
DataIngestionJob

When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
Note: Objects should always be created or deserialized using the DataIngestionJob.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DataIngestionJob.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataIngestionJob.Builder

static class DataIngestionJob.LifecycleState
The current state of the data ingestion job.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataIngestionJob.Builder`
`static class`	`DataIngestionJob.LifecycleState` The current state of the data ingestion job.

Constructor Summary

Constructors
Constructor and Description
`DataIngestionJob(String id, String displayName, String description, String compartmentId, String dataSourceId, DataIngestionJobStatistics dataIngestionJobStatistics, Date timeCreated, Date timeUpdated, DataIngestionJob.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DataIngestionJob.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment.
`DataIngestionJobStatistics`	`getDataIngestionJobStatistics()`
`String`	`getDataSourceId()` The OCID of the parent DataSource.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDescription()` A user-friendly name.
`String`	`getDisplayName()` A user-friendly name.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the DataIngestionJob.
`String`	`getLifecycleDetails()` A message that describes the current state of the data ingestion job in more detail.
`DataIngestionJob.LifecycleState`	`getLifecycleState()` The current state of the data ingestion job.
`Map<String,Map<String,Object>>`	`getSystemTags()` System tags for this resource.
`Date`	`getTimeCreated()` The date and time the data ingestion job was created, in the format defined by RFC 3339.
`Date`	`getTimeUpdated()` The date and time the data ingestion job was updated, in the format defined by RFC 3339.
`int`	`hashCode()`
`DataIngestionJob.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataIngestionJob

@Deprecated
 @ConstructorProperties(value={"id","displayName","description","compartmentId","dataSourceId","dataIngestionJobStatistics","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public DataIngestionJob(String id,
                                                                                                                                                                                                                                                                            String displayName,
                                                                                                                                                                                                                                                                            String description,
                                                                                                                                                                                                                                                                            String compartmentId,
                                                                                                                                                                                                                                                                            String dataSourceId,
                                                                                                                                                                                                                                                                            DataIngestionJobStatistics dataIngestionJobStatistics,
                                                                                                                                                                                                                                                                            Date timeCreated,
                                                                                                                                                                                                                                                                            Date timeUpdated,
                                                                                                                                                                                                                                                                            DataIngestionJob.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                            String lifecycleDetails,
                                                                                                                                                                                                                                                                            Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static DataIngestionJob.Builder builder()
```
  Create a new builder.
- toBuilder
```
public DataIngestionJob.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the DataIngestionJob.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  A user-friendly name. Does not have to be unique, and it’s changeable.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment.
  
  Returns:
  
  the value
- getDataSourceId
```
public String getDataSourceId()
```
  The OCID of the parent DataSource.
  
  Returns:
  
  the value
- getDataIngestionJobStatistics
```
public DataIngestionJobStatistics getDataIngestionJobStatistics()
```
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the data ingestion job was created, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The date and time the data ingestion job was updated, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getLifecycleState
```
public DataIngestionJob.LifecycleState getLifecycleState()
```
  The current state of the data ingestion job.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  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.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  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"}
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
  
  Example: {"Operations": {"CostCenter": "42"}}
  
  Returns:
  
  the value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  System tags for this resource. Each key is predefined and scoped to a namespace.
  
  Example: {"orcl-cloud": {"free-tier-retained": "true"}}
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class ExplicitlySetBmcModel

Class DataIngestionJob

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

DataIngestionJob

Method Detail

builder

toBuilder

getId

getDisplayName

getDescription

getCompartmentId

getDataSourceId

getDataIngestionJobStatistics

getTimeCreated

getTimeUpdated

getLifecycleState

getLifecycleDetails

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode