public interface RuleOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMetadata(String key)
public abstract boolean containsMetadata(String key)Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
map<string, string> metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAllowedRunFrequencies(int index)
public abstract RunFrequency getAllowedRunFrequencies(int index)Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
repeated .google.cloud.chronicle.v1.RunFrequency allowed_run_frequencies = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
RunFrequency |
The allowedRunFrequencies at the given index. |
getAllowedRunFrequenciesCount()
public abstract int getAllowedRunFrequenciesCount()Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
repeated .google.cloud.chronicle.v1.RunFrequency allowed_run_frequencies = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of allowedRunFrequencies. |
getAllowedRunFrequenciesList()
public abstract List<RunFrequency> getAllowedRunFrequenciesList()Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
repeated .google.cloud.chronicle.v1.RunFrequency allowed_run_frequencies = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<RunFrequency> |
A list containing the allowedRunFrequencies. |
getAllowedRunFrequenciesValue(int index)
public abstract int getAllowedRunFrequenciesValue(int index)Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
repeated .google.cloud.chronicle.v1.RunFrequency allowed_run_frequencies = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of allowedRunFrequencies at the given index. |
getAllowedRunFrequenciesValueList()
public abstract List<Integer> getAllowedRunFrequenciesValueList()Output only. The run frequencies that are allowed for the rule. Populated in BASIC view and FULL view.
repeated .google.cloud.chronicle.v1.RunFrequency allowed_run_frequencies = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for allowedRunFrequencies. |
getAuthor()
public abstract String getAuthor()Output only. The author of the rule. Extracted from the meta section of text. Populated in BASIC view and FULL view.
string author = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The author. |
getAuthorBytes()
public abstract ByteString getAuthorBytes()Output only. The author of the rule. Extracted from the meta section of text. Populated in BASIC view and FULL view.
string author = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for author. |
getCompilationDiagnostics(int index)
public abstract CompilationDiagnostic getCompilationDiagnostics(int index)Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view.
repeated .google.cloud.chronicle.v1.CompilationDiagnostic compilation_diagnostics = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CompilationDiagnostic |
|
getCompilationDiagnosticsCount()
public abstract int getCompilationDiagnosticsCount()Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view.
repeated .google.cloud.chronicle.v1.CompilationDiagnostic compilation_diagnostics = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCompilationDiagnosticsList()
public abstract List<CompilationDiagnostic> getCompilationDiagnosticsList()Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view.
repeated .google.cloud.chronicle.v1.CompilationDiagnostic compilation_diagnostics = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<CompilationDiagnostic> |
|
getCompilationDiagnosticsOrBuilder(int index)
public abstract CompilationDiagnosticOrBuilder getCompilationDiagnosticsOrBuilder(int index)Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view.
repeated .google.cloud.chronicle.v1.CompilationDiagnostic compilation_diagnostics = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CompilationDiagnosticOrBuilder |
|
getCompilationDiagnosticsOrBuilderList()
public abstract List<? extends CompilationDiagnosticOrBuilder> getCompilationDiagnosticsOrBuilderList()Output only. A list of a rule's corresponding compilation diagnostic messages such as compilation errors and compilation warnings. Populated in FULL view.
repeated .google.cloud.chronicle.v1.CompilationDiagnostic compilation_diagnostics = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.chronicle.v1.CompilationDiagnosticOrBuilder> |
|
getCompilationState()
public abstract Rule.CompilationState getCompilationState()Output only. The current compilation state of the rule. Populated in FULL view.
.google.cloud.chronicle.v1.Rule.CompilationState compilation_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Rule.CompilationState |
The compilationState. |
getCompilationStateValue()
public abstract int getCompilationStateValue()Output only. The current compilation state of the rule. Populated in FULL view.
.google.cloud.chronicle.v1.Rule.CompilationState compilation_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for compilationState. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. The timestamp of when the rule was created. Populated in FULL view.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp of when the rule was created. Populated in FULL view.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public abstract String getDisplayName()Output only. Display name of the rule. Populated in BASIC view and FULL view.
string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Output only. Display name of the rule. Populated in BASIC view and FULL view.
string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEtag()
public abstract String getEtag()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.
string etag = 15;
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes()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.
string etag = 15;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getInputsUsed()
public abstract InputsUsed getInputsUsed()Output only. The set of inputs used in the rule. For example, if the rule uses $e.principal.hostname, then the uses_udm field will be true.
.google.cloud.chronicle.v1.InputsUsed inputs_used = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
InputsUsed |
The inputsUsed. |
getInputsUsedOrBuilder()
public abstract InputsUsedOrBuilder getInputsUsedOrBuilder()Output only. The set of inputs used in the rule. For example, if the rule uses $e.principal.hostname, then the uses_udm field will be true.
.google.cloud.chronicle.v1.InputsUsed inputs_used = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
InputsUsedOrBuilder |
|
getMetadata() (deprecated)
public abstract Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public abstract int getMetadataCount()Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
map<string, string> metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetadataMap()
public abstract Map<String,String> getMetadataMap()Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
map<string, string> metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataOrDefault(String key, String defaultValue)
public abstract String getMetadataOrDefault(String key, String defaultValue)Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
map<string, string> metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetadataOrThrow(String key)
public abstract String getMetadataOrThrow(String key)Output only. Additional metadata specified in the meta section of text. Populated in FULL view.
map<string, string> metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName() Identifier. Full resource name for the rule.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. Full resource name for the rule.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNearRealTimeLiveRuleEligible()
public abstract boolean getNearRealTimeLiveRuleEligible()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.
bool near_real_time_live_rule_eligible = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The nearRealTimeLiveRuleEligible. |
getReferenceLists(int index)
public abstract String getReferenceLists(int index)Output only. Resource names of the reference lists used in this rule. Populated in FULL view.
repeated string reference_lists = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referenceLists at the given index. |
getReferenceListsBytes(int index)
public abstract ByteString getReferenceListsBytes(int index)Output only. Resource names of the reference lists used in this rule. Populated in FULL view.
repeated string reference_lists = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referenceLists at the given index. |
getReferenceListsCount()
public abstract int getReferenceListsCount()Output only. Resource names of the reference lists used in this rule. Populated in FULL view.
repeated string reference_lists = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of referenceLists. |
getReferenceListsList()
public abstract List<String> getReferenceListsList()Output only. Resource names of the reference lists used in this rule. Populated in FULL view.
repeated string reference_lists = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the referenceLists. |
getRevisionCreateTime()
public abstract Timestamp getRevisionCreateTime()Output only. The timestamp of when the rule revision was created. Populated in FULL, REVISION_METADATA_ONLY views.
.google.protobuf.Timestamp revision_create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The revisionCreateTime. |
getRevisionCreateTimeOrBuilder()
public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()Output only. The timestamp of when the rule revision was created. Populated in FULL, REVISION_METADATA_ONLY views.
.google.protobuf.Timestamp revision_create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getRevisionId()
public abstract String getRevisionId() 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.
string revision_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The revisionId. |
getRevisionIdBytes()
public abstract ByteString getRevisionIdBytes() 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.
string revision_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for revisionId. |
getScope()
public abstract String getScope() 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}.
string scope = 16 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The scope. |
getScopeBytes()
public abstract ByteString getScopeBytes() 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}.
string scope = 16 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for scope. |
getSeverity()
public abstract Severity getSeverity()Output only. The severity of the rule as specified in the meta section of text. Populated in BASIC view and FULL view.
.google.cloud.chronicle.v1.Severity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Severity |
The severity. |
getSeverityOrBuilder()
public abstract SeverityOrBuilder getSeverityOrBuilder()Output only. The severity of the rule as specified in the meta section of text. Populated in BASIC view and FULL view.
.google.cloud.chronicle.v1.Severity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SeverityOrBuilder |
|
getText()
public abstract String getText()The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The text. |
getTextBytes()
public abstract ByteString getTextBytes()The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for text. |
getType()
public abstract RuleType getType()Output only. User-facing type of the rule. Extracted from the events section of rule text. Populated in BASIC view and FULL view.
.google.cloud.chronicle.v1.RuleType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
RuleType |
The type. |
getTypeValue()
public abstract int getTypeValue()Output only. User-facing type of the rule. Extracted from the events section of rule text. Populated in BASIC view and FULL view.
.google.cloud.chronicle.v1.RuleType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. The timestamp of when the rule was created. Populated in FULL view.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasInputsUsed()
public abstract boolean hasInputsUsed()Output only. The set of inputs used in the rule. For example, if the rule uses $e.principal.hostname, then the uses_udm field will be true.
.google.cloud.chronicle.v1.InputsUsed inputs_used = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inputsUsed field is set. |
hasRevisionCreateTime()
public abstract boolean hasRevisionCreateTime()Output only. The timestamp of when the rule revision was created. Populated in FULL, REVISION_METADATA_ONLY views.
.google.protobuf.Timestamp revision_create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the revisionCreateTime field is set. |
hasSeverity()
public abstract boolean hasSeverity()Output only. The severity of the rule as specified in the meta section of text. Populated in BASIC view and FULL view.
.google.cloud.chronicle.v1.Severity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the severity field is set. |