Package com.google.cloud.chronicle.v1

Interface RuleDeploymentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RuleDeployment, RuleDeployment.Builder
@Generated public interface RuleDeploymentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getEnabled

      boolean getEnabled()
       Whether the rule is currently deployed continuously against incoming data.
      bool enabled = 2;
      Returns:
      The enabled.

    • getAlerting

      boolean getAlerting()
       Whether detections resulting from this deployment should be considered
 alerts.
      bool alerting = 3;
      Returns:
      The alerting.

    • getArchived

      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:
      The archived.

    • hasArchiveTime

      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:
      Whether the archiveTime field is set.

    • getArchiveTime

      com.google.protobuf.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:
      The archiveTime.

    • getArchiveTimeOrBuilder

      com.google.protobuf.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];

    • getRunFrequencyValue

      int getRunFrequencyValue()
       The run frequency of the rule deployment.
      .google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
      Returns:
      The enum numeric value on the wire for runFrequency.

    • getRunFrequency

      RunFrequency getRunFrequency()
       The run frequency of the rule deployment.
      .google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
      Returns:
      The runFrequency.

    • getExecutionStateValue

      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:
      The enum numeric value on the wire for executionState.

    • getExecutionState

      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:
      The executionState.

    • getProducerRulesList

      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:
      A list containing the producerRules.

    • getProducerRulesCount

      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:
      The count of producerRules.

    • getProducerRules

      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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The producerRules at the given index.

    • getProducerRulesBytes

      com.google.protobuf.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) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the producerRules at the given index.

    • getConsumerRulesList

      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:
      A list containing the consumerRules.

    • getConsumerRulesCount

      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:
      The count of consumerRules.

    • getConsumerRules

      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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The consumerRules at the given index.

    • getConsumerRulesBytes

      com.google.protobuf.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) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the consumerRules at the given index.

    • hasLastAlertStatusChangeTime

      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:
      Whether the lastAlertStatusChangeTime field is set.

    • getLastAlertStatusChangeTime

      com.google.protobuf.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:
      The lastAlertStatusChangeTime.

    • getLastAlertStatusChangeTimeOrBuilder

      com.google.protobuf.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];