DesktopSummary¶
- class oci.desktops.models.DesktopSummary(**kwargs)¶
Bases:
objectProvides information about a desktop.
Attributes:
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
A constant which can be used with the lifecycle_state property of a DesktopSummary.
Gets the connection of this DesktopSummary.
Gets the defined_tags of this DesktopSummary.
[Required] Gets the display_name of this DesktopSummary.
Gets the freeform_tags of this DesktopSummary.
[Required] Gets the id of this DesktopSummary.
Gets the image of this DesktopSummary.
[Required] Gets the lifecycle_state of this DesktopSummary.
[Required] Gets the pool_id of this DesktopSummary.
[Required] Gets the time_created of this DesktopSummary.
[Required] Gets the user_name of this DesktopSummary.
Methods:
__init__(**kwargs)Initializes a new DesktopSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DesktopSummary. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new DesktopSummary 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 DesktopSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DesktopSummary. 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 DesktopSummary.
display_name (str) – The value to assign to the display_name property of this DesktopSummary.
user_name (str) – The value to assign to the user_name property of this DesktopSummary.
pool_id (str) – The value to assign to the pool_id property of this DesktopSummary.
image (oci.desktops.models.DesktopImage) – The value to assign to the image property of this DesktopSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DesktopSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DesktopSummary.
connection (oci.desktops.models.DesktopConnection) – The value to assign to the connection property of this DesktopSummary.
- property connection¶
Gets the connection of this DesktopSummary.
- Returns
The connection of this DesktopSummary.
- Return type
- property defined_tags¶
Gets the defined_tags of this DesktopSummary. 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 DesktopSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this DesktopSummary. A user friendly display name. Avoid entering confidential information.
- Returns
The display_name of this DesktopSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DesktopSummary. 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 DesktopSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DesktopSummary. The OCID of the desktop.
- Returns
The id of this DesktopSummary.
- Return type
str
- property image¶
Gets the image of this DesktopSummary.
- Returns
The image of this DesktopSummary.
- Return type
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DesktopSummary. 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 DesktopSummary.
- Return type
str
- property pool_id¶
[Required] Gets the pool_id of this DesktopSummary. The pool ID of the desktop.
- Returns
The pool_id of this DesktopSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this DesktopSummary. The date and time the resource was created.
- Returns
The time_created of this DesktopSummary.
- Return type
datetime
- property user_name¶
[Required] Gets the user_name of this DesktopSummary. The owner of the desktop.
- Returns
The user_name of this DesktopSummary.
- Return type
str