OciGenAiModelAuthDetails¶
- class oci.golden_gate.models.OciGenAiModelAuthDetails(**kwargs)¶
Bases:
AiModelAuthDetailsOCI Generative AI authentication details for an AI Model connection.
Attributes:
A constant which can be used with the auth_type property of a AiModelAuthDetails.
A constant which can be used with the auth_type property of a AiModelAuthDetails.
Gets the api_key of this OciGenAiModelAuthDetails.
Gets the api_key_secret_id of this OciGenAiModelAuthDetails.
[Required] Gets the auth_type of this AiModelAuthDetails.
[Required] Gets the key_fingerprint of this OciGenAiModelAuthDetails.
Gets the region of this OciGenAiModelAuthDetails.
Gets the tenancy_id of this OciGenAiModelAuthDetails.
Gets the user_id of this OciGenAiModelAuthDetails.
Methods:
__init__(**kwargs)Initializes a new OciGenAiModelAuthDetails 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 AiModelAuthDetails. 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 AiModelAuthDetails. This constant has a value of “OCI_GEN_AI”
- __init__(**kwargs)¶
Initializes a new OciGenAiModelAuthDetails object with values from keyword arguments. The default value of the
auth_typeattribute of this class isOCI_GEN_AIand 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 OciGenAiModelAuthDetails. Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”
api_key (str) – The value to assign to the api_key property of this OciGenAiModelAuthDetails.
api_key_secret_id (str) – The value to assign to the api_key_secret_id property of this OciGenAiModelAuthDetails.
key_fingerprint (str) – The value to assign to the key_fingerprint property of this OciGenAiModelAuthDetails.
region (str) – The value to assign to the region property of this OciGenAiModelAuthDetails.
tenancy_id (str) – The value to assign to the tenancy_id property of this OciGenAiModelAuthDetails.
user_id (str) – The value to assign to the user_id property of this OciGenAiModelAuthDetails.
- property api_key¶
Gets the api_key of this OciGenAiModelAuthDetails. 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 OciGenAiModelAuthDetails.
- Return type
str
- property api_key_secret_id¶
Gets the api_key_secret_id of this OciGenAiModelAuthDetails. API key secret OCID for the AI model connection.
- Returns
The api_key_secret_id of this OciGenAiModelAuthDetails.
- Return type
str
- property auth_type¶
[Required] Gets the auth_type of this AiModelAuthDetails. Authentication type used by the AI model connection.
Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The auth_type of this AiModelAuthDetails.
- 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 key_fingerprint¶
[Required] Gets the key_fingerprint of this OciGenAiModelAuthDetails. OCI Generative AI key fingerprint.
- Returns
The key_fingerprint of this OciGenAiModelAuthDetails.
- Return type
str
- property region¶
Gets the region of this OciGenAiModelAuthDetails. The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the current region.
- Returns
The region of this OciGenAiModelAuthDetails.
- Return type
str
- property tenancy_id¶
Gets the tenancy_id of this OciGenAiModelAuthDetails. OCI Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.
- Returns
The tenancy_id of this OciGenAiModelAuthDetails.
- Return type
str
- property user_id¶
Gets the user_id of this OciGenAiModelAuthDetails. OCI Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.
- Returns
The user_id of this OciGenAiModelAuthDetails.
- Return type
str