CreateApiKeyAiModelAuthDetails¶
- class oci.golden_gate.models.CreateApiKeyAiModelAuthDetails(**kwargs)¶
Bases:
CreateAiModelAuthDetailsThe information about new API key authentication details for an AI Model connection.
Attributes:
A constant which can be used with the auth_type property of a CreateAiModelAuthDetails.
A constant which can be used with the auth_type property of a CreateAiModelAuthDetails.
Gets the api_key of this CreateApiKeyAiModelAuthDetails.
Gets the api_key_secret_id of this CreateApiKeyAiModelAuthDetails.
[Required] Gets the auth_type of this CreateAiModelAuthDetails.
Gets the base_url of this CreateApiKeyAiModelAuthDetails.
Methods:
__init__(**kwargs)Initializes a new CreateApiKeyAiModelAuthDetails 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.
- AUTH_TYPE_API_KEY = 'API_KEY'¶
A constant which can be used with the auth_type property of a CreateAiModelAuthDetails. This constant has a value of “API_KEY”
- AUTH_TYPE_OCI_GEN_AI = 'OCI_GEN_AI'¶
A constant which can be used with the auth_type property of a CreateAiModelAuthDetails. This constant has a value of “OCI_GEN_AI”
- __init__(**kwargs)¶
Initializes a new CreateApiKeyAiModelAuthDetails object with values from keyword arguments. The default value of the
auth_typeattribute of this class isAPI_KEYand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
auth_type (str) – The value to assign to the auth_type property of this CreateApiKeyAiModelAuthDetails. Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”
base_url (str) – The value to assign to the base_url property of this CreateApiKeyAiModelAuthDetails.
api_key (str) – The value to assign to the api_key property of this CreateApiKeyAiModelAuthDetails.
api_key_secret_id (str) – The value to assign to the api_key_secret_id property of this CreateApiKeyAiModelAuthDetails.
- property api_key¶
Gets the api_key of this CreateApiKeyAiModelAuthDetails. API key for the AI model connection. Deprecated: This field is deprecated and replaced by “apiKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Returns
The api_key of this CreateApiKeyAiModelAuthDetails.
- Return type
str
- property api_key_secret_id¶
Gets the api_key_secret_id of this CreateApiKeyAiModelAuthDetails. API key secret OCID for the AI model connection.
- Returns
The api_key_secret_id of this CreateApiKeyAiModelAuthDetails.
- Return type
str
- property auth_type¶
[Required] Gets the auth_type of this CreateAiModelAuthDetails. Authentication type used by the AI model connection.
Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”
- Returns
The auth_type of this CreateAiModelAuthDetails.
- Return type
str
- property base_url¶
Gets the base_url of this CreateApiKeyAiModelAuthDetails. Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used.
- Returns
The base_url of this CreateApiKeyAiModelAuthDetails.
- 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.