Desktop

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

Bases: object

Provides information about a desktop including name, state, id, configuration, owner, and time created.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

connection

Gets the connection of this Desktop.

defined_tags

Gets the defined_tags of this Desktop.

device_policy

[Required] Gets the device_policy of this Desktop.

display_name

[Required] Gets the display_name of this Desktop.

freeform_tags

Gets the freeform_tags of this Desktop.

hosting_options

[Required] Gets the hosting_options of this Desktop.

id

[Required] Gets the id of this Desktop.

lifecycle_state

[Required] Gets the lifecycle_state of this Desktop.

pool_id

[Required] Gets the pool_id of this Desktop.

time_created

[Required] Gets the time_created of this Desktop.

user_name

[Required] Gets the user_name of this Desktop.

Methods:

__init__(**kwargs)

Initializes a new Desktop object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new Desktop 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 Desktop.

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

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

  • display_name (str) – The value to assign to the display_name property of this Desktop.

  • device_policy (oci.desktops.models.DesktopDevicePolicy) – The value to assign to the device_policy property of this Desktop.

  • hosting_options (oci.desktops.models.HostingOptions) – The value to assign to the hosting_options property of this Desktop.

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

  • pool_id (str) – The value to assign to the pool_id property of this Desktop.

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

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

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

property connection

Gets the connection of this Desktop.

Returns

The connection of this Desktop.

Return type

oci.desktops.models.DesktopConnection

property defined_tags

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

Return type

dict(str, dict(str, object))

property device_policy

[Required] Gets the device_policy of this Desktop.

Returns

The device_policy of this Desktop.

Return type

oci.desktops.models.DesktopDevicePolicy

property display_name

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

Returns

The display_name of this Desktop.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property hosting_options

[Required] Gets the hosting_options of this Desktop.

Returns

The hosting_options of this Desktop.

Return type

oci.desktops.models.HostingOptions

property id

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

Returns

The id of this Desktop.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Desktop. 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 Desktop.

Return type

str

property pool_id

[Required] Gets the pool_id of this Desktop. The OCID of the desktop pool the desktop is a member of.

Returns

The pool_id of this Desktop.

Return type

str

property time_created

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

Returns

The time_created of this Desktop.

Return type

datetime

property user_name

[Required] Gets the user_name of this Desktop. The owner of the desktop.

Returns

The user_name of this Desktop.

Return type

str