UpdateAgentReceiverTaskDetails¶

class oci.stack_monitoring.models.UpdateAgentReceiverTaskDetails(**kwargs)¶

Bases: MonitoredResourceTaskDetails

Request details for enabling/disabling the metric receiver on the management agent.

Attributes:

`HANDLER_TYPE_COLLECTD`	A constant which can be used with the handler_type property of a UpdateAgentReceiverTaskDetails.
`HANDLER_TYPE_TELEGRAF`	A constant which can be used with the handler_type property of a UpdateAgentReceiverTaskDetails.
`TYPE_IMPORT_OCI_TELEMETRY_RESOURCES`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`TYPE_UPDATE_AGENT_RECEIVER`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`TYPE_UPDATE_RESOURCE_TYPE_CONFIGS`	A constant which can be used with the type property of a MonitoredResourceTaskDetails.
`agent_id`	[Required] Gets the agent_id of this UpdateAgentReceiverTaskDetails.
`handler_type`	[Required] Gets the handler_type of this UpdateAgentReceiverTaskDetails.
`is_enable`	[Required] Gets the is_enable of this UpdateAgentReceiverTaskDetails.
`receiver_properties`	Gets the receiver_properties of this UpdateAgentReceiverTaskDetails.
`type`	[Required] Gets the type of this MonitoredResourceTaskDetails.

Methods:

`__init__`(**kwargs)	Initializes a new UpdateAgentReceiverTaskDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

HANDLER_TYPE_COLLECTD = 'COLLECTD'¶: A constant which can be used with the handler_type property of a UpdateAgentReceiverTaskDetails. This constant has a value of “COLLECTD”

HANDLER_TYPE_TELEGRAF = 'TELEGRAF'¶: A constant which can be used with the handler_type property of a UpdateAgentReceiverTaskDetails. This constant has a value of “TELEGRAF”

TYPE_IMPORT_OCI_TELEMETRY_RESOURCES = 'IMPORT_OCI_TELEMETRY_RESOURCES'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “IMPORT_OCI_TELEMETRY_RESOURCES”

TYPE_UPDATE_AGENT_RECEIVER = 'UPDATE_AGENT_RECEIVER'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “UPDATE_AGENT_RECEIVER”

TYPE_UPDATE_RESOURCE_TYPE_CONFIGS = 'UPDATE_RESOURCE_TYPE_CONFIGS'¶: A constant which can be used with the type property of a MonitoredResourceTaskDetails. This constant has a value of “UPDATE_RESOURCE_TYPE_CONFIGS”

__init__(**kwargs)¶

Initializes a new UpdateAgentReceiverTaskDetails object with values from keyword arguments. The default value of the type attribute of this class is UPDATE_AGENT_RECEIVER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

type (str) – The value to assign to the type property of this UpdateAgentReceiverTaskDetails. Allowed values for this property are: “IMPORT_OCI_TELEMETRY_RESOURCES”, “UPDATE_AGENT_RECEIVER”, “UPDATE_RESOURCE_TYPE_CONFIGS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
agent_id (str) – The value to assign to the agent_id property of this UpdateAgentReceiverTaskDetails.
handler_type (str) – The value to assign to the handler_type property of this UpdateAgentReceiverTaskDetails. Allowed values for this property are: “TELEGRAF”, “COLLECTD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_enable (bool) – The value to assign to the is_enable property of this UpdateAgentReceiverTaskDetails.
receiver_properties (oci.stack_monitoring.models.AgentReceiverProperties) – The value to assign to the receiver_properties property of this UpdateAgentReceiverTaskDetails.

property agent_id¶

[Required] Gets the agent_id of this UpdateAgentReceiverTaskDetails. Management Agent Identifier OCID.

Returns: The agent_id of this UpdateAgentReceiverTaskDetails.
Return type: str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property handler_type¶

[Required] Gets the handler_type of this UpdateAgentReceiverTaskDetails. Type of the handler.

Allowed values for this property are: “TELEGRAF”, “COLLECTD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The handler_type of this UpdateAgentReceiverTaskDetails.
Return type: str

property is_enable¶

[Required] Gets the is_enable of this UpdateAgentReceiverTaskDetails. True to enable the receiver and false to disable the receiver on the agent.

Returns: The is_enable of this UpdateAgentReceiverTaskDetails.
Return type: bool

property receiver_properties¶

Gets the receiver_properties of this UpdateAgentReceiverTaskDetails.

Returns: The receiver_properties of this UpdateAgentReceiverTaskDetails.
Return type: oci.stack_monitoring.models.AgentReceiverProperties

property type¶

[Required] Gets the type of this MonitoredResourceTaskDetails. Task type.

Allowed values for this property are: “IMPORT_OCI_TELEMETRY_RESOURCES”, “UPDATE_AGENT_RECEIVER”, “UPDATE_RESOURCE_TYPE_CONFIGS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The type of this MonitoredResourceTaskDetails.
Return type: str