@Generated(value="OracleSDKGenerator",
comments="API Version: 20240531")
public final class DataIngestionJob
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 DataIngestionJob.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
DataIngestionJob.Builder |
static class |
DataIngestionJob.LifecycleState
The current state of the data ingestion job.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
DataIngestionJob(String id,
String displayName,
String description,
String compartmentId,
String dataSourceId,
String knowledgeBaseId,
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.
|
| 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 |
getKnowledgeBaseId()
The OCID of
the parent KnowledgeBase.
|
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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","dataSourceId","knowledgeBaseId","dataIngestionJobStatistics","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"}) public DataIngestionJob(String id, String displayName, String description, String compartmentId, String dataSourceId, String knowledgeBaseId, 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)
public static DataIngestionJob.Builder builder()
Create a new builder.
public DataIngestionJob.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDescription()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDataSourceId()
The OCID of the parent DataSource.
public String getKnowledgeBaseId()
The OCID of the parent KnowledgeBase.
public DataIngestionJobStatistics getDataIngestionJobStatistics()
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
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
public DataIngestionJob.LifecycleState getLifecycleState()
The current state of the data ingestion job.
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.
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"}
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"}}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.