WorkerSummary

class oci.apm_synthetics.models.WorkerSummary(**kwargs)

Bases: object

Information about On-premise VP worker.

Attributes:

STATUS_DISABLED

A constant which can be used with the status property of a WorkerSummary.

STATUS_ENABLED

A constant which can be used with the status property of a WorkerSummary.

WORKER_TYPE_DOCKER

A constant which can be used with the worker_type property of a WorkerSummary.

configuration_details

Gets the configuration_details of this WorkerSummary.

defined_tags

Gets the defined_tags of this WorkerSummary.

display_name

[Required] Gets the display_name of this WorkerSummary.

freeform_tags

Gets the freeform_tags of this WorkerSummary.

geo_info

Gets the geo_info of this WorkerSummary.

id

[Required] Gets the id of this WorkerSummary.

monitor_list

Gets the monitor_list of this WorkerSummary.

name

[Required] Gets the name of this WorkerSummary.

priority

[Required] Gets the priority of this WorkerSummary.

status

[Required] Gets the status of this WorkerSummary.

time_created

Gets the time_created of this WorkerSummary.

time_last_syncup

Gets the time_last_syncup of this WorkerSummary.

time_updated

Gets the time_updated of this WorkerSummary.

version_details

[Required] Gets the version_details of this WorkerSummary.

worker_type

[Required] Gets the worker_type of this WorkerSummary.

Methods:

__init__(**kwargs)

Initializes a new WorkerSummary object with values from keyword arguments.

STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a WorkerSummary. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'

A constant which can be used with the status property of a WorkerSummary. This constant has a value of “ENABLED”

WORKER_TYPE_DOCKER = 'DOCKER'

A constant which can be used with the worker_type property of a WorkerSummary. This constant has a value of “DOCKER”

__init__(**kwargs)

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

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

  • name (str) – The value to assign to the name property of this WorkerSummary.

  • version_details (oci.apm_synthetics.models.OnPremiseVpWorkerVersionDetails) – The value to assign to the version_details property of this WorkerSummary.

  • configuration_details (object) – The value to assign to the configuration_details property of this WorkerSummary.

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

  • geo_info (str) – The value to assign to the geo_info property of this WorkerSummary.

  • monitor_list (list[oci.apm_synthetics.models.WorkerMonitorList]) – The value to assign to the monitor_list property of this WorkerSummary.

  • time_last_syncup (datetime) – The value to assign to the time_last_syncup property of this WorkerSummary.

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

  • time_updated (datetime) – The value to assign to the time_updated property of this WorkerSummary.

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

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

property configuration_details

Gets the configuration_details of this WorkerSummary. Configuration details of the On-premise VP worker.

Returns

The configuration_details of this WorkerSummary.

Return type

object

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this WorkerSummary. Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information.

Returns

The display_name of this WorkerSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property geo_info

Gets the geo_info of this WorkerSummary. Geographical information of the On-premise VP worker.

Returns

The geo_info of this WorkerSummary.

Return type

str

property id

[Required] Gets the id of this WorkerSummary. The OCID of the On-premise VP worker.

Returns

The id of this WorkerSummary.

Return type

str

property monitor_list

Gets the monitor_list of this WorkerSummary. Monitors list assigned to the On-premise VP worker.

Returns

The monitor_list of this WorkerSummary.

Return type

list[oci.apm_synthetics.models.WorkerMonitorList]

property name

[Required] Gets the name of this WorkerSummary. Unique permanent name of the On-premise VP worker. This is the same as the displayName.

Returns

The name of this WorkerSummary.

Return type

str

property priority

[Required] Gets the priority of this WorkerSummary. Priority of the On-premise VP worker to schedule monitors.

Returns

The priority of this WorkerSummary.

Return type

int

property status

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

Return type

str

property time_created

Gets the time_created of this WorkerSummary. 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 WorkerSummary.

Return type

datetime

property time_last_syncup

Gets the time_last_syncup of this WorkerSummary. The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns

The time_last_syncup of this WorkerSummary.

Return type

datetime

property time_updated

Gets the time_updated of this WorkerSummary. 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 WorkerSummary.

Return type

datetime

property version_details

[Required] Gets the version_details of this WorkerSummary.

Returns

The version_details of this WorkerSummary.

Return type

oci.apm_synthetics.models.OnPremiseVpWorkerVersionDetails

property worker_type

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

Return type

str