Class LogAnalyticsObjectCollectionRuleSummary

The summary of an Object Storage based collection rule.

Inheritance

object

LogAnalyticsObjectCollectionRuleSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Models

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class LogAnalyticsObjectCollectionRuleSummary

Properties

CollectionType

Declaration

[Required(ErrorMessage = "CollectionType is required.")]
[JsonProperty(PropertyName = "collectionType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ObjectCollectionRuleCollectionTypes? CollectionType { get; set; }

Property Value

Type	Description
ObjectCollectionRuleCollectionTypes?	The type of log collection.

Remarks

Required

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment to which this rule belongs.

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	A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified. Avoid entering confidential information.

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 OCID of this rule.

Remarks

Required

IsEnabled

Declaration

[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	Whether or not this rule is currently enabled.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A detailed status of the life cycle state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ObjectCollectionRuleLifecycleStates? LifecycleState { get; set; }

Property Value

Type	Description
ObjectCollectionRuleLifecycleStates?	The current state of the rule.

Remarks

Required

LogType

Declaration

[JsonProperty(PropertyName = "logType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LogTypes? LogType { get; set; }

Property Value

Type	Description
LogTypes?	Type of files/objects in this object collection rule.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

Remarks

Required

ObjectNameFilters

Declaration

[JsonProperty(PropertyName = "objectNameFilters")]
public List<string> ObjectNameFilters { get; set; }

Property Value

Type	Description
List<string>	When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

OsBucketName

Declaration

[Required(ErrorMessage = "OsBucketName is required.")]
[JsonProperty(PropertyName = "osBucketName")]
public string OsBucketName { get; set; }

Property Value

Type	Description
string	Name of the Object Storage bucket.

Remarks

Required

OsNamespace

Declaration

[Required(ErrorMessage = "OsNamespace is required.")]
[JsonProperty(PropertyName = "osNamespace")]
public string OsNamespace { get; set; }

Property Value

Type	Description
string	Object Storage namespace.

Remarks

Required

StreamId

Declaration

[JsonProperty(PropertyName = "streamId")]
public string StreamId { get; set; }

Property Value

Type	Description
string	A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Logging Analytics while creating Event Rule and consume the event notifications created by the Object Storage.

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time when this rule was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The time when this rule was last updated. An RFC3339 formatted datetime string.

Remarks

Required