DesktopPoolVolumeSummary¶
- class oci.desktops.models.DesktopPoolVolumeSummary(**kwargs)¶
Bases:
objectProvides information about a volume within the desktop pool.
Attributes:
A constant which can be used with the lifecycle_state property of a DesktopPoolVolumeSummary.
A constant which can be used with the lifecycle_state property of a DesktopPoolVolumeSummary.
[Required] Gets the availability_domain of this DesktopPoolVolumeSummary.
Gets the defined_tags of this DesktopPoolVolumeSummary.
Gets the freeform_tags of this DesktopPoolVolumeSummary.
[Required] Gets the id of this DesktopPoolVolumeSummary.
[Required] Gets the lifecycle_state of this DesktopPoolVolumeSummary.
[Required] Gets the name of this DesktopPoolVolumeSummary.
Gets the pool_id of this DesktopPoolVolumeSummary.
[Required] Gets the user_name of this DesktopPoolVolumeSummary.
Methods:
__init__(**kwargs)Initializes a new DesktopPoolVolumeSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopPoolVolumeSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a DesktopPoolVolumeSummary. This constant has a value of “INACTIVE”
- __init__(**kwargs)¶
Initializes a new DesktopPoolVolumeSummary 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 DesktopPoolVolumeSummary.
name (str) – The value to assign to the name property of this DesktopPoolVolumeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DesktopPoolVolumeSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
user_name (str) – The value to assign to the user_name property of this DesktopPoolVolumeSummary.
pool_id (str) – The value to assign to the pool_id property of this DesktopPoolVolumeSummary.
availability_domain (str) – The value to assign to the availability_domain property of this DesktopPoolVolumeSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DesktopPoolVolumeSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DesktopPoolVolumeSummary.
- property availability_domain¶
[Required] Gets the availability_domain of this DesktopPoolVolumeSummary. The availability domain of the desktop pool.
- Returns
The availability_domain of this DesktopPoolVolumeSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DesktopPoolVolumeSummary. 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 DesktopPoolVolumeSummary.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this DesktopPoolVolumeSummary. 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 DesktopPoolVolumeSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DesktopPoolVolumeSummary. The OCID of the desktop pool volume.
- Returns
The id of this DesktopPoolVolumeSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DesktopPoolVolumeSummary. The state of the desktop pool volume.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DesktopPoolVolumeSummary.
- Return type
str
- property name¶
[Required] Gets the name of this DesktopPoolVolumeSummary. The name of the desktop pool volume.
- Returns
The name of this DesktopPoolVolumeSummary.
- Return type
str
- property pool_id¶
Gets the pool_id of this DesktopPoolVolumeSummary. The OCID of the desktop pool to which this volume belongs.
- Returns
The pool_id of this DesktopPoolVolumeSummary.
- Return type
str
- property user_name¶
[Required] Gets the user_name of this DesktopPoolVolumeSummary. The owner of the desktop pool volume.
- Returns
The user_name of this DesktopPoolVolumeSummary.
- Return type
str