OciGenAiModelAuthDetailsSummary¶

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

Bases: oci.golden_gate.models.ai_model_auth_details_summary.AiModelAuthDetailsSummary

Summary of 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_secret_id`	Gets the api_key_secret_id of this OciGenAiModelAuthDetailsSummary.
`auth_type`	[Required] Gets the auth_type of this AiModelAuthDetailsSummary.
`key_fingerprint`	[Required] Gets the key_fingerprint of this OciGenAiModelAuthDetailsSummary.
`region`	Gets the region of this OciGenAiModelAuthDetailsSummary.
`tenancy_id`	Gets the tenancy_id of this OciGenAiModelAuthDetailsSummary.
`user_id`	Gets the user_id of this OciGenAiModelAuthDetailsSummary.

Methods

`__init__`(**kwargs)	Initializes a new OciGenAiModelAuthDetailsSummary 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 OciGenAiModelAuthDetailsSummary 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 OciGenAiModelAuthDetailsSummary. Allowed values for this property are: “OCI_GEN_AI”, “API_KEY”
api_key_secret_id (str) – The value to assign to the api_key_secret_id property of this OciGenAiModelAuthDetailsSummary.
key_fingerprint (str) – The value to assign to the key_fingerprint property of this OciGenAiModelAuthDetailsSummary.
region (str) – The value to assign to the region property of this OciGenAiModelAuthDetailsSummary.
tenancy_id (str) – The value to assign to the tenancy_id property of this OciGenAiModelAuthDetailsSummary.
user_id (str) – The value to assign to the user_id property of this OciGenAiModelAuthDetailsSummary.

api_key_secret_id¶

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

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

auth_type¶

[Required] Gets the auth_type of this AiModelAuthDetailsSummary. 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 AiModelAuthDetailsSummary.
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 OciGenAiModelAuthDetailsSummary. OCI Generative AI key fingerprint.

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

region¶

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

tenancy_id¶

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

user_id¶

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