@Generated(value="OracleSDKGenerator",
comments="API Version: 20240531")
public final class DataSource
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
DataSource
A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data.
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 DataSource.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 DataSource.Builder, which maintain a
set of all explicitly set fields called DataSource.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 |
DataSource.Builder |
static class |
DataSource.LifecycleState
The current state of the data source.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
DataSource(String id,
String displayName,
String description,
String compartmentId,
String knowledgeBaseId,
DataSourceConfig dataSourceConfig,
Date timeCreated,
Date timeUpdated,
DataSource.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 DataSource.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of
the compartment.
|
DataSourceConfig |
getDataSourceConfig() |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A description of the data source.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of
the data source.
|
String |
getKnowledgeBaseId()
The OCID of
the parent KnowledgeBase.
|
String |
getLifecycleDetails()
A message that describes the current state of the data source in more detail.
|
DataSource.LifecycleState |
getLifecycleState()
The current state of the data source.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the data source was created, in the format defined by RFC
3339.
|
Date |
getTimeUpdated()
The date and time the data source was updated, in the format defined by RFC
3339.
|
int |
hashCode() |
DataSource.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","knowledgeBaseId","dataSourceConfig","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"}) public DataSource(String id, String displayName, String description, String compartmentId, String knowledgeBaseId, DataSourceConfig dataSourceConfig, Date timeCreated, Date timeUpdated, DataSource.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static DataSource.Builder builder()
Create a new builder.
public DataSource.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDescription()
A description of the data source.
public String getKnowledgeBaseId()
The OCID of the parent KnowledgeBase.
public DataSourceConfig getDataSourceConfig()
public Date getTimeCreated()
The date and time the data source 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 source was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
public DataSource.LifecycleState getLifecycleState()
The current state of the data source.
public String getLifecycleDetails()
A message that describes the current state of the data source 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.