public sealed class RuleDeployment : IMessage<RuleDeployment>, IEquatable<RuleDeployment>, IDeepCloneable<RuleDeployment>, IBufferMessage, IMessageReference documentation and code samples for the Chronicle v1 API class RuleDeployment.
The RuleDeployment resource represents the deployment state of a Rule.
Implements
IMessageRuleDeployment, IEquatableRuleDeployment, IDeepCloneableRuleDeployment, IBufferMessage, IMessageNamespace
Google.Cloud.Chronicle.V1Assembly
Google.Cloud.Chronicle.V1.dll
Constructors
RuleDeployment()
public RuleDeployment()RuleDeployment(RuleDeployment)
public RuleDeployment(RuleDeployment other)| Parameter | |
|---|---|
| Name | Description |
other |
RuleDeployment |
Properties
Alerting
public bool Alerting { get; set; }Whether detections resulting from this deployment should be considered alerts.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ArchiveTime
public Timestamp ArchiveTime { get; set; }Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Archived
public bool Archived { get; set; }The archive state of the rule deployment. Cannot be set to true unless enabled is set to false. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and run_frequency cannot be updated.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ConsumerRules
public RepeatedField<string> ConsumerRules { get; }Output only. The names of the associated/chained consumer rules. Rules are
considered consumers of this rule if their rule text explicitly filters on
this rule's ruleid. Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
ConsumerRulesAsInstanceNames
public ResourceNameList<InstanceName> ConsumerRulesAsInstanceNames { get; }InstanceName-typed view over the ConsumerRules resource name property.
| Property Value | |
|---|---|
| Type | Description |
ResourceNameListInstanceName |
|
Enabled
public bool Enabled { get; set; }Whether the rule is currently deployed continuously against incoming data.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ExecutionState
public RuleDeployment.Types.ExecutionState ExecutionState { get; set; }Output only. The execution state of the rule deployment.
| Property Value | |
|---|---|
| Type | Description |
RuleDeploymentTypesExecutionState |
|
LastAlertStatusChangeTime
public Timestamp LastAlertStatusChangeTime { get; set; }Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Name
public string Name { get; set; }Required. The resource name of the rule deployment.
Note that RuleDeployment is a child of the overall Rule, not any individual
revision, so the resource ID segment for the Rule resource must not
reference a specific revision.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment
| Property Value | |
|---|---|
| Type | Description |
string |
|
ProducerRules
public RepeatedField<string> ProducerRules { get; }Output only. The names of the associated/chained producer rules. Rules are
considered producers for this rule if this rule explicitly filters on their
ruleid. Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
ProducerRulesAsInstanceNames
public ResourceNameList<InstanceName> ProducerRulesAsInstanceNames { get; }InstanceName-typed view over the ProducerRules resource name property.
| Property Value | |
|---|---|
| Type | Description |
ResourceNameListInstanceName |
|
RuleDeploymentName
public RuleDeploymentName RuleDeploymentName { get; set; }RuleDeploymentName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
RuleDeploymentName |
|
RunFrequency
public RunFrequency RunFrequency { get; set; }The run frequency of the rule deployment.
| Property Value | |
|---|---|
| Type | Description |
RunFrequency |
|