DesktopPoolDesktopSummary

class oci.desktops.models.DesktopPoolDesktopSummary(**kwargs)

Bases: object

Provides information about a desktop within a desktop pool, such as if it is assigned to a user, the state, owner, desktop pool, resource id, and time created.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary.

connection

Gets the connection of this DesktopPoolDesktopSummary.

defined_tags

Gets the defined_tags of this DesktopPoolDesktopSummary.

desktop_id

[Required] Gets the desktop_id of this DesktopPoolDesktopSummary.

freeform_tags

Gets the freeform_tags of this DesktopPoolDesktopSummary.

image

Gets the image of this DesktopPoolDesktopSummary.

instance_id

[Required] Gets the instance_id of this DesktopPoolDesktopSummary.

is_assigned

[Required] Gets the is_assigned of this DesktopPoolDesktopSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this DesktopPoolDesktopSummary.

time_created

[Required] Gets the time_created of this DesktopPoolDesktopSummary.

user_name

Gets the user_name of this DesktopPoolDesktopSummary.

Methods:

__init__(**kwargs)

Initializes a new DesktopPoolDesktopSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DesktopPoolDesktopSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DesktopPoolDesktopSummary. 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’.

  • instance_id (str) – The value to assign to the instance_id property of this DesktopPoolDesktopSummary.

  • user_name (str) – The value to assign to the user_name property of this DesktopPoolDesktopSummary.

  • desktop_id (str) – The value to assign to the desktop_id property of this DesktopPoolDesktopSummary.

  • is_assigned (bool) – The value to assign to the is_assigned property of this DesktopPoolDesktopSummary.

  • time_created (datetime) – The value to assign to the time_created property of this DesktopPoolDesktopSummary.

  • image (oci.desktops.models.DesktopImage) – The value to assign to the image property of this DesktopPoolDesktopSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DesktopPoolDesktopSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DesktopPoolDesktopSummary.

  • connection (oci.desktops.models.DesktopConnection) – The value to assign to the connection property of this DesktopPoolDesktopSummary.

property connection

Gets the connection of this DesktopPoolDesktopSummary.

Returns

The connection of this DesktopPoolDesktopSummary.

Return type

oci.desktops.models.DesktopConnection

property defined_tags

Gets the defined_tags of this DesktopPoolDesktopSummary. 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 DesktopPoolDesktopSummary.

Return type

dict(str, dict(str, object))

property desktop_id

[Required] Gets the desktop_id of this DesktopPoolDesktopSummary. The OCID of the desktop.

Returns

The desktop_id of this DesktopPoolDesktopSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DesktopPoolDesktopSummary. 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 DesktopPoolDesktopSummary.

Return type

dict(str, str)

property image

Gets the image of this DesktopPoolDesktopSummary.

Returns

The image of this DesktopPoolDesktopSummary.

Return type

oci.desktops.models.DesktopImage

property instance_id

[Required] Gets the instance_id of this DesktopPoolDesktopSummary. The OCID of the compute resource used by this desktop.

Returns

The instance_id of this DesktopPoolDesktopSummary.

Return type

str

property is_assigned

[Required] Gets the is_assigned of this DesktopPoolDesktopSummary. Indicates whether the desktop is assigned to a user.

Returns

The is_assigned of this DesktopPoolDesktopSummary.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this DesktopPoolDesktopSummary. The state of the desktop.

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 DesktopPoolDesktopSummary.

Return type

str

property time_created

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

Returns

The time_created of this DesktopPoolDesktopSummary.

Return type

datetime

property user_name

Gets the user_name of this DesktopPoolDesktopSummary. The owner of the desktop.

Returns

The user_name of this DesktopPoolDesktopSummary.

Return type

str