Interface RuleDeploymentOrBuilder (0.1.0) 

public interface RuleDeploymentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlerting()

public abstract boolean getAlerting()

Whether detections resulting from this deployment should be considered alerts.

bool alerting = 3;

Returns
Type Description
boolean

The alerting.

getArchiveTime()

public abstract Timestamp getArchiveTime()

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.

.google.protobuf.Timestamp archive_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The archiveTime.

getArchiveTimeOrBuilder()

public abstract TimestampOrBuilder getArchiveTimeOrBuilder()

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.

.google.protobuf.Timestamp archive_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getArchived()

public abstract boolean getArchived()

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.

bool archived = 4;

Returns
Type Description
boolean

The archived.

getConsumerRules(int index)

public abstract String getConsumerRules(int index)

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}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The consumerRules at the given index.

getConsumerRulesBytes(int index)

public abstract ByteString getConsumerRulesBytes(int index)

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}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the consumerRules at the given index.

getConsumerRulesCount()

public abstract int getConsumerRulesCount()

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}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of consumerRules.

getConsumerRulesList()

public abstract List<String> getConsumerRulesList()

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}

repeated string consumer_rules = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the consumerRules.

getEnabled()

public abstract boolean getEnabled()

Whether the rule is currently deployed continuously against incoming data.

bool enabled = 2;

Returns
Type Description
boolean

The enabled.

getExecutionState()

public abstract RuleDeployment.ExecutionState getExecutionState()

Output only. The execution state of the rule deployment.

.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RuleDeployment.ExecutionState

The executionState.

getExecutionStateValue()

public abstract int getExecutionStateValue()

Output only. The execution state of the rule deployment.

.google.cloud.chronicle.v1.RuleDeployment.ExecutionState execution_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for executionState.

getLastAlertStatusChangeTime()

public abstract Timestamp getLastAlertStatusChangeTime()

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.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastAlertStatusChangeTime.

getLastAlertStatusChangeTimeOrBuilder()

public abstract TimestampOrBuilder getLastAlertStatusChangeTimeOrBuilder()

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.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getProducerRules(int index)

public abstract String getProducerRules(int index)

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}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The producerRules at the given index.

getProducerRulesBytes(int index)

public abstract ByteString getProducerRulesBytes(int index)

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}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the producerRules at the given index.

getProducerRulesCount()

public abstract int getProducerRulesCount()

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}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of producerRules.

getProducerRulesList()

public abstract List<String> getProducerRulesList()

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}

repeated string producer_rules = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the producerRules.

getRunFrequency()

public abstract RunFrequency getRunFrequency()

The run frequency of the rule deployment.

.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;

Returns
Type Description
RunFrequency

The runFrequency.

getRunFrequencyValue()

public abstract int getRunFrequencyValue()

The run frequency of the rule deployment.

.google.cloud.chronicle.v1.RunFrequency run_frequency = 6;

Returns
Type Description
int

The enum numeric value on the wire for runFrequency.

hasArchiveTime()

public abstract boolean hasArchiveTime()

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.

.google.protobuf.Timestamp archive_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the archiveTime field is set.

hasLastAlertStatusChangeTime()

public abstract boolean hasLastAlertStatusChangeTime()

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.

.google.protobuf.Timestamp last_alert_status_change_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastAlertStatusChangeTime field is set.