Class RuleSummary
A generic rule summary object - represents an ingest time rule or a scheduled task.
Inherited Members
Namespace: Oci.LoganalyticsService.Models
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class RuleSummary
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Description for this resource. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The ingest time rule or scheduled task display name. |
Remarks
Required
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. |
Remarks
Required
IsEnabled
Declaration
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | A flag indicating whether or not the ingest time rule or scheduled task is enabled. |
Kind
Declaration
[Required(ErrorMessage = "Kind is required.")]
[JsonProperty(PropertyName = "kind")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RuleKind? Kind { get; set; }
Property Value
Type | Description |
---|---|
RuleKind? | The kind of rule - either an ingest time rule or a scheduled task. |
Remarks
Required
LastExecutionStatus
Declaration
[JsonProperty(PropertyName = "lastExecutionStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RuleSummary.LastExecutionStatusEnum? LastExecutionStatus { get; set; }
Property Value
Type | Description |
---|---|
RuleSummary.LastExecutionStatusEnum? | The most recent task execution status. |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ConfigLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ConfigLifecycleState? | The current state of the logging analytics rule. |
TargetService
Declaration
[JsonProperty(PropertyName = "targetService")]
public string TargetService { get; set; }
Property Value
Type | Description |
---|---|
string | The target service. |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the resource was created, in the format defined by RFC3339. |
TimeLastExecuted
Declaration
[JsonProperty(PropertyName = "timeLastExecuted")]
public DateTime? TimeLastExecuted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the scheduled task last executed, in the format defined by RFC3339. |
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the resource was last updated, in the format defined by RFC3339. |