File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/generative_ai/models/api_key.py

Back
# coding: utf-8 # Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. # NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20231130 from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 from oci.decorators import init_model_state_from_kwargs @init_model_state_from_kwargs class ApiKey(object): """ ApiKeys are resources used to access GenAI models. You must be authorized through an IAM policy to use any API operations. If you're not authorized, contact an administrator who manages OCI resource access. See `Getting Started with Policies`__ and `Getting Access to Generative AI Resources`__. __ https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm __ https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm """ #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "UPDATING" LIFECYCLE_STATE_UPDATING = "UPDATING" #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" #: A constant which can be used with the lifecycle_state property of a ApiKey. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, kwargs): """ Initializes a new ApiKey object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param id: The value to assign to the id property of this ApiKey. :type id: str :param display_name: The value to assign to the display_name property of this ApiKey. :type display_name: str :param description: The value to assign to the description property of this ApiKey. :type description: str :param compartment_id: The value to assign to the compartment_id property of this ApiKey. :type compartment_id: str :param time_created: The value to assign to the time_created property of this ApiKey. :type time_created: datetime :param time_updated: The value to assign to the time_updated property of this ApiKey. :type time_updated: datetime :param keys: The value to assign to the keys property of this ApiKey. :type keys: list[oci.generative_ai.models.ApiKeyItem] :param lifecycle_state: The value to assign to the lifecycle_state property of this ApiKey. Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str :param lifecycle_details: The value to assign to the lifecycle_details property of this ApiKey. :type lifecycle_details: str :param freeform_tags: The value to assign to the freeform_tags property of this ApiKey. :type freeform_tags: dict(str, str) :param defined_tags: The value to assign to the defined_tags property of this ApiKey. :type defined_tags: dict(str, dict(str, object)) :param system_tags: The value to assign to the system_tags property of this ApiKey. :type system_tags: dict(str, dict(str, object)) """ self.swagger_types = { 'id': 'str', 'display_name': 'str', 'description': 'str', 'compartment_id': 'str', 'time_created': 'datetime', 'time_updated': 'datetime', 'keys': 'list[ApiKeyItem]', 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))' } self.attribute_map = { 'id': 'id', 'display_name': 'displayName', 'description': 'description', 'compartment_id': 'compartmentId', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'keys': 'keys', 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags' } self._id = None self._display_name = None self._description = None self._compartment_id = None self._time_created = None self._time_updated = None self._keys = None self._lifecycle_state = None self._lifecycle_details = None self._freeform_tags = None self._defined_tags = None self._system_tags = None @property def id(self): """ [Required] Gets the id of this ApiKey. the ApiKey id. :return: The id of this ApiKey. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this ApiKey. the ApiKey id. :param id: The id of this ApiKey. :type: str """ self._id = id @property def display_name(self): """ [Required] Gets the display_name of this ApiKey. A user-friendly name. Does not have to be unique, and it's changeable. :return: The display_name of this ApiKey. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this ApiKey. A user-friendly name. Does not have to be unique, and it's changeable. :param display_name: The display_name of this ApiKey. :type: str """ self._display_name = display_name @property def description(self): """ Gets the description of this ApiKey. An optional description of the Api key. :return: The description of this ApiKey. :rtype: str """ return self._description @description.setter def description(self, description): """ Sets the description of this ApiKey. An optional description of the Api key. :param description: The description of this ApiKey. :type: str """ self._description = description @property def compartment_id(self): """ [Required] Gets the compartment_id of this ApiKey. The compartment OCID to create the apiKey in. :return: The compartment_id of this ApiKey. :rtype: str """ return self._compartment_id @compartment_id.setter def compartment_id(self, compartment_id): """ Sets the compartment_id of this ApiKey. The compartment OCID to create the apiKey in. :param compartment_id: The compartment_id of this ApiKey. :type: str """ self._compartment_id = compartment_id @property def time_created(self): """ [Required] Gets the time_created of this ApiKey. The date and time that the ApiKey was created in the format of an RFC3339 datetime string. :return: The time_created of this ApiKey. :rtype: datetime """ return self._time_created @time_created.setter def time_created(self, time_created): """ Sets the time_created of this ApiKey. The date and time that the ApiKey was created in the format of an RFC3339 datetime string. :param time_created: The time_created of this ApiKey. :type: datetime """ self._time_created = time_created @property def time_updated(self): """ Gets the time_updated of this ApiKey. The date and time the ApiKey was updated, in the format defined by RFC 3339. :return: The time_updated of this ApiKey. :rtype: datetime """ return self._time_updated @time_updated.setter def time_updated(self, time_updated): """ Sets the time_updated of this ApiKey. The date and time the ApiKey was updated, in the format defined by RFC 3339. :param time_updated: The time_updated of this ApiKey. :type: datetime """ self._time_updated = time_updated @property def keys(self): """ [Required] Gets the keys of this ApiKey. The list of keys. :return: The keys of this ApiKey. :rtype: list[oci.generative_ai.models.ApiKeyItem] """ return self._keys @keys.setter def keys(self, keys): """ Sets the keys of this ApiKey. The list of keys. :param keys: The keys of this ApiKey. :type: list[oci.generative_ai.models.ApiKeyItem] """ self._keys = keys @property def lifecycle_state(self): """ [Required]** Gets the lifecycle_state of this ApiKey. The current state of the API key. Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_state of this ApiKey. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ApiKey. The current state of the API key. :param lifecycle_state: The lifecycle_state of this ApiKey. :type: str """ allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @property def lifecycle_details(self): """ Gets the lifecycle_details of this ApiKey. A message describing the current state with detail that can provide actionable information. :return: The lifecycle_details of this ApiKey. :rtype: str """ return self._lifecycle_details @lifecycle_details.setter def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this ApiKey. A message describing the current state with detail that can provide actionable information. :param lifecycle_details: The lifecycle_details of this ApiKey. :type: str """ self._lifecycle_details = lifecycle_details @property def freeform_tags(self): """ Gets the freeform_tags of this ApiKey. 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\"}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this ApiKey. :rtype: dict(str, str) """ return self._freeform_tags @freeform_tags.setter def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this ApiKey. 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\"}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this ApiKey. :type: dict(str, str) """ self._freeform_tags = freeform_tags @property def defined_tags(self): """ Gets the defined_tags of this ApiKey. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this ApiKey. :rtype: dict(str, dict(str, object)) """ return self._defined_tags @defined_tags.setter def defined_tags(self, defined_tags): """ Sets the defined_tags of this ApiKey. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this ApiKey. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags @property def system_tags(self): """ Gets the system_tags of this ApiKey. System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :return: The system_tags of this ApiKey. :rtype: dict(str, dict(str, object)) """ return self._system_tags @system_tags.setter def system_tags(self, system_tags): """ Sets the system_tags of this ApiKey. System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :param system_tags: The system_tags of this ApiKey. :type: dict(str, dict(str, object)) """ self._system_tags = system_tags def __repr__(self): return formatted_flat_dict(self) def __eq__(self, other): if other is None: return False return self.__dict__ == other.__dict__ def __ne__(self, other): return not self == other

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.06 | proxy | phpinfo | Settings