Show / Hide Table of Contents

Class AgentSummary

Summary of the Agent.

Inheritance
object
AgentSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CloudbridgeService.Models
Assembly: OCI.DotNetSDK.Cloudbridge.dll
Syntax
public class AgentSummary

Properties

AgentType

Declaration
[Required(ErrorMessage = "AgentType is required.")]
[JsonProperty(PropertyName = "agentType")]
[JsonConverter(typeof(StringEnumConverter))]
public Agent.AgentTypeEnum? AgentType { get; set; }
Property Value
Type Description
Agent.AgentTypeEnum?

Type of Agent.

Remarks

Required

AgentVersion

Declaration
[Required(ErrorMessage = "AgentVersion is required.")]
[JsonProperty(PropertyName = "agentVersion")]
public string AgentVersion { get; set; }
Property Value
Type Description
string

Agent identifier.

Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Compartment identifier.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, 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: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Agent identifier, which can be renamed.

Remarks

Required

EnvironmentId

Declaration
[Required(ErrorMessage = "EnvironmentId is required.")]
[JsonProperty(PropertyName = "environmentId")]
public string EnvironmentId { get; set; }
Property Value
Type Description
string

Environment identifier.

Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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: {"Department": "Finance"}

Remarks

Required

HeartBeatStatus

Declaration
[JsonProperty(PropertyName = "heartBeatStatus")]
[JsonConverter(typeof(StringEnumConverter))]
public Agent.HeartBeatStatusEnum? HeartBeatStatus { get; set; }
Property Value
Type Description
Agent.HeartBeatStatusEnum?

Current heartbeat status of the Agent based on its timeLastSyncReceived value.

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Unique identifier that is immutable on creation.

Remarks

Required

LifecycleDetails

Declaration
[Required(ErrorMessage = "LifecycleDetails is required.")]
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public Agent.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Agent.LifecycleStateEnum?

The current state of the Agent.

Remarks

Required

OsVersion

Declaration
[Required(ErrorMessage = "OsVersion is required.")]
[JsonProperty(PropertyName = "osVersion")]
public string OsVersion { get; set; }
Property Value
Type Description
string

OS version.

Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, 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: {orcl-cloud: {free-tier-retain: true}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

Remarks

Required

TimeLastSyncReceived

Declaration
[JsonProperty(PropertyName = "timeLastSyncReceived")]
public DateTime? TimeLastSyncReceived { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

Remarks

Required

In this article
Back to top