OrganizationTenancySummary¶

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

Bases: object

An organization tenancy summary entity.

Attributes

`GOVERNANCE_STATUS_OPTED_IN`	A constant which can be used with the governance_status property of a OrganizationTenancySummary.
`GOVERNANCE_STATUS_OPTED_OUT`	A constant which can be used with the governance_status property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary.
`ROLE_CHILD`	A constant which can be used with the role property of a OrganizationTenancySummary.
`ROLE_NONE`	A constant which can be used with the role property of a OrganizationTenancySummary.
`ROLE_PARENT`	A constant which can be used with the role property of a OrganizationTenancySummary.
`governance_status`	[Required] Gets the governance_status of this OrganizationTenancySummary.
`is_approved_for_transfer`	Gets the is_approved_for_transfer of this OrganizationTenancySummary.
`lifecycle_state`	Gets the lifecycle_state of this OrganizationTenancySummary.
`name`	Gets the name of this OrganizationTenancySummary.
`role`	Gets the role of this OrganizationTenancySummary.
`system_tags`	Gets the system_tags of this OrganizationTenancySummary.
`tenancy_id`	[Required] Gets the tenancy_id of this OrganizationTenancySummary.
`time_joined`	Gets the time_joined of this OrganizationTenancySummary.
`time_left`	Gets the time_left of this OrganizationTenancySummary.

Methods

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

GOVERNANCE_STATUS_OPTED_IN = 'OPTED_IN'¶: A constant which can be used with the governance_status property of a OrganizationTenancySummary. This constant has a value of “OPTED_IN”

GOVERNANCE_STATUS_OPTED_OUT = 'OPTED_OUT'¶: A constant which can be used with the governance_status property of a OrganizationTenancySummary. This constant has a value of “OPTED_OUT”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a OrganizationTenancySummary. This constant has a value of “INACTIVE”

ROLE_CHILD = 'CHILD'¶: A constant which can be used with the role property of a OrganizationTenancySummary. This constant has a value of “CHILD”

ROLE_NONE = 'NONE'¶: A constant which can be used with the role property of a OrganizationTenancySummary. This constant has a value of “NONE”

ROLE_PARENT = 'PARENT'¶: A constant which can be used with the role property of a OrganizationTenancySummary. This constant has a value of “PARENT”

__init__(**kwargs)¶

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

Parameters:

tenancy_id (str) – The value to assign to the tenancy_id property of this OrganizationTenancySummary.
name (str) – The value to assign to the name property of this OrganizationTenancySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OrganizationTenancySummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
role (str) – The value to assign to the role property of this OrganizationTenancySummary. Allowed values for this property are: “PARENT”, “CHILD”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_joined (datetime) – The value to assign to the time_joined property of this OrganizationTenancySummary.
time_left (datetime) – The value to assign to the time_left property of this OrganizationTenancySummary.
is_approved_for_transfer (bool) – The value to assign to the is_approved_for_transfer property of this OrganizationTenancySummary.
governance_status (str) – The value to assign to the governance_status property of this OrganizationTenancySummary. Allowed values for this property are: “OPTED_IN”, “OPTED_OUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OrganizationTenancySummary.

governance_status¶

[Required] Gets the governance_status of this OrganizationTenancySummary. The governance status of the tenancy.

Allowed values for this property are: “OPTED_IN”, “OPTED_OUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The governance_status of this OrganizationTenancySummary.
Return type:	str

is_approved_for_transfer¶

Gets the is_approved_for_transfer of this OrganizationTenancySummary. Parameter to indicate the tenancy is approved for transfer to another organization.

Returns:	The is_approved_for_transfer of this OrganizationTenancySummary.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this OrganizationTenancySummary. Lifecycle state of the organization tenancy.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

name¶

Gets the name of this OrganizationTenancySummary. Name of the tenancy.

Returns:	The name of this OrganizationTenancySummary.
Return type:	str

role¶

Gets the role of this OrganizationTenancySummary. Role of the organization tenancy.

Allowed values for this property are: “PARENT”, “CHILD”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The role of this OrganizationTenancySummary.
Return type:	str

system_tags¶

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

tenancy_id¶

[Required] Gets the tenancy_id of this OrganizationTenancySummary. OCID of the tenancy.

Returns:	The tenancy_id of this OrganizationTenancySummary.
Return type:	str

time_joined¶

Gets the time_joined of this OrganizationTenancySummary. Date and time when the tenancy joined the organization.

Returns:	The time_joined of this OrganizationTenancySummary.
Return type:	datetime

time_left¶

Gets the time_left of this OrganizationTenancySummary. Date and time when the tenancy left the organization.

Returns:	The time_left of this OrganizationTenancySummary.
Return type:	datetime