StandardTagDefinitionTemplate¶
-
class
oci.identity.models.StandardTagDefinitionTemplate(**kwargs)¶ Bases:
objectThe template of the tag definition. This object includes necessary details to create the provided standard tag definition.
Attributes
ENUM_MUTABILITY_APPENDABLEA constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. ENUM_MUTABILITY_IMMUTABLEA constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. ENUM_MUTABILITY_MUTABLEA constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. TYPE_ENUMA constant which can be used with the type property of a StandardTagDefinitionTemplate. TYPE_STRINGA constant which can be used with the type property of a StandardTagDefinitionTemplate. description[Required] Gets the description of this StandardTagDefinitionTemplate. enum_mutabilityGets the enum_mutability of this StandardTagDefinitionTemplate. is_cost_tracking[Required] Gets the is_cost_tracking of this StandardTagDefinitionTemplate. possible_valuesGets the possible_values of this StandardTagDefinitionTemplate. tag_definition_name[Required] Gets the tag_definition_name of this StandardTagDefinitionTemplate. type[Required] Gets the type of this StandardTagDefinitionTemplate. Methods
__init__(**kwargs)Initializes a new StandardTagDefinitionTemplate object with values from keyword arguments. -
ENUM_MUTABILITY_APPENDABLE= 'APPENDABLE'¶ A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. This constant has a value of “APPENDABLE”
-
ENUM_MUTABILITY_IMMUTABLE= 'IMMUTABLE'¶ A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. This constant has a value of “IMMUTABLE”
-
ENUM_MUTABILITY_MUTABLE= 'MUTABLE'¶ A constant which can be used with the enum_mutability property of a StandardTagDefinitionTemplate. This constant has a value of “MUTABLE”
-
TYPE_ENUM= 'ENUM'¶ A constant which can be used with the type property of a StandardTagDefinitionTemplate. This constant has a value of “ENUM”
-
TYPE_STRING= 'STRING'¶ A constant which can be used with the type property of a StandardTagDefinitionTemplate. This constant has a value of “STRING”
-
__init__(**kwargs)¶ Initializes a new StandardTagDefinitionTemplate object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - description (str) – The value to assign to the description property of this StandardTagDefinitionTemplate.
- tag_definition_name (str) – The value to assign to the tag_definition_name property of this StandardTagDefinitionTemplate.
- type (str) – The value to assign to the type property of this StandardTagDefinitionTemplate. Allowed values for this property are: “ENUM”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- possible_values (list[str]) – The value to assign to the possible_values property of this StandardTagDefinitionTemplate.
- is_cost_tracking (bool) – The value to assign to the is_cost_tracking property of this StandardTagDefinitionTemplate.
- enum_mutability (str) – The value to assign to the enum_mutability property of this StandardTagDefinitionTemplate. Allowed values for this property are: “IMMUTABLE”, “MUTABLE”, “APPENDABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
-
description¶ [Required] Gets the description of this StandardTagDefinitionTemplate. The default description of the tag namespace that users can use to create the tag definition
Returns: The description of this StandardTagDefinitionTemplate. Return type: str
-
enum_mutability¶ Gets the enum_mutability of this StandardTagDefinitionTemplate. The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags
Allowed values for this property are: “IMMUTABLE”, “MUTABLE”, “APPENDABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The enum_mutability of this StandardTagDefinitionTemplate. Return type: str
-
is_cost_tracking¶ [Required] Gets the is_cost_tracking of this StandardTagDefinitionTemplate. Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated
Returns: The is_cost_tracking of this StandardTagDefinitionTemplate. Return type: bool
-
possible_values¶ Gets the possible_values of this StandardTagDefinitionTemplate. List of possible values. An optional parameter that will be present if the type of definition is enum.
Returns: The possible_values of this StandardTagDefinitionTemplate. Return type: list[str]
-
tag_definition_name¶ [Required] Gets the tag_definition_name of this StandardTagDefinitionTemplate. The name of this standard tag definition
Returns: The tag_definition_name of this StandardTagDefinitionTemplate. Return type: str
-
type¶ [Required] Gets the type of this StandardTagDefinitionTemplate. The type of tag definition. Enum or string.
Allowed values for this property are: “ENUM”, “STRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this StandardTagDefinitionTemplate. Return type: str
-