CreateOciGenAiModelAuthDetails¶

class oci.golden_gate.models.CreateOciGenAiModelAuthDetails(**kwargs)¶

Bases: oci.golden_gate.models.create_ai_model_auth_details.CreateAiModelAuthDetails

The information about new OCI Generative AI authentication details for an AI Model connection.

Attributes

`AUTH_TYPE_API_KEY`	str(object=’’) -> str
`AUTH_TYPE_OCI_GEN_AI`	str(object=’’) -> str
`api_key`	Gets the api_key of this CreateOciGenAiModelAuthDetails.
`api_key_secret_id`	Gets the api_key_secret_id of this CreateOciGenAiModelAuthDetails.
`auth_type`	[Required] Gets the auth_type of this CreateAiModelAuthDetails.
`key_fingerprint`	[Required] Gets the key_fingerprint of this CreateOciGenAiModelAuthDetails.
`region`	Gets the region of this CreateOciGenAiModelAuthDetails.
`tenancy_id`	Gets the tenancy_id of this CreateOciGenAiModelAuthDetails.
`user_id`	Gets the user_id of this CreateOciGenAiModelAuthDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateOciGenAiModelAuthDetails 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'¶

AUTH_TYPE_OCI_GEN_AI = 'OCI_GEN_AI'¶

__init__(**kwargs)¶

Initializes a new CreateOciGenAiModelAuthDetails object with values from keyword arguments. The default value of the auth_type attribute of this class is OCI_GEN_AI and 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 CreateOciGenAiModelAuthDetails. 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 CreateOciGenAiModelAuthDetails.
api_key_secret_id (str) – The value to assign to the api_key_secret_id property of this CreateOciGenAiModelAuthDetails.
key_fingerprint (str) – The value to assign to the key_fingerprint property of this CreateOciGenAiModelAuthDetails.
region (str) – The value to assign to the region property of this CreateOciGenAiModelAuthDetails.
tenancy_id (str) – The value to assign to the tenancy_id property of this CreateOciGenAiModelAuthDetails.
user_id (str) – The value to assign to the user_id property of this CreateOciGenAiModelAuthDetails.

api_key¶

Gets the api_key of this CreateOciGenAiModelAuthDetails. 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 CreateOciGenAiModelAuthDetails.
Return type:	str

api_key_secret_id¶

Gets the api_key_secret_id of this CreateOciGenAiModelAuthDetails. API key secret OCID for the AI model connection.

Returns:	The api_key_secret_id of this CreateOciGenAiModelAuthDetails.
Return type:	str

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

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.

key_fingerprint¶

[Required] Gets the key_fingerprint of this CreateOciGenAiModelAuthDetails. OCI Generative AI key fingerprint.

Returns:	The key_fingerprint of this CreateOciGenAiModelAuthDetails.
Return type:	str

region¶

Gets the region of this CreateOciGenAiModelAuthDetails. The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Returns:	The region of this CreateOciGenAiModelAuthDetails.
Return type:	str

tenancy_id¶

Gets the tenancy_id of this CreateOciGenAiModelAuthDetails. 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 CreateOciGenAiModelAuthDetails.
Return type:	str

user_id¶

Gets the user_id of this CreateOciGenAiModelAuthDetails. 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 CreateOciGenAiModelAuthDetails.
Return type:	str