Pool¶
- class oci.data_flow.models.Pool(**kwargs)¶
Bases:
objectA Data Flow pool object.
Attributes:
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
A constant which can be used with the lifecycle_state property of a Pool.
[Required] Gets the compartment_id of this Pool.
[Required] Gets the configurations of this Pool.
[Required] Gets the defined_tags of this Pool.
Gets the description of this Pool.
[Required] Gets the display_name of this Pool.
[Required] Gets the freeform_tags of this Pool.
[Required] Gets the id of this Pool.
Gets the idle_timeout_in_minutes of this Pool.
Gets the lifecycle_details of this Pool.
[Required] Gets the lifecycle_state of this Pool.
[Required] Gets the owner_principal_id of this Pool.
Gets the owner_user_name of this Pool.
Gets the pool_metrics of this Pool.
Gets the schedules of this Pool.
[Required] Gets the time_created of this Pool.
[Required] Gets the time_updated of this Pool.
Methods:
__init__(**kwargs)Initializes a new Pool object with values from keyword arguments.
- LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “ACCEPTED”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “FAILED”
- LIFECYCLE_STATE_SCHEDULED = 'SCHEDULED'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “SCHEDULED”
- LIFECYCLE_STATE_STOPPED = 'STOPPED'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “STOPPED”
- LIFECYCLE_STATE_STOPPING = 'STOPPING'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “STOPPING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Pool. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Pool object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this Pool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Pool.
description (str) – The value to assign to the description property of this Pool.
display_name (str) – The value to assign to the display_name property of this Pool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Pool.
id (str) – The value to assign to the id property of this Pool.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Pool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Pool. Allowed values for this property are: “ACCEPTED”, “SCHEDULED”, “CREATING”, “ACTIVE”, “STOPPING”, “STOPPED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this Pool.
owner_user_name (str) – The value to assign to the owner_user_name property of this Pool.
pool_metrics (oci.data_flow.models.PoolMetrics) – The value to assign to the pool_metrics property of this Pool.
configurations (list[oci.data_flow.models.PoolConfig]) – The value to assign to the configurations property of this Pool.
schedules (list[oci.data_flow.models.PoolSchedule]) – The value to assign to the schedules property of this Pool.
idle_timeout_in_minutes (int) – The value to assign to the idle_timeout_in_minutes property of this Pool.
time_created (datetime) – The value to assign to the time_created property of this Pool.
time_updated (datetime) – The value to assign to the time_updated property of this Pool.
- property compartment_id¶
[Required] Gets the compartment_id of this Pool. The OCID of a compartment.
- Returns
The compartment_id of this Pool.
- Return type
str
- property configurations¶
[Required] Gets the configurations of this Pool. List of PoolConfig items.
- Returns
The configurations of this Pool.
- Return type
- property defined_tags¶
[Required] Gets the defined_tags of this Pool. 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 Pool.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Pool. A user-friendly description. Avoid entering confidential information.
- Returns
The description of this Pool.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Pool. A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Returns
The display_name of this Pool.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this Pool. 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 Pool.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Pool. The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Returns
The id of this Pool.
- Return type
str
- property idle_timeout_in_minutes¶
Gets the idle_timeout_in_minutes of this Pool. Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
- Returns
The idle_timeout_in_minutes of this Pool.
- Return type
int
- property lifecycle_details¶
Gets the lifecycle_details of this Pool. The detailed messages about the lifecycle state.
- Returns
The lifecycle_details of this Pool.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Pool. The current state of this pool.
Allowed values for this property are: “ACCEPTED”, “SCHEDULED”, “CREATING”, “ACTIVE”, “STOPPING”, “STOPPED”, “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 Pool.
- Return type
str
- property owner_principal_id¶
[Required] Gets the owner_principal_id of this Pool. The OCID of the user who created the resource.
- Returns
The owner_principal_id of this Pool.
- Return type
str
- property owner_user_name¶
Gets the owner_user_name of this Pool. The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
- Returns
The owner_user_name of this Pool.
- Return type
str
- property pool_metrics¶
Gets the pool_metrics of this Pool.
- Returns
The pool_metrics of this Pool.
- Return type
- property schedules¶
Gets the schedules of this Pool. A list of schedules for pool to auto start and stop.
- Returns
The schedules of this Pool.
- Return type