Worker¶
- class oci.apm_synthetics.models.Worker(**kwargs)¶
Bases:
objectThe information about an On-premise VP worker.
Attributes:
A constant which can be used with the status property of a Worker.
A constant which can be used with the status property of a Worker.
A constant which can be used with the worker_type property of a Worker.
Gets the configuration_details of this Worker.
Gets the defined_tags of this Worker.
[Required] Gets the display_name of this Worker.
Gets the freeform_tags of this Worker.
Gets the geo_info of this Worker.
[Required] Gets the id of this Worker.
Gets the identity_info of this Worker.
Gets the monitor_list of this Worker.
[Required] Gets the name of this Worker.
[Required] Gets the opvp_id of this Worker.
[Required] Gets the opvp_name of this Worker.
[Required] Gets the priority of this Worker.
[Required] Gets the runtime_id of this Worker.
[Required] Gets the status of this Worker.
Gets the time_created of this Worker.
Gets the time_last_sync_up of this Worker.
Gets the time_updated of this Worker.
[Required] Gets the version_details of this Worker.
[Required] Gets the worker_type of this Worker.
Methods:
__init__(**kwargs)Initializes a new Worker object with values from keyword arguments.
- STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the status property of a Worker. This constant has a value of “DISABLED”
- STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the status property of a Worker. This constant has a value of “ENABLED”
- WORKER_TYPE_DOCKER = 'DOCKER'¶
A constant which can be used with the worker_type property of a Worker. This constant has a value of “DOCKER”
- __init__(**kwargs)¶
Initializes a new Worker 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 Worker.
runtime_id (str) – The value to assign to the runtime_id property of this Worker.
display_name (str) – The value to assign to the display_name property of this Worker.
name (str) – The value to assign to the name property of this Worker.
opvp_id (str) – The value to assign to the opvp_id property of this Worker.
opvp_name (str) – The value to assign to the opvp_name property of this Worker.
version_details (oci.apm_synthetics.models.OnPremiseVpWorkerVersionDetails) – The value to assign to the version_details property of this Worker.
configuration_details (object) – The value to assign to the configuration_details property of this Worker.
worker_type (str) – The value to assign to the worker_type property of this Worker. Allowed values for this property are: “DOCKER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status (str) – The value to assign to the status property of this Worker. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
priority (int) – The value to assign to the priority property of this Worker.
geo_info (str) – The value to assign to the geo_info property of this Worker.
monitor_list (list[oci.apm_synthetics.models.WorkerMonitorList]) – The value to assign to the monitor_list property of this Worker.
identity_info (oci.apm_synthetics.models.IdentityInfoDetails) – The value to assign to the identity_info property of this Worker.
time_last_sync_up (datetime) – The value to assign to the time_last_sync_up property of this Worker.
time_created (datetime) – The value to assign to the time_created property of this Worker.
time_updated (datetime) – The value to assign to the time_updated property of this Worker.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Worker.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Worker.
- property configuration_details¶
Gets the configuration_details of this Worker. Configuration details of the On-premise VP worker.
- Returns
The configuration_details of this Worker.
- Return type
object
- property defined_tags¶
Gets the defined_tags of this Worker. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this Worker.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this Worker. Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information.
- Returns
The display_name of this Worker.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Worker. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this Worker.
- Return type
dict(str, str)
- property geo_info¶
Gets the geo_info of this Worker. Geographical information of the On-premise VP worker.
- Returns
The geo_info of this Worker.
- Return type
str
- property id¶
[Required] Gets the id of this Worker. The OCID of the On-premise VP worker.
- Returns
The id of this Worker.
- Return type
str
- property identity_info¶
Gets the identity_info of this Worker.
- Returns
The identity_info of this Worker.
- Return type
- property monitor_list¶
Gets the monitor_list of this Worker. Monitors list assigned to the On-premise VP worker.
- Returns
The monitor_list of this Worker.
- Return type
- property name¶
[Required] Gets the name of this Worker. Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- Returns
The name of this Worker.
- Return type
str
- property opvp_id¶
[Required] Gets the opvp_id of this Worker. The OCID of the On-premise vantage point.
- Returns
The opvp_id of this Worker.
- Return type
str
- property opvp_name¶
[Required] Gets the opvp_name of this Worker. On-premise vantage point name.
- Returns
The opvp_name of this Worker.
- Return type
str
- property priority¶
[Required] Gets the priority of this Worker. Priority of the On-premise VP worker to schedule monitors.
- Returns
The priority of this Worker.
- Return type
int
- property runtime_id¶
[Required] Gets the runtime_id of this Worker. The runtime assigned id of the On-premise VP worker.
- Returns
The runtime_id of this Worker.
- Return type
str
- property status¶
[Required] Gets the status of this Worker. Enables or disables the On-premise VP worker.
Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this Worker.
- Return type
str
- property time_created¶
Gets the time_created of this Worker. The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- Returns
The time_created of this Worker.
- Return type
datetime
- property time_last_sync_up¶
Gets the time_last_sync_up of this Worker. The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- Returns
The time_last_sync_up of this Worker.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Worker. The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- Returns
The time_updated of this Worker.
- Return type
datetime
- property version_details¶
[Required] Gets the version_details of this Worker.
- Returns
The version_details of this Worker.
- Return type
- property worker_type¶
[Required] Gets the worker_type of this Worker. Type of the On-premise VP worker.
Allowed values for this property are: “DOCKER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The worker_type of this Worker.
- Return type
str