KeySummary

class oci.key_management.models.KeySummary(**kwargs)

Bases: object

KeySummary model.

Attributes

LIFECYCLE_STATE_CANCELLING_DELETION A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_DISABLED A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_DISABLING A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_ENABLED A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_ENABLING A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_PENDING_DELETION A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_SCHEDULING_DELETION A constant which can be used with the lifecycle_state property of a KeySummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a KeySummary.
compartment_id [Required] Gets the compartment_id of this KeySummary.
defined_tags Gets the defined_tags of this KeySummary.
display_name [Required] Gets the display_name of this KeySummary.
freeform_tags Gets the freeform_tags of this KeySummary.
id [Required] Gets the id of this KeySummary.
lifecycle_state [Required] Gets the lifecycle_state of this KeySummary.
time_created [Required] Gets the time_created of this KeySummary.
vault_id [Required] Gets the vault_id of this KeySummary.

Methods

__init__(**kwargs) Initializes a new KeySummary object with values from keyword arguments.
LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “CANCELLING_DELETION”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_DISABLED = 'DISABLED'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “DISABLED”

LIFECYCLE_STATE_DISABLING = 'DISABLING'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “DISABLING”

LIFECYCLE_STATE_ENABLED = 'ENABLED'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “ENABLED”

LIFECYCLE_STATE_ENABLING = 'ENABLING'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “ENABLING”

LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “PENDING_DELETION”

LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “SCHEDULING_DELETION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a KeySummary. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) – The value to assign to the compartment_id property of this KeySummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KeySummary.
  • display_name (str) – The value to assign to the display_name property of this KeySummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KeySummary.
  • id (str) – The value to assign to the id property of this KeySummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this KeySummary. Allowed values for this property are: “CREATING”, “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_created (datetime) – The value to assign to the time_created property of this KeySummary.
  • vault_id (str) – The value to assign to the vault_id property of this KeySummary.
compartment_id

[Required] Gets the compartment_id of this KeySummary. The OCID of the compartment that contains the key.

Returns:The compartment_id of this KeySummary.
Return type:str
defined_tags

Gets the defined_tags of this KeySummary. 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 KeySummary.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this KeySummary. A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:The display_name of this KeySummary.
Return type:str
freeform_tags

Gets the freeform_tags of this KeySummary. 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 KeySummary.
Return type:dict(str, str)
id

[Required] Gets the id of this KeySummary. The OCID of the key.

Returns:The id of this KeySummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this KeySummary. The key’s current state.

Example: ENABLED

Allowed values for this property are: “CREATING”, “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “DELETING”, “DELETED”, “PENDING_DELETION”, “SCHEDULING_DELETION”, “CANCELLING_DELETION”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this KeySummary.
Return type:str
time_created

[Required] Gets the time_created of this KeySummary. The date and time the key was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-03T21:10:29.600Z

Returns:The time_created of this KeySummary.
Return type:datetime
vault_id

[Required] Gets the vault_id of this KeySummary. The OCID of the vault that contains the key.

Returns:The vault_id of this KeySummary.
Return type:str