DesktopPoolSummary¶

class oci.desktops.models.DesktopPoolSummary(**kwargs)¶

Bases: object

Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DesktopPoolSummary.
`active_desktops`	Gets the active_desktops of this DesktopPoolSummary.
`compartment_id`	[Required] Gets the compartment_id of this DesktopPoolSummary.
`contact_details`	[Required] Gets the contact_details of this DesktopPoolSummary.
`defined_tags`	Gets the defined_tags of this DesktopPoolSummary.
`display_name`	[Required] Gets the display_name of this DesktopPoolSummary.
`freeform_tags`	Gets the freeform_tags of this DesktopPoolSummary.
`id`	[Required] Gets the id of this DesktopPoolSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DesktopPoolSummary.
`maximum_size`	[Required] Gets the maximum_size of this DesktopPoolSummary.
`time_created`	[Required] Gets the time_created of this DesktopPoolSummary.

Methods

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

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

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

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

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

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

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DesktopPoolSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DesktopPoolSummary 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 DesktopPoolSummary.
display_name (str) – The value to assign to the display_name property of this DesktopPoolSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DesktopPoolSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
maximum_size (int) – The value to assign to the maximum_size property of this DesktopPoolSummary.
active_desktops (int) – The value to assign to the active_desktops property of this DesktopPoolSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DesktopPoolSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DesktopPoolSummary.
contact_details (str) – The value to assign to the contact_details property of this DesktopPoolSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DesktopPoolSummary.
time_created (datetime) – The value to assign to the time_created property of this DesktopPoolSummary.

active_desktops¶

Gets the active_desktops of this DesktopPoolSummary. The number of active desktops in the desktop pool.

Returns:	The active_desktops of this DesktopPoolSummary.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this DesktopPoolSummary. The OCID of the compartment which will contain the desktop pool.

Returns:	The compartment_id of this DesktopPoolSummary.
Return type:	str

contact_details¶

[Required] Gets the contact_details of this DesktopPoolSummary. Contact information of the desktop pool administrator. Avoid entering confidential information.

Returns:	The contact_details of this DesktopPoolSummary.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this DesktopPoolSummary. A user friendly display name. Avoid entering confidential information.

Returns:	The display_name of this DesktopPoolSummary.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this DesktopPoolSummary. The OCID of the desktop pool.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DesktopPoolSummary. The current state of the desktop pool.

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

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

maximum_size¶

[Required] Gets the maximum_size of this DesktopPoolSummary. The maximum number of desktops permitted in the desktop pool.

Returns:	The maximum_size of this DesktopPoolSummary.
Return type:	int

time_created¶

[Required] Gets the time_created of this DesktopPoolSummary. The date and time the resource was created.

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