Package com.oracle.bmc.generativeaiagentruntime.model

Class KnowledgeBaseMetadataSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagentruntime.model.KnowledgeBaseMetadataSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class KnowledgeBaseMetadataSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Represents metadata about a field including its name, type, supported operations, and possible values.
Note: Objects should always be created or deserialized using the KnowledgeBaseMetadataSummary.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 KnowledgeBaseMetadataSummary.Builder, which maintain a set of all explicitly set fields called KnowledgeBaseMetadataSummary.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnowledgeBaseMetadataSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
KnowledgeBaseMetadataSummary(String name, String type, List<String> operations, List<KnowledgeBaseMetadataValue> values, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseMetadataSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getName()	The name of the field
List<String>	getOperations()	List of supported operations for this field (e.g., “equals”, “in”, “contains”)
Map<String,Map<String,Object>>	getSystemTags()	System tags for this resource.
String	getType()	The data type of the field (e.g., “array”, “number”, “string”)
List<KnowledgeBaseMetadataValue>	getValues()	List of metadata values available in the knowledge base along with the matching documents count.
int	hashCode()
KnowledgeBaseMetadataSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeBaseMetadataSummary

@Deprecated
@ConstructorProperties({"name","type","operations","values","freeformTags","definedTags","systemTags"})
public KnowledgeBaseMetadataSummary(String name,
                                    String type,
                                    List<String> operations,
                                    List<KnowledgeBaseMetadataValue> values,
                                    Map<String,String> freeformTags,
                                    Map<String,Map<String,Object>> definedTags,
                                    Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static KnowledgeBaseMetadataSummary.Builder builder()

Create a new builder.

toBuilder

public KnowledgeBaseMetadataSummary.Builder toBuilder()

getName

public String getName()

The name of the field

Returns:

the value

getType

public String getType()

The data type of the field (e.g., “array”, “number”, “string”)

Returns:

the value

getOperations

public List<String> getOperations()

List of supported operations for this field (e.g., “equals”, “in”, “contains”)

Returns:

the value

getValues

public List<KnowledgeBaseMetadataValue> getValues()

List of metadata values available in the knowledge base along with the matching documents count.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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. Example: {“foo-namespace”: {“bar-key”: “value”}}

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 com.oracle.bmc.http.client.internal.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 com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel