File: //proc/self/root/lib/mysqlsh/lib/python3.8/site-packages/oci/vault/models/secret_summary.py
# coding: utf-8
# Copyright (c) 2016, 2025, 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: 20180608
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 SecretSummary(object):
"""
The details of the secret, excluding the contents of the secret.
"""
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "SCHEDULING_DELETION"
LIFECYCLE_STATE_SCHEDULING_DELETION = "SCHEDULING_DELETION"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "PENDING_DELETION"
LIFECYCLE_STATE_PENDING_DELETION = "PENDING_DELETION"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "CANCELLING_DELETION"
LIFECYCLE_STATE_CANCELLING_DELETION = "CANCELLING_DELETION"
#: A constant which can be used with the lifecycle_state property of a SecretSummary.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new SecretSummary object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param compartment_id:
The value to assign to the compartment_id property of this SecretSummary.
:type compartment_id: str
:param defined_tags:
The value to assign to the defined_tags property of this SecretSummary.
:type defined_tags: dict(str, dict(str, object))
:param description:
The value to assign to the description property of this SecretSummary.
:type description: str
:param freeform_tags:
The value to assign to the freeform_tags property of this SecretSummary.
:type freeform_tags: dict(str, str)
:param system_tags:
The value to assign to the system_tags property of this SecretSummary.
:type system_tags: dict(str, dict(str, object))
:param key_id:
The value to assign to the key_id property of this SecretSummary.
:type key_id: str
:param id:
The value to assign to the id property of this SecretSummary.
:type id: str
:param lifecycle_details:
The value to assign to the lifecycle_details property of this SecretSummary.
:type lifecycle_details: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this SecretSummary.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "SCHEDULING_DELETION", "PENDING_DELETION", "CANCELLING_DELETION", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param rotation_config:
The value to assign to the rotation_config property of this SecretSummary.
:type rotation_config: oci.vault.models.RotationConfig
:param rotation_status:
The value to assign to the rotation_status property of this SecretSummary.
:type rotation_status: str
:param last_rotation_time:
The value to assign to the last_rotation_time property of this SecretSummary.
:type last_rotation_time: datetime
:param next_rotation_time:
The value to assign to the next_rotation_time property of this SecretSummary.
:type next_rotation_time: datetime
:param secret_name:
The value to assign to the secret_name property of this SecretSummary.
:type secret_name: str
:param time_created:
The value to assign to the time_created property of this SecretSummary.
:type time_created: datetime
:param time_of_current_version_expiry:
The value to assign to the time_of_current_version_expiry property of this SecretSummary.
:type time_of_current_version_expiry: datetime
:param time_of_deletion:
The value to assign to the time_of_deletion property of this SecretSummary.
:type time_of_deletion: datetime
:param vault_id:
The value to assign to the vault_id property of this SecretSummary.
:type vault_id: str
:param secret_generation_context:
The value to assign to the secret_generation_context property of this SecretSummary.
:type secret_generation_context: oci.vault.models.SecretGenerationContext
:param is_auto_generation_enabled:
The value to assign to the is_auto_generation_enabled property of this SecretSummary.
:type is_auto_generation_enabled: bool
"""
self.swagger_types = {
'compartment_id': 'str',
'defined_tags': 'dict(str, dict(str, object))',
'description': 'str',
'freeform_tags': 'dict(str, str)',
'system_tags': 'dict(str, dict(str, object))',
'key_id': 'str',
'id': 'str',
'lifecycle_details': 'str',
'lifecycle_state': 'str',
'rotation_config': 'RotationConfig',
'rotation_status': 'str',
'last_rotation_time': 'datetime',
'next_rotation_time': 'datetime',
'secret_name': 'str',
'time_created': 'datetime',
'time_of_current_version_expiry': 'datetime',
'time_of_deletion': 'datetime',
'vault_id': 'str',
'secret_generation_context': 'SecretGenerationContext',
'is_auto_generation_enabled': 'bool'
}
self.attribute_map = {
'compartment_id': 'compartmentId',
'defined_tags': 'definedTags',
'description': 'description',
'freeform_tags': 'freeformTags',
'system_tags': 'systemTags',
'key_id': 'keyId',
'id': 'id',
'lifecycle_details': 'lifecycleDetails',
'lifecycle_state': 'lifecycleState',
'rotation_config': 'rotationConfig',
'rotation_status': 'rotationStatus',
'last_rotation_time': 'lastRotationTime',
'next_rotation_time': 'nextRotationTime',
'secret_name': 'secretName',
'time_created': 'timeCreated',
'time_of_current_version_expiry': 'timeOfCurrentVersionExpiry',
'time_of_deletion': 'timeOfDeletion',
'vault_id': 'vaultId',
'secret_generation_context': 'secretGenerationContext',
'is_auto_generation_enabled': 'isAutoGenerationEnabled'
}
self._compartment_id = None
self._defined_tags = None
self._description = None
self._freeform_tags = None
self._system_tags = None
self._key_id = None
self._id = None
self._lifecycle_details = None
self._lifecycle_state = None
self._rotation_config = None
self._rotation_status = None
self._last_rotation_time = None
self._next_rotation_time = None
self._secret_name = None
self._time_created = None
self._time_of_current_version_expiry = None
self._time_of_deletion = None
self._vault_id = None
self._secret_generation_context = None
self._is_auto_generation_enabled = None
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this SecretSummary.
The OCID of the compartment that contains the secret.
:return: The compartment_id of this SecretSummary.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this SecretSummary.
The OCID of the compartment that contains the secret.
:param compartment_id: The compartment_id of this SecretSummary.
:type: str
"""
self._compartment_id = compartment_id
@property
def defined_tags(self):
"""
Gets the defined_tags of this SecretSummary.
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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this SecretSummary.
: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 SecretSummary.
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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this SecretSummary.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def description(self):
"""
Gets the description of this SecretSummary.
A brief description of the secret.
:return: The description of this SecretSummary.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this SecretSummary.
A brief description of the secret.
:param description: The description of this SecretSummary.
:type: str
"""
self._description = description
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this SecretSummary.
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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this SecretSummary.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this SecretSummary.
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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this SecretSummary.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def system_tags(self):
"""
Gets the system_tags of this SecretSummary.
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 SecretSummary.
: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 SecretSummary.
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 SecretSummary.
:type: dict(str, dict(str, object))
"""
self._system_tags = system_tags
@property
def key_id(self):
"""
Gets the key_id of this SecretSummary.
The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.
:return: The key_id of this SecretSummary.
:rtype: str
"""
return self._key_id
@key_id.setter
def key_id(self, key_id):
"""
Sets the key_id of this SecretSummary.
The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.
:param key_id: The key_id of this SecretSummary.
:type: str
"""
self._key_id = key_id
@property
def id(self):
"""
**[Required]** Gets the id of this SecretSummary.
The OCID of the secret.
:return: The id of this SecretSummary.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this SecretSummary.
The OCID of the secret.
:param id: The id of this SecretSummary.
:type: str
"""
self._id = id
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this SecretSummary.
Additional information about the secret's current lifecycle state.
:return: The lifecycle_details of this SecretSummary.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this SecretSummary.
Additional information about the secret's current lifecycle state.
:param lifecycle_details: The lifecycle_details of this SecretSummary.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this SecretSummary.
The current lifecycle state of the secret.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "SCHEDULING_DELETION", "PENDING_DELETION", "CANCELLING_DELETION", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this SecretSummary.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this SecretSummary.
The current lifecycle state of the secret.
:param lifecycle_state: The lifecycle_state of this SecretSummary.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "SCHEDULING_DELETION", "PENDING_DELETION", "CANCELLING_DELETION", "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 rotation_config(self):
"""
Gets the rotation_config of this SecretSummary.
:return: The rotation_config of this SecretSummary.
:rtype: oci.vault.models.RotationConfig
"""
return self._rotation_config
@rotation_config.setter
def rotation_config(self, rotation_config):
"""
Sets the rotation_config of this SecretSummary.
:param rotation_config: The rotation_config of this SecretSummary.
:type: oci.vault.models.RotationConfig
"""
self._rotation_config = rotation_config
@property
def rotation_status(self):
"""
Gets the rotation_status of this SecretSummary.
Additional information about the status of the secret rotation
:return: The rotation_status of this SecretSummary.
:rtype: str
"""
return self._rotation_status
@rotation_status.setter
def rotation_status(self, rotation_status):
"""
Sets the rotation_status of this SecretSummary.
Additional information about the status of the secret rotation
:param rotation_status: The rotation_status of this SecretSummary.
:type: str
"""
self._rotation_status = rotation_status
@property
def last_rotation_time(self):
"""
Gets the last_rotation_time of this SecretSummary.
A property indicating when the secret was last rotated successfully, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The last_rotation_time of this SecretSummary.
:rtype: datetime
"""
return self._last_rotation_time
@last_rotation_time.setter
def last_rotation_time(self, last_rotation_time):
"""
Sets the last_rotation_time of this SecretSummary.
A property indicating when the secret was last rotated successfully, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param last_rotation_time: The last_rotation_time of this SecretSummary.
:type: datetime
"""
self._last_rotation_time = last_rotation_time
@property
def next_rotation_time(self):
"""
Gets the next_rotation_time of this SecretSummary.
A property indicating when the secret is scheduled to be rotated, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The next_rotation_time of this SecretSummary.
:rtype: datetime
"""
return self._next_rotation_time
@next_rotation_time.setter
def next_rotation_time(self, next_rotation_time):
"""
Sets the next_rotation_time of this SecretSummary.
A property indicating when the secret is scheduled to be rotated, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param next_rotation_time: The next_rotation_time of this SecretSummary.
:type: datetime
"""
self._next_rotation_time = next_rotation_time
@property
def secret_name(self):
"""
**[Required]** Gets the secret_name of this SecretSummary.
The name of the secret.
:return: The secret_name of this SecretSummary.
:rtype: str
"""
return self._secret_name
@secret_name.setter
def secret_name(self, secret_name):
"""
Sets the secret_name of this SecretSummary.
The name of the secret.
:param secret_name: The secret_name of this SecretSummary.
:type: str
"""
self._secret_name = secret_name
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this SecretSummary.
A property indicating when the secret was created, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_created of this SecretSummary.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this SecretSummary.
A property indicating when the secret was created, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_created: The time_created of this SecretSummary.
:type: datetime
"""
self._time_created = time_created
@property
def time_of_current_version_expiry(self):
"""
Gets the time_of_current_version_expiry of this SecretSummary.
An optional property indicating when the current secret version will expire, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_of_current_version_expiry of this SecretSummary.
:rtype: datetime
"""
return self._time_of_current_version_expiry
@time_of_current_version_expiry.setter
def time_of_current_version_expiry(self, time_of_current_version_expiry):
"""
Sets the time_of_current_version_expiry of this SecretSummary.
An optional property indicating when the current secret version will expire, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_of_current_version_expiry: The time_of_current_version_expiry of this SecretSummary.
:type: datetime
"""
self._time_of_current_version_expiry = time_of_current_version_expiry
@property
def time_of_deletion(self):
"""
Gets the time_of_deletion of this SecretSummary.
An optional property indicating when to delete the secret, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_of_deletion of this SecretSummary.
:rtype: datetime
"""
return self._time_of_deletion
@time_of_deletion.setter
def time_of_deletion(self, time_of_deletion):
"""
Sets the time_of_deletion of this SecretSummary.
An optional property indicating when to delete the secret, expressed in `RFC 3339`__ timestamp format.
Example: `2019-04-03T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_of_deletion: The time_of_deletion of this SecretSummary.
:type: datetime
"""
self._time_of_deletion = time_of_deletion
@property
def vault_id(self):
"""
**[Required]** Gets the vault_id of this SecretSummary.
The OCID of the Vault in which the secret exists
:return: The vault_id of this SecretSummary.
:rtype: str
"""
return self._vault_id
@vault_id.setter
def vault_id(self, vault_id):
"""
Sets the vault_id of this SecretSummary.
The OCID of the Vault in which the secret exists
:param vault_id: The vault_id of this SecretSummary.
:type: str
"""
self._vault_id = vault_id
@property
def secret_generation_context(self):
"""
Gets the secret_generation_context of this SecretSummary.
:return: The secret_generation_context of this SecretSummary.
:rtype: oci.vault.models.SecretGenerationContext
"""
return self._secret_generation_context
@secret_generation_context.setter
def secret_generation_context(self, secret_generation_context):
"""
Sets the secret_generation_context of this SecretSummary.
:param secret_generation_context: The secret_generation_context of this SecretSummary.
:type: oci.vault.models.SecretGenerationContext
"""
self._secret_generation_context = secret_generation_context
@property
def is_auto_generation_enabled(self):
"""
Gets the is_auto_generation_enabled of this SecretSummary.
The value of this flag determines whether or not secret content will be generated automatically.
:return: The is_auto_generation_enabled of this SecretSummary.
:rtype: bool
"""
return self._is_auto_generation_enabled
@is_auto_generation_enabled.setter
def is_auto_generation_enabled(self, is_auto_generation_enabled):
"""
Sets the is_auto_generation_enabled of this SecretSummary.
The value of this flag determines whether or not secret content will be generated automatically.
:param is_auto_generation_enabled: The is_auto_generation_enabled of this SecretSummary.
:type: bool
"""
self._is_auto_generation_enabled = is_auto_generation_enabled
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