DomainSummary¶

class oci.tenant_manager_control_plane.models.DomainSummary(**kwargs)¶

Bases: object

The summary of a domain owned by a tenancy.

Methods

__init__(**kwargs) Initializes a new DomainSummary object with values from keyword arguments.

Attributes

`defined_tags`	Gets the defined_tags of this DomainSummary.
`domain_name`	[Required] Gets the domain_name of this DomainSummary.
`freeform_tags`	Gets the freeform_tags of this DomainSummary.
`id`	[Required] Gets the id of this DomainSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DomainSummary.
`owner_id`	[Required] Gets the owner_id of this DomainSummary.
`status`	[Required] Gets the status of this DomainSummary.
`system_tags`	Gets the system_tags of this DomainSummary.
`time_created`	Gets the time_created of this DomainSummary.
`time_updated`	Gets the time_updated of this DomainSummary.
`txt_record`	[Required] Gets the txt_record of this DomainSummary.

__init__(**kwargs)¶

Initializes a new DomainSummary 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 DomainSummary.
domain_name (str) – The value to assign to the domain_name property of this DomainSummary.
owner_id (str) – The value to assign to the owner_id property of this DomainSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DomainSummary.
status (str) – The value to assign to the status property of this DomainSummary.
txt_record (str) – The value to assign to the txt_record property of this DomainSummary.
time_created (datetime) – The value to assign to the time_created property of this DomainSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DomainSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DomainSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DomainSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DomainSummary.

defined_tags¶

Gets the defined_tags of this DomainSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DomainSummary.
Return type:	dict(str, dict(str, object))

domain_name¶

[Required] Gets the domain_name of this DomainSummary. The domain name.

Returns:	The domain_name of this DomainSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DomainSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DomainSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DomainSummary. OCID of the domain.

Returns:	The id of this DomainSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DomainSummary. The lifecycle state of the domain.

Returns:	The lifecycle_state of this DomainSummary.
Return type:	str

owner_id¶

[Required] Gets the owner_id of this DomainSummary. The OCID of the tenancy that has started the registration process for this domain.

Returns:	The owner_id of this DomainSummary.
Return type:	str

status¶

[Required] Gets the status of this DomainSummary. Status of the domain.

Returns:	The status of this DomainSummary.
Return type:	str

system_tags¶

Gets the system_tags of this DomainSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DomainSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this DomainSummary. Date-time when this domain was created. An RFC 3339-formatted date and time string.

Returns:	The time_created of this DomainSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this DomainSummary. Date-time when this domain was last updated. An RFC 3339-formatted date and time string.

Returns:	The time_updated of this DomainSummary.
Return type:	datetime

txt_record¶

[Required] Gets the txt_record of this DomainSummary. The code that the owner of the domain will need to add as a TXT record to their domain.

Returns:	The txt_record of this DomainSummary.
Return type:	str