Package com.oracle.bmc.generativeaiagentruntime.model

Class OciOpenSearchSourceLocation

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.SourceLocation

com.oracle.bmc.generativeaiagentruntime.model.OciOpenSearchSourceLocation

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class OciOpenSearchSourceLocation
extends SourceLocation

The location of the OCI Search with OpenSearch that the agent will use.
Note: Objects should always be created or deserialized using the OciOpenSearchSourceLocation.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 OciOpenSearchSourceLocation.Builder, which maintain a set of all explicitly set fields called OciOpenSearchSourceLocation.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	OciOpenSearchSourceLocation.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiagentruntime.model.SourceLocation

SourceLocation.SourceLocationType

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
OciOpenSearchSourceLocation(String id, String indexName, String url)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static OciOpenSearchSourceLocation.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getId()	The OCID of the OCI OpenSearch cluster.
String	getIndexName()	The name of the index in OpenSearch that contains the source text.
String	getUrl()	The URL of the retrieved document, if available.
int	hashCode()
OciOpenSearchSourceLocation.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

OciOpenSearchSourceLocation

@Deprecated
public OciOpenSearchSourceLocation(String id,
                                   String indexName,
                                   String url)

Deprecated.

Method Detail

builder

public static OciOpenSearchSourceLocation.Builder builder()

Create a new builder.

toBuilder

public OciOpenSearchSourceLocation.Builder toBuilder()

getId

public String getId()

The OCID of the OCI OpenSearch cluster.

Returns:

the value

getIndexName

public String getIndexName()

The name of the index in OpenSearch that contains the source text.

Returns:

the value

getUrl

public String getUrl()

The URL of the retrieved document, if available.

Returns:

the value

toString

public String toString()

Overrides:

toString in class SourceLocation

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class SourceLocation

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class SourceLocation

hashCode

public int hashCode()

Overrides:

hashCode in class SourceLocation