public static final class Rule.Builder extends GeneratedMessageV3.Builder<Rule.Builder> implements RuleOrBuilderThe Rule resource represents a user-created rule. NEXT TAG: 21
Protobuf type google.cloud.chronicle.v1.Rule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.BuilderImplements
RuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllAllowedRunFrequencies(Iterable<? extends RunFrequency> values)
public Rule.Builder addAllAllowedRunFrequencies(Iterable<? extends RunFrequency> values)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 |
values |
Iterable<? extends com.google.cloud.chronicle.v1.RunFrequency>The allowedRunFrequencies to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addAllAllowedRunFrequenciesValue(Iterable<Integer> values)
public Rule.Builder addAllAllowedRunFrequenciesValue(Iterable<Integer> values)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 |
values |
Iterable<Integer>The enum numeric values on the wire for allowedRunFrequencies to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addAllCompilationDiagnostics(Iterable<? extends CompilationDiagnostic> values)
public Rule.Builder addAllCompilationDiagnostics(Iterable<? extends CompilationDiagnostic> values)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 |
values |
Iterable<? extends com.google.cloud.chronicle.v1.CompilationDiagnostic> |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
addAllReferenceLists(Iterable<String> values)
public Rule.Builder addAllReferenceLists(Iterable<String> values)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 |
values |
Iterable<String>The referenceLists to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addAllowedRunFrequencies(RunFrequency value)
public Rule.Builder addAllowedRunFrequencies(RunFrequency value)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 |
value |
RunFrequencyThe allowedRunFrequencies to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addAllowedRunFrequenciesValue(int value)
public Rule.Builder addAllowedRunFrequenciesValue(int value)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 |
value |
intThe enum numeric value on the wire for allowedRunFrequencies to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addCompilationDiagnostics(CompilationDiagnostic value)
public Rule.Builder addCompilationDiagnostics(CompilationDiagnostic value)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 |
value |
CompilationDiagnostic |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
addCompilationDiagnostics(CompilationDiagnostic.Builder builderForValue)
public Rule.Builder addCompilationDiagnostics(CompilationDiagnostic.Builder builderForValue)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 |
builderForValue |
CompilationDiagnostic.Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
addCompilationDiagnostics(int index, CompilationDiagnostic value)
public Rule.Builder addCompilationDiagnostics(int index, CompilationDiagnostic value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CompilationDiagnostic |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
addCompilationDiagnostics(int index, CompilationDiagnostic.Builder builderForValue)
public Rule.Builder addCompilationDiagnostics(int index, CompilationDiagnostic.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CompilationDiagnostic.Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
addCompilationDiagnosticsBuilder()
public CompilationDiagnostic.Builder addCompilationDiagnosticsBuilder()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 |
CompilationDiagnostic.Builder |
|
addCompilationDiagnosticsBuilder(int index)
public CompilationDiagnostic.Builder addCompilationDiagnosticsBuilder(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.Builder |
|
addReferenceLists(String value)
public Rule.Builder addReferenceLists(String value)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 |
value |
StringThe referenceLists to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addReferenceListsBytes(ByteString value)
public Rule.Builder addReferenceListsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the referenceLists to add. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Rule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
build()
public Rule build()| Returns | |
|---|---|
| Type | Description |
Rule |
|
buildPartial()
public Rule buildPartial()| Returns | |
|---|---|
| Type | Description |
Rule |
|
clear()
public Rule.Builder clear()| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
clearAllowedRunFrequencies()
public Rule.Builder clearAllowedRunFrequencies()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 |
Rule.Builder |
This builder for chaining. |
clearAuthor()
public Rule.Builder clearAuthor()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 |
Rule.Builder |
This builder for chaining. |
clearCompilationDiagnostics()
public Rule.Builder clearCompilationDiagnostics()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 |
Rule.Builder |
|
clearCompilationState()
public Rule.Builder clearCompilationState()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.Builder |
This builder for chaining. |
clearCreateTime()
public Rule.Builder clearCreateTime()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 |
Rule.Builder |
|
clearDisplayName()
public Rule.Builder clearDisplayName()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 |
Rule.Builder |
This builder for chaining. |
clearEtag()
public Rule.Builder clearEtag()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 |
Rule.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Rule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
clearInputsUsed()
public Rule.Builder clearInputsUsed()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 |
Rule.Builder |
|
clearMetadata()
public Rule.Builder clearMetadata()| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
clearName()
public Rule.Builder clearName() 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 |
Rule.Builder |
This builder for chaining. |
clearNearRealTimeLiveRuleEligible()
public Rule.Builder clearNearRealTimeLiveRuleEligible()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 |
Rule.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Rule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
clearReferenceLists()
public Rule.Builder clearReferenceLists()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 |
Rule.Builder |
This builder for chaining. |
clearRevisionCreateTime()
public Rule.Builder clearRevisionCreateTime()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 |
Rule.Builder |
|
clearRevisionId()
public Rule.Builder clearRevisionId() 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 |
Rule.Builder |
This builder for chaining. |
clearScope()
public Rule.Builder clearScope() 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 |
Rule.Builder |
This builder for chaining. |
clearSeverity()
public Rule.Builder clearSeverity()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 |
Rule.Builder |
|
clearText()
public Rule.Builder clearText()The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
clearType()
public Rule.Builder clearType()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 |
Rule.Builder |
This builder for chaining. |
clone()
public Rule.Builder clone()| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
containsMetadata(String key)
public 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 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 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 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 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 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 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 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 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 |
|
getCompilationDiagnosticsBuilder(int index)
public CompilationDiagnostic.Builder getCompilationDiagnosticsBuilder(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.Builder |
|
getCompilationDiagnosticsBuilderList()
public List<CompilationDiagnostic.Builder> getCompilationDiagnosticsBuilderList()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<Builder> |
|
getCompilationDiagnosticsCount()
public 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 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 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 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 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 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder |
|
getCreateTimeOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public Rule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Rule |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public 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 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 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 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 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. |
getInputsUsedBuilder()
public InputsUsed.Builder getInputsUsedBuilder()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.Builder |
|
getInputsUsedOrBuilder()
public 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 Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public 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 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 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 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 |
|
getMutableMetadata() (deprecated)
public Map<String,String> getMutableMetadata()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the referenceLists. |
getRevisionCreateTime()
public 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. |
getRevisionCreateTimeBuilder()
public Timestamp.Builder getRevisionCreateTimeBuilder()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 |
Builder |
|
getRevisionCreateTimeOrBuilder()
public 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 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 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 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 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 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. |
getSeverityBuilder()
public Severity.Builder getSeverityBuilder()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.Builder |
|
getSeverityOrBuilder()
public 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 String getText()The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The text. |
getTextBytes()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public Rule.Builder mergeCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeFrom(Rule other)
public Rule.Builder mergeFrom(Rule other)| Parameter | |
|---|---|
| Name | Description |
other |
Rule |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Rule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Rule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeInputsUsed(InputsUsed value)
public Rule.Builder mergeInputsUsed(InputsUsed value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
InputsUsed |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeRevisionCreateTime(Timestamp value)
public Rule.Builder mergeRevisionCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeSeverity(Severity value)
public Rule.Builder mergeSeverity(Severity value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Severity |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
putAllMetadata(Map<String,String> values)
public Rule.Builder putAllMetadata(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
putMetadata(String key, String value)
public Rule.Builder putMetadata(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
removeCompilationDiagnostics(int index)
public Rule.Builder removeCompilationDiagnostics(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 |
Rule.Builder |
|
removeMetadata(String key)
public Rule.Builder removeMetadata(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 |
Rule.Builder |
|
setAllowedRunFrequencies(int index, RunFrequency value)
public Rule.Builder setAllowedRunFrequencies(int index, RunFrequency value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
RunFrequencyThe allowedRunFrequencies to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setAllowedRunFrequenciesValue(int index, int value)
public Rule.Builder setAllowedRunFrequenciesValue(int index, int value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for allowedRunFrequencies to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setAuthor(String value)
public Rule.Builder setAuthor(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe author to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setAuthorBytes(ByteString value)
public Rule.Builder setAuthorBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for author to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setCompilationDiagnostics(int index, CompilationDiagnostic value)
public Rule.Builder setCompilationDiagnostics(int index, CompilationDiagnostic value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CompilationDiagnostic |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setCompilationDiagnostics(int index, CompilationDiagnostic.Builder builderForValue)
public Rule.Builder setCompilationDiagnostics(int index, CompilationDiagnostic.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CompilationDiagnostic.Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setCompilationState(Rule.CompilationState value)
public Rule.Builder setCompilationState(Rule.CompilationState value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Rule.CompilationStateThe compilationState to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setCompilationStateValue(int value)
public Rule.Builder setCompilationStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for compilationState to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public Rule.Builder setCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Rule.Builder setCreateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setDisplayName(String value)
public Rule.Builder setDisplayName(String value)Output only. Display name of the rule. Populated in BASIC view and FULL view.
string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Rule.Builder setDisplayNameBytes(ByteString value)Output only. Display name of the rule. Populated in BASIC view and FULL view.
string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setEtag(String value)
public Rule.Builder setEtag(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Rule.Builder setEtagBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Rule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setInputsUsed(InputsUsed value)
public Rule.Builder setInputsUsed(InputsUsed value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
InputsUsed |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setInputsUsed(InputsUsed.Builder builderForValue)
public Rule.Builder setInputsUsed(InputsUsed.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
InputsUsed.Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setName(String value)
public Rule.Builder setName(String value) Identifier. Full resource name for the rule.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Rule.Builder setNameBytes(ByteString value) Identifier. Full resource name for the rule.
Format:
projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setNearRealTimeLiveRuleEligible(boolean value)
public Rule.Builder setNearRealTimeLiveRuleEligible(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe nearRealTimeLiveRuleEligible to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setReferenceLists(int index, String value)
public Rule.Builder setReferenceLists(int index, String value)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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe referenceLists to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Rule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setRevisionCreateTime(Timestamp value)
public Rule.Builder setRevisionCreateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setRevisionCreateTime(Timestamp.Builder builderForValue)
public Rule.Builder setRevisionCreateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setRevisionId(String value)
public Rule.Builder setRevisionId(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe revisionId to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setRevisionIdBytes(ByteString value)
public Rule.Builder setRevisionIdBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for revisionId to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setScope(String value)
public Rule.Builder setScope(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe scope to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setScopeBytes(ByteString value)
public Rule.Builder setScopeBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for scope to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setSeverity(Severity value)
public Rule.Builder setSeverity(Severity value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Severity |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setSeverity(Severity.Builder builderForValue)
public Rule.Builder setSeverity(Severity.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Severity.Builder |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|
setText(String value)
public Rule.Builder setText(String value)The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe text to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setTextBytes(ByteString value)
public Rule.Builder setTextBytes(ByteString value)The YARA-L content of the rule. Populated in FULL view.
string text = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for text to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setType(RuleType value)
public Rule.Builder setType(RuleType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RuleTypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setTypeValue(int value)
public Rule.Builder setTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Rule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.Builder |
|