CreateTopicDetails¶
- class oci.ons.models.CreateTopicDetails(**kwargs)¶
Bases:
objectThe configuration details for creating the topic.
Methods:
__init__(**kwargs)Initializes a new CreateTopicDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this CreateTopicDetails.
Gets the defined_tags of this CreateTopicDetails.
Gets the description of this CreateTopicDetails.
Gets the freeform_tags of this CreateTopicDetails.
[Required] Gets the name of this CreateTopicDetails.
- __init__(**kwargs)¶
Initializes a new CreateTopicDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this CreateTopicDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateTopicDetails.
description (str) – The value to assign to the description property of this CreateTopicDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateTopicDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateTopicDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateTopicDetails. The OCID of the compartment to create the topic in.
- Returns
The compartment_id of this CreateTopicDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateTopicDetails. 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 CreateTopicDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateTopicDetails. The description of the topic being created. Avoid entering confidential information.
- Returns
The description of this CreateTopicDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateTopicDetails. 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 CreateTopicDetails.
- Return type
dict(str, str)
- property name¶
[Required] Gets the name of this CreateTopicDetails. The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.
- Returns
The name of this CreateTopicDetails.
- Return type
str