UpdateApiKeyDetails

class oci.generative_ai.models.UpdateApiKeyDetails(**kwargs)

Bases: object

The data to update an API key.

Methods:

__init__(**kwargs)

Initializes a new UpdateApiKeyDetails object with values from keyword arguments.

Attributes:

defined_tags

Gets the defined_tags of this UpdateApiKeyDetails.

description

Gets the description of this UpdateApiKeyDetails.

display_name

Gets the display_name of this UpdateApiKeyDetails.

freeform_tags

Gets the freeform_tags of this UpdateApiKeyDetails.

__init__(**kwargs)

Initializes a new UpdateApiKeyDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this UpdateApiKeyDetails.

  • description (str) – The value to assign to the description property of this UpdateApiKeyDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateApiKeyDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateApiKeyDetails.

property defined_tags

Gets the defined_tags of this UpdateApiKeyDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this UpdateApiKeyDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this UpdateApiKeyDetails. An optional description of the Api key.

Returns

The description of this UpdateApiKeyDetails.

Return type

str

property display_name

Gets the display_name of this UpdateApiKeyDetails. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns

The display_name of this UpdateApiKeyDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this UpdateApiKeyDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this UpdateApiKeyDetails.

Return type

dict(str, str)