TagDefaultSummary

class oci.identity.models.TagDefaultSummary(**kwargs)

Bases: object

Summary information for the specified tag default.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a TagDefaultSummary. This constant has a value of "ACTIVE"

__init__(**kwargs)

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

Parameters:
  • id (str) -- The value to assign to the id property of this TagDefaultSummary.
  • compartment_id (str) -- The value to assign to the compartment_id property of this TagDefaultSummary.
  • tag_namespace_id (str) -- The value to assign to the tag_namespace_id property of this TagDefaultSummary.
  • tag_definition_id (str) -- The value to assign to the tag_definition_id property of this TagDefaultSummary.
  • tag_definition_name (str) -- The value to assign to the tag_definition_name property of this TagDefaultSummary.
  • value (str) -- The value to assign to the value property of this TagDefaultSummary.
  • time_created (datetime) -- The value to assign to the time_created property of this TagDefaultSummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this TagDefaultSummary. Allowed values for this property are: "ACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • is_required (bool) -- The value to assign to the is_required property of this TagDefaultSummary.
compartment_id

[Required] Gets the compartment_id of this TagDefaultSummary. The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment.

Returns:The compartment_id of this TagDefaultSummary.
Return type:str
id

[Required] Gets the id of this TagDefaultSummary. The OCID of the tag default.

Returns:The id of this TagDefaultSummary.
Return type:str
is_required

[Required] Gets the is_required of this TagDefaultSummary. If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

  • If the isRequired flag is set to "true", the value is set during resource creation.
  • If the isRequired flag is set to "false", the value you enter is set during resource creation.

Example: false

Returns:The is_required of this TagDefaultSummary.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this TagDefaultSummary. The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.

Allowed values for this property are: "ACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this TagDefaultSummary.
Return type:str
tag_definition_id

[Required] Gets the tag_definition_id of this TagDefaultSummary. The OCID of the tag definition. The tag default will always assign a default value for this tag definition.

Returns:The tag_definition_id of this TagDefaultSummary.
Return type:str
tag_definition_name

[Required] Gets the tag_definition_name of this TagDefaultSummary. The name used in the tag definition. This field is informational in the context of the tag default.

Returns:The tag_definition_name of this TagDefaultSummary.
Return type:str
tag_namespace_id

[Required] Gets the tag_namespace_id of this TagDefaultSummary. The OCID of the tag namespace that contains the tag definition.

Returns:The tag_namespace_id of this TagDefaultSummary.
Return type:str
time_created

[Required] Gets the time_created of this TagDefaultSummary. Date and time the TagDefault object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this TagDefaultSummary.
Return type:datetime
value

[Required] Gets the value of this TagDefaultSummary. The default value for the tag definition. This will be applied to all new resources created in the compartment.

Returns:The value of this TagDefaultSummary.
Return type:str