RuleState class

Input properties used for looking up and filtering Rule resources.

Constructors

RuleState({Input<List<String>?>? allowedRunFrequencies, Input<String?>? author, Input<List<RuleCompilationDiagnostic>?>? compilationDiagnostics, Input<String?>? compilationState, Input<String?>? createTime, Input<List<String>?>? dataTables, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<String?>? etag, Input<String?>? instance, Input<String?>? location, Input<Map<String, String>?>? metadata, Input<String?>? name, Input<bool?>? nearRealTimeLiveRuleEligible, Input<String?>? project, Input<List<String>?>? referenceLists, Input<String?>? revisionCreateTime, Input<String?>? revisionId, Input<String?>? ruleId, Input<String?>? scope, Input<List<RuleSeverity>?>? severities, Input<String?>? text, Input<String?>? type})
Creates a new RuleState. allowedRunFrequencies Output only. The run frequencies that are allowed for the rule. author Output only. The author of the rule. Extracted from the meta section of text. compilationDiagnostics Output only. A list of a rule's corresponding compilation diagnostic messages compilationState Output only. The current compilation state of the rule. createTime Output only. The timestamp of when the rule was created. dataTables Output only. Resource names of the data tables used in this rule. deletionPolicy Policy to determine if the rule should be deleted forcefully. displayName The display name of the severity level. Extracted from the meta section of etag The etag for this rule. instance The unique identifier for the Chronicle instance, which is the same as the customer ID. location The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". metadata Output only. Additional metadata specified in the meta section of text. name Full resource name for the rule. This unique identifier is generated using values provided for the URL parameters. nearRealTimeLiveRuleEligible Output only. Indicate the rule can run in near real time live rule. project The ID of the project in which the resource belongs. referenceLists Output only. Resource names of the reference lists used in this rule. revisionCreateTime Output only. The timestamp of when the rule revision was created. revisionId Output only. The revision ID of the rule. ruleId Rule Id is the ID of the Rule. scope Resource name of the DataAccessScope bound to this rule. severities (Output) text The YARA-L content of the rule. type Possible values:
const
RuleState.fromMap(Map<String, dynamic> map)
factory

Properties

allowedRunFrequencies → Input<List<String>?>?
Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
final
author → Input<String?>?
Output only. The author of the rule. Extracted from the meta section of text. Populated in BASIC view and FULL view.
final
compilationDiagnostics → Input<List<RuleCompilationDiagnostic>?>?
Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view. Structure is documented below.
final
compilationState → Input<String?>?
Output only. The current compilation state of the rule. Populated in FULL view. Possible values: COMPILATION_STATE_UNSPECIFIED SUCCEEDED FAILED
final
createTime → Input<String?>?
Output only. The timestamp of when the rule was created. Populated in FULL view.
final
dataTables → Input<List<String>?>?
Output only. Resource names of the data tables used in this rule.
final
deletionPolicy → Input<String?>?
Policy to determine if the rule should be deleted forcefully. If deletionPolicy = "FORCE", any retrohunts and any detections associated with the rule will also be deleted. If deletionPolicy = "DEFAULT", the call will only succeed if the rule has no associated retrohunts, including completed retrohunts, and no associated detections. Regardless of being set to "FORCE" the rule deployment associated with this rule will also be deleted if deletion is successful.
final
displayName → Input<String?>?
The display name of the severity level. Extracted from the meta section of the rule text.
final
etag → Input<String?>?
The etag for this rule. If this is provided on update, the request will succeed if and only if it matches the server-computed value, and will fail with an ABORTED error otherwise. Populated in BASIC view and FULL view.
final
hashCode → int
The hash code for this object.
no setterinherited
instance → Input<String?>?
The unique identifier for the Chronicle instance, which is the same as the customer ID.
final
location → Input<String?>?
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
final
metadata → Input<Map<String, String>?>?
Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
final
name → Input<String?>?
Full resource name for the rule. This unique identifier is generated using values provided for the URL parameters. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
final
nearRealTimeLiveRuleEligible → Input<bool?>?
Output only. Indicate the rule can run in near real time live rule. If this is true, the rule uses the near real time live rule when the run frequency is set to LIVE.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
referenceLists → Input<List<String>?>?
Output only. Resource names of the reference lists used in this rule. Populated in FULL view.
final
revisionCreateTime → Input<String?>?
Output only. The timestamp of when the rule revision was created. Populated in FULL, REVISION_METADATA_ONLY views.
final
revisionId → Input<String?>?
Output only. The revision ID of the rule. A new revision is created whenever the rule text is changed in any way. Format: v_{10 digits}_{9 digits} Populated in REVISION_METADATA_ONLY view and FULL view.
final
ruleId → Input<String?>?
Rule Id is the ID of the Rule.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → Input<String?>?
Resource name of the DataAccessScope bound to this rule. Populated in BASIC view and FULL view. If reference lists are used in the rule, validations will be performed against this scope to ensure that the reference lists are compatible with both the user's and the rule's scopes. The scope should be in the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope}".
final
severities → Input<List<RuleSeverity>?>?
(Output) Output only. The severity of a rule's compilation diagnostic. Possible values: SEVERITY_UNSPECIFIED WARNING ERROR
final
text → Input<String?>?
The YARA-L content of the rule. Populated in FULL view.
final
type → Input<String?>?
Possible values: RULE_TYPE_UNSPECIFIED SINGLE_EVENT MULTI_EVENT
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited