Package com.google.cloud.chronicle.v1

Class RuleDeployment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.RuleDeployment
All Implemented Interfaces:
RuleDeploymentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RuleDeployment extends com.google.protobuf.GeneratedMessage implements RuleDeploymentOrBuilder
 The RuleDeployment resource represents the deployment state of a Rule.
Protobuf type google.cloud.chronicle.v1.RuleDeployment
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ENABLED_FIELD_NUMBER

      public static final int ENABLED_FIELD_NUMBER
      See Also:

    • ALERTING_FIELD_NUMBER

      public static final int ALERTING_FIELD_NUMBER
      See Also:

    • ARCHIVED_FIELD_NUMBER

      public static final int ARCHIVED_FIELD_NUMBER
      See Also:

    • ARCHIVE_TIME_FIELD_NUMBER

      public static final int ARCHIVE_TIME_FIELD_NUMBER
      See Also:

    • RUN_FREQUENCY_FIELD_NUMBER

      public static final int RUN_FREQUENCY_FIELD_NUMBER
      See Also:

    • EXECUTION_STATE_FIELD_NUMBER

      public static final int EXECUTION_STATE_FIELD_NUMBER
      See Also:

    • PRODUCER_RULES_FIELD_NUMBER

      public static final int PRODUCER_RULES_FIELD_NUMBER
      See Also:

    • CONSUMER_RULES_FIELD_NUMBER

      public static final int CONSUMER_RULES_FIELD_NUMBER
      See Also:

    • LAST_ALERT_STATUS_CHANGE_TIME_FIELD_NUMBER

      public static final int LAST_ALERT_STATUS_CHANGE_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface RuleDeploymentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface RuleDeploymentOrBuilder
      Returns:
      The bytes for name.

    • getEnabled

      public boolean getEnabled()
       Whether the rule is currently deployed continuously against incoming data.
      bool enabled = 2;
      Specified by:
      getEnabled in interface RuleDeploymentOrBuilder
      Returns:
      The enabled.

    • getAlerting

      public boolean getAlerting()
       Whether detections resulting from this deployment should be considered
 alerts.
      bool alerting = 3;
      Specified by:
      getAlerting in interface RuleDeploymentOrBuilder
      Returns:
      The alerting.

    • getArchived

      public 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;
      Specified by:
      getArchived in interface RuleDeploymentOrBuilder
      Returns:
      The archived.

    • hasArchiveTime

      public 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];
      Specified by:
      hasArchiveTime in interface RuleDeploymentOrBuilder
      Returns:
      Whether the archiveTime field is set.

    • getArchiveTime

      public 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];
      Specified by:
      getArchiveTime in interface RuleDeploymentOrBuilder
      Returns:
      The archiveTime.

    • getArchiveTimeOrBuilder

      public 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];
      Specified by:
      getArchiveTimeOrBuilder in interface RuleDeploymentOrBuilder

    • getRunFrequencyValue

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

    • getRunFrequency

      public RunFrequency getRunFrequency()
       The run frequency of the rule deployment.
      .google.cloud.chronicle.v1.RunFrequency run_frequency = 6;
      Specified by:
      getRunFrequency in interface RuleDeploymentOrBuilder
      Returns:
      The runFrequency.

    • getExecutionStateValue

      public 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];
      Specified by:
      getExecutionStateValue in interface RuleDeploymentOrBuilder
      Returns:
      The enum numeric value on the wire for executionState.

    • getExecutionState

      public 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];
      Specified by:
      getExecutionState in interface RuleDeploymentOrBuilder
      Returns:
      The executionState.

    • getProducerRulesList

      public com.google.protobuf.ProtocolStringList 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) = { ... }
      Specified by:
      getProducerRulesList in interface RuleDeploymentOrBuilder
      Returns:
      A list containing the producerRules.

    • getProducerRulesCount

      public 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) = { ... }
      Specified by:
      getProducerRulesCount in interface RuleDeploymentOrBuilder
      Returns:
      The count of producerRules.

    • getProducerRules

      public 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) = { ... }
      Specified by:
      getProducerRules in interface RuleDeploymentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The producerRules at the given index.

    • getProducerRulesBytes

      public 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) = { ... }
      Specified by:
      getProducerRulesBytes in interface RuleDeploymentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the producerRules at the given index.

    • getConsumerRulesList

      public com.google.protobuf.ProtocolStringList 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) = { ... }
      Specified by:
      getConsumerRulesList in interface RuleDeploymentOrBuilder
      Returns:
      A list containing the consumerRules.

    • getConsumerRulesCount

      public 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) = { ... }
      Specified by:
      getConsumerRulesCount in interface RuleDeploymentOrBuilder
      Returns:
      The count of consumerRules.

    • getConsumerRules

      public 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) = { ... }
      Specified by:
      getConsumerRules in interface RuleDeploymentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The consumerRules at the given index.

    • getConsumerRulesBytes

      public 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) = { ... }
      Specified by:
      getConsumerRulesBytes in interface RuleDeploymentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the consumerRules at the given index.

    • hasLastAlertStatusChangeTime

      public 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];
      Specified by:
      hasLastAlertStatusChangeTime in interface RuleDeploymentOrBuilder
      Returns:
      Whether the lastAlertStatusChangeTime field is set.

    • getLastAlertStatusChangeTime

      public 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];
      Specified by:
      getLastAlertStatusChangeTime in interface RuleDeploymentOrBuilder
      Returns:
      The lastAlertStatusChangeTime.

    • getLastAlertStatusChangeTimeOrBuilder

      public 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];
      Specified by:
      getLastAlertStatusChangeTimeOrBuilder in interface RuleDeploymentOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RuleDeployment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuleDeployment parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuleDeployment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuleDeployment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuleDeployment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuleDeployment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuleDeployment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RuleDeployment.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RuleDeployment.Builder newBuilder()

    • newBuilder

      public static RuleDeployment.Builder newBuilder(RuleDeployment prototype)

    • toBuilder

      public RuleDeployment.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RuleDeployment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RuleDeployment getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RuleDeployment> parser()

    • getParserForType

      public com.google.protobuf.Parser<RuleDeployment> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RuleDeployment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder