Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Agent

Description of Agent.

Properties

Optional agentPubKey

agentPubKey: undefined | string

Resource principal public key.

agentType

agentType: AgentType

Type of the Agent.

agentVersion

agentVersion: string

Agent identifier.

compartmentId

compartmentId: string

Compartment identifier.

definedTags

definedTags: object

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

Agent identifier, can be renamed.

environmentId

environmentId: string

Environment identifier.

freeformTags

freeformTags: object

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

Type declaration

  • [key: string]: string

Optional heartBeatStatus

heartBeatStatus: HeartBeatStatus

The current heartbeat status of the Agent based on its timeLastSyncReceived value.

id

id: string

Unique identifier that is immutable on creation.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state of the Agent in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Agent.

osVersion

osVersion: string

OS version.

Optional pluginList

pluginList: Array<PluginSummary>

List of plugins associated with the agent.

Optional systemTags

systemTags: undefined | object

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {@code {orcl-cloud: {free-tier-retain: true}}}

timeCreated

timeCreated: Date

The time when the Agent was created. An RFC3339 formatted datetime string.

Optional timeExpireAgentKeyInMs

timeExpireAgentKeyInMs: Date

The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.

Optional timeLastSyncReceived

timeLastSyncReceived: Date

The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time when the Agent was updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Agent): object

getJsonObj

  • getJsonObj(obj: Agent): object