OciOpenSearchIndexConfig¶
- class oci.generative_ai_agent.models.OciOpenSearchIndexConfig(**kwargs)¶
Bases:
IndexConfigThe details of customer managed OCI OpenSearch.
Attributes:
A constant which can be used with the index_config_type property of a IndexConfig.
A constant which can be used with the index_config_type property of a IndexConfig.
A constant which can be used with the index_config_type property of a IndexConfig.
[Required] Gets the cluster_id of this OciOpenSearchIndexConfig.
[Required] Gets the index_config_type of this IndexConfig.
[Required] Gets the indexes of this OciOpenSearchIndexConfig.
[Required] Gets the secret_detail of this OciOpenSearchIndexConfig.
Methods:
__init__(**kwargs)Initializes a new OciOpenSearchIndexConfig object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG = 'DEFAULT_INDEX_CONFIG'¶
A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “DEFAULT_INDEX_CONFIG”
- INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG = 'OCI_DATABASE_CONFIG'¶
A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “OCI_DATABASE_CONFIG”
- INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG = 'OCI_OPEN_SEARCH_INDEX_CONFIG'¶
A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “OCI_OPEN_SEARCH_INDEX_CONFIG”
- __init__(**kwargs)¶
Initializes a new OciOpenSearchIndexConfig object with values from keyword arguments. The default value of the
index_config_typeattribute of this class isOCI_OPEN_SEARCH_INDEX_CONFIGand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
index_config_type (str) – The value to assign to the index_config_type property of this OciOpenSearchIndexConfig. Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”
cluster_id (str) – The value to assign to the cluster_id property of this OciOpenSearchIndexConfig.
secret_detail (oci.generative_ai_agent.models.SecretDetail) – The value to assign to the secret_detail property of this OciOpenSearchIndexConfig.
indexes (list[oci.generative_ai_agent.models.Index]) – The value to assign to the indexes property of this OciOpenSearchIndexConfig.
- property cluster_id¶
[Required] Gets the cluster_id of this OciOpenSearchIndexConfig. The OCID of the OpenSearch Cluster.
- Returns
The cluster_id of this OciOpenSearchIndexConfig.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property index_config_type¶
[Required] Gets the index_config_type of this IndexConfig. The type of index.
Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The index_config_type of this IndexConfig.
- Return type
str
- property indexes¶
[Required] Gets the indexes of this OciOpenSearchIndexConfig. Index configuration for open search.
- Returns
The indexes of this OciOpenSearchIndexConfig.
- Return type
- property secret_detail¶
[Required] Gets the secret_detail of this OciOpenSearchIndexConfig.
- Returns
The secret_detail of this OciOpenSearchIndexConfig.
- Return type