Class SecurityResult.Builder (0.3.0)

public static final class SecurityResult.Builder extends GeneratedMessage.Builder<SecurityResult.Builder> implements SecurityResultOrBuilder

Security related metadata for the event. A security result might be something like "virus detected and quarantined," "malicious connection blocked," or "sensitive data included in document foo.doc." Each security result, of which there may be more than one, may either pertain to the whole event, or to a specific object or device referenced in the event (e.g. a malicious file that was detected, or a sensitive document sent as an email attachment). For security results that apply to a particular object referenced in the event, the security_results message MUST contain details about the implicated object (such as process, user, IP, domain, URL, IP, or email address) in the about field. For security results that apply to the entire event (e.g. SPAM found in this email), the about field must remain empty.

Protobuf type google.backstory.SecurityResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAction(SecurityResult.Action value)

public SecurityResult.Builder addAction(SecurityResult.Action value)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
value SecurityResult.Action

The action to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addActionValue(int value)

public SecurityResult.Builder addActionValue(int value)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for action to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllAction(Iterable<? extends SecurityResult.Action> values)

public SecurityResult.Builder addAllAction(Iterable<? extends SecurityResult.Action> values)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
values Iterable<? extends com.google.backstory.SecurityResult.Action>

The action to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllActionValue(Iterable<Integer> values)

public SecurityResult.Builder addAllActionValue(Iterable<Integer> values)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for action to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllAnalyticsMetadata(Iterable<? extends AnalyticsMetadata> values)

public SecurityResult.Builder addAllAnalyticsMetadata(Iterable<? extends AnalyticsMetadata> values)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
values Iterable<? extends com.google.backstory.AnalyticsMetadata>
Returns
Type Description
SecurityResult.Builder

addAllAssociations(Iterable<? extends SecurityResult.Association> values)

public SecurityResult.Builder addAllAssociations(Iterable<? extends SecurityResult.Association> values)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
values Iterable<? extends com.google.backstory.SecurityResult.Association>
Returns
Type Description
SecurityResult.Builder

addAllCampaigns(Iterable<String> values) (deprecated)

public SecurityResult.Builder addAllCampaigns(Iterable<String> values)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameter
Name Description
values Iterable<String>

The campaigns to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllCategory(Iterable<? extends SecurityResult.SecurityCategory> values)

public SecurityResult.Builder addAllCategory(Iterable<? extends SecurityResult.SecurityCategory> values)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
values Iterable<? extends com.google.backstory.SecurityResult.SecurityCategory>

The category to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllCategoryDetails(Iterable<String> values)

public SecurityResult.Builder addAllCategoryDetails(Iterable<String> values)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameter
Name Description
values Iterable<String>

The categoryDetails to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllCategoryValue(Iterable<Integer> values)

public SecurityResult.Builder addAllCategoryValue(Iterable<Integer> values)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for category to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllDetectionFields(Iterable<? extends Label> values)

public SecurityResult.Builder addAllDetectionFields(Iterable<? extends Label> values)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
values Iterable<? extends com.google.backstory.Label>
Returns
Type Description
SecurityResult.Builder

addAllOutcomes(Iterable<? extends Label> values) (deprecated)

public SecurityResult.Builder addAllOutcomes(Iterable<? extends Label> values)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
values Iterable<? extends com.google.backstory.Label>
Returns
Type Description
SecurityResult.Builder

addAllReports(Iterable<String> values) (deprecated)

public SecurityResult.Builder addAllReports(Iterable<String> values)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameter
Name Description
values Iterable<String>

The reports to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addAllRuleLabels(Iterable<? extends Label> values)

public SecurityResult.Builder addAllRuleLabels(Iterable<? extends Label> values)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
values Iterable<? extends com.google.backstory.Label>
Returns
Type Description
SecurityResult.Builder

addAllThreatCollections(Iterable<? extends SecurityResult.ThreatCollectionItem> values)

public SecurityResult.Builder addAllThreatCollections(Iterable<? extends SecurityResult.ThreatCollectionItem> values)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
values Iterable<? extends com.google.backstory.SecurityResult.ThreatCollectionItem>
Returns
Type Description
SecurityResult.Builder

addAllVerdictInfo(Iterable<? extends SecurityResult.VerdictInfo> values)

public SecurityResult.Builder addAllVerdictInfo(Iterable<? extends SecurityResult.VerdictInfo> values)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
values Iterable<? extends com.google.backstory.SecurityResult.VerdictInfo>
Returns
Type Description
SecurityResult.Builder

addAnalyticsMetadata(AnalyticsMetadata value)

public SecurityResult.Builder addAnalyticsMetadata(AnalyticsMetadata value)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
value AnalyticsMetadata
Returns
Type Description
SecurityResult.Builder

addAnalyticsMetadata(AnalyticsMetadata.Builder builderForValue)

public SecurityResult.Builder addAnalyticsMetadata(AnalyticsMetadata.Builder builderForValue)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
builderForValue AnalyticsMetadata.Builder
Returns
Type Description
SecurityResult.Builder

addAnalyticsMetadata(int index, AnalyticsMetadata value)

public SecurityResult.Builder addAnalyticsMetadata(int index, AnalyticsMetadata value)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameters
Name Description
index int
value AnalyticsMetadata
Returns
Type Description
SecurityResult.Builder

addAnalyticsMetadata(int index, AnalyticsMetadata.Builder builderForValue)

public SecurityResult.Builder addAnalyticsMetadata(int index, AnalyticsMetadata.Builder builderForValue)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameters
Name Description
index int
builderForValue AnalyticsMetadata.Builder
Returns
Type Description
SecurityResult.Builder

addAnalyticsMetadataBuilder()

public AnalyticsMetadata.Builder addAnalyticsMetadataBuilder()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
AnalyticsMetadata.Builder

addAnalyticsMetadataBuilder(int index)

public AnalyticsMetadata.Builder addAnalyticsMetadataBuilder(int index)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
index int
Returns
Type Description
AnalyticsMetadata.Builder

addAssociations(SecurityResult.Association value)

public SecurityResult.Builder addAssociations(SecurityResult.Association value)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
value SecurityResult.Association
Returns
Type Description
SecurityResult.Builder

addAssociations(SecurityResult.Association.Builder builderForValue)

public SecurityResult.Builder addAssociations(SecurityResult.Association.Builder builderForValue)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
builderForValue SecurityResult.Association.Builder
Returns
Type Description
SecurityResult.Builder

addAssociations(int index, SecurityResult.Association value)

public SecurityResult.Builder addAssociations(int index, SecurityResult.Association value)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameters
Name Description
index int
value SecurityResult.Association
Returns
Type Description
SecurityResult.Builder

addAssociations(int index, SecurityResult.Association.Builder builderForValue)

public SecurityResult.Builder addAssociations(int index, SecurityResult.Association.Builder builderForValue)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameters
Name Description
index int
builderForValue SecurityResult.Association.Builder
Returns
Type Description
SecurityResult.Builder

addAssociationsBuilder()

public SecurityResult.Association.Builder addAssociationsBuilder()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
SecurityResult.Association.Builder

addAssociationsBuilder(int index)

public SecurityResult.Association.Builder addAssociationsBuilder(int index)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Association.Builder

addCampaigns(String value) (deprecated)

public SecurityResult.Builder addCampaigns(String value)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameter
Name Description
value String

The campaigns to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addCampaignsBytes(ByteString value) (deprecated)

public SecurityResult.Builder addCampaignsBytes(ByteString value)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes of the campaigns to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addCategory(SecurityResult.SecurityCategory value)

public SecurityResult.Builder addCategory(SecurityResult.SecurityCategory value)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
value SecurityResult.SecurityCategory

The category to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addCategoryDetails(String value)

public SecurityResult.Builder addCategoryDetails(String value)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameter
Name Description
value String

The categoryDetails to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addCategoryDetailsBytes(ByteString value)

public SecurityResult.Builder addCategoryDetailsBytes(ByteString value)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameter
Name Description
value ByteString

The bytes of the categoryDetails to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addCategoryValue(int value)

public SecurityResult.Builder addCategoryValue(int value)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for category to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addDetectionFields(Label value)

public SecurityResult.Builder addDetectionFields(Label value)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
value Label
Returns
Type Description
SecurityResult.Builder

addDetectionFields(Label.Builder builderForValue)

public SecurityResult.Builder addDetectionFields(Label.Builder builderForValue)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addDetectionFields(int index, Label value)

public SecurityResult.Builder addDetectionFields(int index, Label value)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

addDetectionFields(int index, Label.Builder builderForValue)

public SecurityResult.Builder addDetectionFields(int index, Label.Builder builderForValue)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addDetectionFieldsBuilder()

public Label.Builder addDetectionFieldsBuilder()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
Label.Builder

addDetectionFieldsBuilder(int index)

public Label.Builder addDetectionFieldsBuilder(int index)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

addOutcomes(Label value) (deprecated)

public SecurityResult.Builder addOutcomes(Label value)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
value Label
Returns
Type Description
SecurityResult.Builder

addOutcomes(Label.Builder builderForValue) (deprecated)

public SecurityResult.Builder addOutcomes(Label.Builder builderForValue)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addOutcomes(int index, Label value) (deprecated)

public SecurityResult.Builder addOutcomes(int index, Label value)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

addOutcomes(int index, Label.Builder builderForValue) (deprecated)

public SecurityResult.Builder addOutcomes(int index, Label.Builder builderForValue)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addOutcomesBuilder() (deprecated)

public Label.Builder addOutcomesBuilder()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
Label.Builder

addOutcomesBuilder(int index) (deprecated)

public Label.Builder addOutcomesBuilder(int index)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

addReports(String value) (deprecated)

public SecurityResult.Builder addReports(String value)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameter
Name Description
value String

The reports to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addReportsBytes(ByteString value) (deprecated)

public SecurityResult.Builder addReportsBytes(ByteString value)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes of the reports to add.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

addRuleLabels(Label value)

public SecurityResult.Builder addRuleLabels(Label value)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
value Label
Returns
Type Description
SecurityResult.Builder

addRuleLabels(Label.Builder builderForValue)

public SecurityResult.Builder addRuleLabels(Label.Builder builderForValue)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addRuleLabels(int index, Label value)

public SecurityResult.Builder addRuleLabels(int index, Label value)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

addRuleLabels(int index, Label.Builder builderForValue)

public SecurityResult.Builder addRuleLabels(int index, Label.Builder builderForValue)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

addRuleLabelsBuilder()

public Label.Builder addRuleLabelsBuilder()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
Label.Builder

addRuleLabelsBuilder(int index)

public Label.Builder addRuleLabelsBuilder(int index)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

addThreatCollections(SecurityResult.ThreatCollectionItem value)

public SecurityResult.Builder addThreatCollections(SecurityResult.ThreatCollectionItem value)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
value SecurityResult.ThreatCollectionItem
Returns
Type Description
SecurityResult.Builder

addThreatCollections(SecurityResult.ThreatCollectionItem.Builder builderForValue)

public SecurityResult.Builder addThreatCollections(SecurityResult.ThreatCollectionItem.Builder builderForValue)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
builderForValue SecurityResult.ThreatCollectionItem.Builder
Returns
Type Description
SecurityResult.Builder

addThreatCollections(int index, SecurityResult.ThreatCollectionItem value)

public SecurityResult.Builder addThreatCollections(int index, SecurityResult.ThreatCollectionItem value)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameters
Name Description
index int
value SecurityResult.ThreatCollectionItem
Returns
Type Description
SecurityResult.Builder

addThreatCollections(int index, SecurityResult.ThreatCollectionItem.Builder builderForValue)

public SecurityResult.Builder addThreatCollections(int index, SecurityResult.ThreatCollectionItem.Builder builderForValue)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameters
Name Description
index int
builderForValue SecurityResult.ThreatCollectionItem.Builder
Returns
Type Description
SecurityResult.Builder

addThreatCollectionsBuilder()

public SecurityResult.ThreatCollectionItem.Builder addThreatCollectionsBuilder()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
SecurityResult.ThreatCollectionItem.Builder

addThreatCollectionsBuilder(int index)

public SecurityResult.ThreatCollectionItem.Builder addThreatCollectionsBuilder(int index)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.ThreatCollectionItem.Builder

addVerdictInfo(SecurityResult.VerdictInfo value)

public SecurityResult.Builder addVerdictInfo(SecurityResult.VerdictInfo value)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
value SecurityResult.VerdictInfo
Returns
Type Description
SecurityResult.Builder

addVerdictInfo(SecurityResult.VerdictInfo.Builder builderForValue)

public SecurityResult.Builder addVerdictInfo(SecurityResult.VerdictInfo.Builder builderForValue)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
builderForValue SecurityResult.VerdictInfo.Builder
Returns
Type Description
SecurityResult.Builder

addVerdictInfo(int index, SecurityResult.VerdictInfo value)

public SecurityResult.Builder addVerdictInfo(int index, SecurityResult.VerdictInfo value)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameters
Name Description
index int
value SecurityResult.VerdictInfo
Returns
Type Description
SecurityResult.Builder

addVerdictInfo(int index, SecurityResult.VerdictInfo.Builder builderForValue)

public SecurityResult.Builder addVerdictInfo(int index, SecurityResult.VerdictInfo.Builder builderForValue)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameters
Name Description
index int
builderForValue SecurityResult.VerdictInfo.Builder
Returns
Type Description
SecurityResult.Builder

addVerdictInfoBuilder()

public SecurityResult.VerdictInfo.Builder addVerdictInfoBuilder()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
SecurityResult.VerdictInfo.Builder

addVerdictInfoBuilder(int index)

public SecurityResult.VerdictInfo.Builder addVerdictInfoBuilder(int index)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.VerdictInfo.Builder

build()

public SecurityResult build()
Returns
Type Description
SecurityResult

buildPartial()

public SecurityResult buildPartial()
Returns
Type Description
SecurityResult

clear()

public SecurityResult.Builder clear()
Returns
Type Description
SecurityResult.Builder
Overrides

clearAbout()

public SecurityResult.Builder clearAbout()

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Returns
Type Description
SecurityResult.Builder

clearAction()

public SecurityResult.Builder clearAction()

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearActionDetails()

public SecurityResult.Builder clearActionDetails()

The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a detection.

string action_details = 19;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearAlertState()

public SecurityResult.Builder clearAlertState()

The alerting types of this security result. This is primarily set for rule-generated detections and alerts.

.google.backstory.SecurityResult.AlertState alert_state = 21;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearAnalyticsMetadata()

public SecurityResult.Builder clearAnalyticsMetadata()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
SecurityResult.Builder

clearAssociations()

public SecurityResult.Builder clearAssociations()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
SecurityResult.Builder

clearAttackDetails()

public SecurityResult.Builder clearAttackDetails()

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Returns
Type Description
SecurityResult.Builder

clearCampaigns() (deprecated)

public SecurityResult.Builder clearCampaigns()

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearCategory()

public SecurityResult.Builder clearCategory()

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearCategoryDetails()

public SecurityResult.Builder clearCategoryDetails()

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearConfidence()

public SecurityResult.Builder clearConfidence()

The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductConfidence confidence = 10;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearConfidenceDetails()

public SecurityResult.Builder clearConfidenceDetails()

Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a detection.

string confidence_details = 13;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearConfidenceScore()

public SecurityResult.Builder clearConfidenceScore()

The confidence score of the security result. This field is not populated when the SecurityResult appears in a detection.

float confidence_score = 42;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearDescription()

public SecurityResult.Builder clearDescription()

A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary.

string description = 7;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearDetectionDepth()

public SecurityResult.Builder clearDetectionDepth()

The depth of the detection chain. Applies only to composite detections.

int64 detection_depth = 47;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearDetectionFields()

public SecurityResult.Builder clearDetectionFields()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
SecurityResult.Builder

clearDisplayName()

public SecurityResult.Builder clearDisplayName()

The display name of the security result. This is populated from 'name_override' Outcome Variable, if present. Otherwise, this field is not set.

string display_name = 49;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearFirstDiscoveredTime()

public SecurityResult.Builder clearFirstDiscoveredTime()

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Returns
Type Description
SecurityResult.Builder

clearLastDiscoveredTime()

public SecurityResult.Builder clearLastDiscoveredTime()

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Returns
Type Description
SecurityResult.Builder

clearLastUpdatedTime()

public SecurityResult.Builder clearLastUpdatedTime()

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Returns
Type Description
SecurityResult.Builder

clearOutcomes() (deprecated)

public SecurityResult.Builder clearOutcomes()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
SecurityResult.Builder

clearPriority()

public SecurityResult.Builder clearPriority()

The priority of the result. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductPriority priority = 11;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearPriorityDetails()

public SecurityResult.Builder clearPriorityDetails()

Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a detection.

string priority_details = 14;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearReports() (deprecated)

public SecurityResult.Builder clearReports()

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRiskScore()

public SecurityResult.Builder clearRiskScore()

The risk score of the security result.

float risk_score = 31;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleAuthor()

public SecurityResult.Builder clearRuleAuthor()

Author of the security rule. This field is not populated when the SecurityResult appears in a detection.

string rule_author = 25;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleId()

public SecurityResult.Builder clearRuleId()

A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe").

string rule_id = 16;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleLabels()

public SecurityResult.Builder clearRuleLabels()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
SecurityResult.Builder

clearRuleName()

public SecurityResult.Builder clearRuleName()

Name of the security rule (e.g. "BlockInboundToOracle").

string rule_name = 5;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleSet()

public SecurityResult.Builder clearRuleSet()

The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts.

string rule_set = 29;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleSetDisplayName()

public SecurityResult.Builder clearRuleSetDisplayName()

The curated detections rule set display name. This is primarily set in rule-generated detections and alerts.

string rule_set_display_name = 30;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleType()

public SecurityResult.Builder clearRuleType()

The type of security rule.

string rule_type = 22;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRuleVersion()

public SecurityResult.Builder clearRuleVersion()

Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed.

string rule_version = 20;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearRulesetCategoryDisplayName()

public SecurityResult.Builder clearRulesetCategoryDisplayName()

The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts.

string ruleset_category_display_name = 41;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearSeverity()

public SecurityResult.Builder clearSeverity()

The severity of the result.

.google.backstory.SecurityResult.ProductSeverity severity = 9;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearSeverityDetails()

public SecurityResult.Builder clearSeverityDetails()

Vendor-specific severity. This field is not populated when the SecurityResult appears in a detection.

string severity_details = 12;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearSummary()

public SecurityResult.Builder clearSummary()

A short human-readable summary (e.g. "failed login occurred")

string summary = 6;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatCollections()

public SecurityResult.Builder clearThreatCollections()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
SecurityResult.Builder

clearThreatFeedName()

public SecurityResult.Builder clearThreatFeedName()

Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a detection.

string threat_feed_name = 27;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatId()

public SecurityResult.Builder clearThreatId()

Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a detection.

string threat_id = 17;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatIdNamespace()

public SecurityResult.Builder clearThreatIdNamespace()

The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Id.Namespace threat_id_namespace = 24;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatName()

public SecurityResult.Builder clearThreatName()

A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a detection.

string threat_name = 4;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatStatus()

public SecurityResult.Builder clearThreatStatus()

Current status of the threat This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ThreatStatus threat_status = 18;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearThreatVerdict()

public SecurityResult.Builder clearThreatVerdict()

GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.ThreatVerdict threat_verdict = 39;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearUrlBackToProduct()

public SecurityResult.Builder clearUrlBackToProduct()

URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a detection.

string url_back_to_product = 15;

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

clearVariables()

public SecurityResult.Builder clearVariables()
Returns
Type Description
SecurityResult.Builder

clearVerdict() (deprecated)

public SecurityResult.Builder clearVerdict()

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Returns
Type Description
SecurityResult.Builder

clearVerdictInfo()

public SecurityResult.Builder clearVerdictInfo()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
SecurityResult.Builder

containsVariables(String key)

public boolean containsVariables(String key)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAbout()

public Noun getAbout()

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Returns
Type Description
Noun

The about.

getAboutBuilder()

public Noun.Builder getAboutBuilder()

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Returns
Type Description
Noun.Builder

getAboutOrBuilder()

public NounOrBuilder getAboutOrBuilder()

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Returns
Type Description
NounOrBuilder

getAction(int index)

public SecurityResult.Action getAction(int index)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
SecurityResult.Action

The action at the given index.

getActionCount()

public int getActionCount()

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Returns
Type Description
int

The count of action.

getActionDetails()

public String getActionDetails()

The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a detection.

string action_details = 19;

Returns
Type Description
String

The actionDetails.

getActionDetailsBytes()

public ByteString getActionDetailsBytes()

The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a detection.

string action_details = 19;

Returns
Type Description
ByteString

The bytes for actionDetails.

getActionList()

public List<SecurityResult.Action> getActionList()

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Returns
Type Description
List<Action>

A list containing the action.

getActionValue(int index)

public int getActionValue(int index)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of action at the given index.

getActionValueList()

public List<Integer> getActionValueList()

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for action.

getAlertState()

public SecurityResult.AlertState getAlertState()

The alerting types of this security result. This is primarily set for rule-generated detections and alerts.

.google.backstory.SecurityResult.AlertState alert_state = 21;

Returns
Type Description
SecurityResult.AlertState

The alertState.

getAlertStateValue()

public int getAlertStateValue()

The alerting types of this security result. This is primarily set for rule-generated detections and alerts.

.google.backstory.SecurityResult.AlertState alert_state = 21;

Returns
Type Description
int

The enum numeric value on the wire for alertState.

getAnalyticsMetadata(int index)

public AnalyticsMetadata getAnalyticsMetadata(int index)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
index int
Returns
Type Description
AnalyticsMetadata

getAnalyticsMetadataBuilder(int index)

public AnalyticsMetadata.Builder getAnalyticsMetadataBuilder(int index)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
index int
Returns
Type Description
AnalyticsMetadata.Builder

getAnalyticsMetadataBuilderList()

public List<AnalyticsMetadata.Builder> getAnalyticsMetadataBuilderList()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
List<Builder>

getAnalyticsMetadataCount()

public int getAnalyticsMetadataCount()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
int

getAnalyticsMetadataList()

public List<AnalyticsMetadata> getAnalyticsMetadataList()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
List<AnalyticsMetadata>

getAnalyticsMetadataOrBuilder(int index)

public AnalyticsMetadataOrBuilder getAnalyticsMetadataOrBuilder(int index)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
index int
Returns
Type Description
AnalyticsMetadataOrBuilder

getAnalyticsMetadataOrBuilderList()

public List<? extends AnalyticsMetadataOrBuilder> getAnalyticsMetadataOrBuilderList()

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Returns
Type Description
List<? extends com.google.backstory.AnalyticsMetadataOrBuilder>

getAssociations(int index)

public SecurityResult.Association getAssociations(int index)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Association

getAssociationsBuilder(int index)

public SecurityResult.Association.Builder getAssociationsBuilder(int index)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Association.Builder

getAssociationsBuilderList()

public List<SecurityResult.Association.Builder> getAssociationsBuilderList()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
List<Builder>

getAssociationsCount()

public int getAssociationsCount()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
int

getAssociationsList()

public List<SecurityResult.Association> getAssociationsList()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
List<Association>

getAssociationsOrBuilder(int index)

public SecurityResult.AssociationOrBuilder getAssociationsOrBuilder(int index)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.AssociationOrBuilder

getAssociationsOrBuilderList()

public List<? extends SecurityResult.AssociationOrBuilder> getAssociationsOrBuilderList()

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Returns
Type Description
List<? extends com.google.backstory.SecurityResult.AssociationOrBuilder>

getAttackDetails()

public AttackDetails getAttackDetails()

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Returns
Type Description
AttackDetails

The attackDetails.

getAttackDetailsBuilder()

public AttackDetails.Builder getAttackDetailsBuilder()

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Returns
Type Description
AttackDetails.Builder

getAttackDetailsOrBuilder()

public AttackDetailsOrBuilder getAttackDetailsOrBuilder()

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Returns
Type Description
AttackDetailsOrBuilder

getCampaigns(int index) (deprecated)

public String getCampaigns(int index)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The campaigns at the given index.

getCampaignsBytes(int index) (deprecated)

public ByteString getCampaignsBytes(int index)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the campaigns at the given index.

getCampaignsCount() (deprecated)

public int getCampaignsCount()

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Returns
Type Description
int

The count of campaigns.

getCampaignsList() (deprecated)

public ProtocolStringList getCampaignsList()

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the campaigns.

getCategory(int index)

public SecurityResult.SecurityCategory getCategory(int index)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
SecurityResult.SecurityCategory

The category at the given index.

getCategoryCount()

public int getCategoryCount()

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Returns
Type Description
int

The count of category.

getCategoryDetails(int index)

public String getCategoryDetails(int index)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The categoryDetails at the given index.

getCategoryDetailsBytes(int index)

public ByteString getCategoryDetailsBytes(int index)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the categoryDetails at the given index.

getCategoryDetailsCount()

public int getCategoryDetailsCount()

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Returns
Type Description
int

The count of categoryDetails.

getCategoryDetailsList()

public ProtocolStringList getCategoryDetailsList()

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Returns
Type Description
ProtocolStringList

A list containing the categoryDetails.

getCategoryList()

public List<SecurityResult.SecurityCategory> getCategoryList()

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Returns
Type Description
List<SecurityCategory>

A list containing the category.

getCategoryValue(int index)

public int getCategoryValue(int index)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of category at the given index.

getCategoryValueList()

public List<Integer> getCategoryValueList()

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for category.

getConfidence()

public SecurityResult.ProductConfidence getConfidence()

The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductConfidence confidence = 10;

Returns
Type Description
SecurityResult.ProductConfidence

The confidence.

getConfidenceDetails()

public String getConfidenceDetails()

Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a detection.

string confidence_details = 13;

Returns
Type Description
String

The confidenceDetails.

getConfidenceDetailsBytes()

public ByteString getConfidenceDetailsBytes()

Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a detection.

string confidence_details = 13;

Returns
Type Description
ByteString

The bytes for confidenceDetails.

getConfidenceScore()

public float getConfidenceScore()

The confidence score of the security result. This field is not populated when the SecurityResult appears in a detection.

float confidence_score = 42;

Returns
Type Description
float

The confidenceScore.

getConfidenceValue()

public int getConfidenceValue()

The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductConfidence confidence = 10;

Returns
Type Description
int

The enum numeric value on the wire for confidence.

getDefaultInstanceForType()

public SecurityResult getDefaultInstanceForType()
Returns
Type Description
SecurityResult

getDescription()

public String getDescription()

A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetectionDepth()

public long getDetectionDepth()

The depth of the detection chain. Applies only to composite detections.

int64 detection_depth = 47;

Returns
Type Description
long

The detectionDepth.

getDetectionFields(int index)

public Label getDetectionFields(int index)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
index int
Returns
Type Description
Label

getDetectionFieldsBuilder(int index)

public Label.Builder getDetectionFieldsBuilder(int index)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

getDetectionFieldsBuilderList()

public List<Label.Builder> getDetectionFieldsBuilderList()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
List<Builder>

getDetectionFieldsCount()

public int getDetectionFieldsCount()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
int

getDetectionFieldsList()

public List<Label> getDetectionFieldsList()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
List<Label>

getDetectionFieldsOrBuilder(int index)

public LabelOrBuilder getDetectionFieldsOrBuilder(int index)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
index int
Returns
Type Description
LabelOrBuilder

getDetectionFieldsOrBuilderList()

public List<? extends LabelOrBuilder> getDetectionFieldsOrBuilderList()

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Returns
Type Description
List<? extends com.google.backstory.LabelOrBuilder>

getDisplayName()

public String getDisplayName()

The display name of the security result. This is populated from 'name_override' Outcome Variable, if present. Otherwise, this field is not set.

string display_name = 49;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the security result. This is populated from 'name_override' Outcome Variable, if present. Otherwise, this field is not set.

string display_name = 49;

Returns
Type Description
ByteString

The bytes for displayName.

getFirstDiscoveredTime()

public Timestamp getFirstDiscoveredTime()

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Returns
Type Description
Timestamp

The firstDiscoveredTime.

getFirstDiscoveredTimeBuilder()

public Timestamp.Builder getFirstDiscoveredTimeBuilder()

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Returns
Type Description
Builder

getFirstDiscoveredTimeOrBuilder()

public TimestampOrBuilder getFirstDiscoveredTimeOrBuilder()

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Returns
Type Description
TimestampOrBuilder

getLastDiscoveredTime()

public Timestamp getLastDiscoveredTime()

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Returns
Type Description
Timestamp

The lastDiscoveredTime.

getLastDiscoveredTimeBuilder()

public Timestamp.Builder getLastDiscoveredTimeBuilder()

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Returns
Type Description
Builder

getLastDiscoveredTimeOrBuilder()

public TimestampOrBuilder getLastDiscoveredTimeOrBuilder()

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Returns
Type Description
TimestampOrBuilder

getLastUpdatedTime()

public Timestamp getLastUpdatedTime()

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Returns
Type Description
Timestamp

The lastUpdatedTime.

getLastUpdatedTimeBuilder()

public Timestamp.Builder getLastUpdatedTimeBuilder()

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Returns
Type Description
Builder

getLastUpdatedTimeOrBuilder()

public TimestampOrBuilder getLastUpdatedTimeOrBuilder()

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Returns
Type Description
TimestampOrBuilder

getMutableVariables() (deprecated)

public Map<String,FindingVariable> getMutableVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,FindingVariable>

getOutcomes(int index) (deprecated)

public Label getOutcomes(int index)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Label

getOutcomesBuilder(int index) (deprecated)

public Label.Builder getOutcomesBuilder(int index)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

getOutcomesBuilderList() (deprecated)

public List<Label.Builder> getOutcomesBuilderList()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
List<Builder>

getOutcomesCount() (deprecated)

public int getOutcomesCount()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
int

getOutcomesList() (deprecated)

public List<Label> getOutcomesList()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
List<Label>

getOutcomesOrBuilder(int index) (deprecated)

public LabelOrBuilder getOutcomesOrBuilder(int index)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
LabelOrBuilder

getOutcomesOrBuilderList() (deprecated)

public List<? extends LabelOrBuilder> getOutcomesOrBuilderList()

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Returns
Type Description
List<? extends com.google.backstory.LabelOrBuilder>

getPriority()

public SecurityResult.ProductPriority getPriority()

The priority of the result. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductPriority priority = 11;

Returns
Type Description
SecurityResult.ProductPriority

The priority.

getPriorityDetails()

public String getPriorityDetails()

Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a detection.

string priority_details = 14;

Returns
Type Description
String

The priorityDetails.

getPriorityDetailsBytes()

public ByteString getPriorityDetailsBytes()

Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a detection.

string priority_details = 14;

Returns
Type Description
ByteString

The bytes for priorityDetails.

getPriorityValue()

public int getPriorityValue()

The priority of the result. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductPriority priority = 11;

Returns
Type Description
int

The enum numeric value on the wire for priority.

getReports(int index) (deprecated)

public String getReports(int index)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The reports at the given index.

getReportsBytes(int index) (deprecated)

public ByteString getReportsBytes(int index)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the reports at the given index.

getReportsCount() (deprecated)

public int getReportsCount()

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Returns
Type Description
int

The count of reports.

getReportsList() (deprecated)

public ProtocolStringList getReportsList()

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the reports.

getRiskScore()

public float getRiskScore()

The risk score of the security result.

float risk_score = 31;

Returns
Type Description
float

The riskScore.

getRuleAuthor()

public String getRuleAuthor()

Author of the security rule. This field is not populated when the SecurityResult appears in a detection.

string rule_author = 25;

Returns
Type Description
String

The ruleAuthor.

getRuleAuthorBytes()

public ByteString getRuleAuthorBytes()

Author of the security rule. This field is not populated when the SecurityResult appears in a detection.

string rule_author = 25;

Returns
Type Description
ByteString

The bytes for ruleAuthor.

getRuleId()

public String getRuleId()

A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe").

string rule_id = 16;

Returns
Type Description
String

The ruleId.

getRuleIdBytes()

public ByteString getRuleIdBytes()

A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe").

string rule_id = 16;

Returns
Type Description
ByteString

The bytes for ruleId.

getRuleLabels(int index)

public Label getRuleLabels(int index)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
index int
Returns
Type Description
Label

getRuleLabelsBuilder(int index)

public Label.Builder getRuleLabelsBuilder(int index)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
index int
Returns
Type Description
Label.Builder

getRuleLabelsBuilderList()

public List<Label.Builder> getRuleLabelsBuilderList()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
List<Builder>

getRuleLabelsCount()

public int getRuleLabelsCount()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
int

getRuleLabelsList()

public List<Label> getRuleLabelsList()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
List<Label>

getRuleLabelsOrBuilder(int index)

public LabelOrBuilder getRuleLabelsOrBuilder(int index)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
index int
Returns
Type Description
LabelOrBuilder

getRuleLabelsOrBuilderList()

public List<? extends LabelOrBuilder> getRuleLabelsOrBuilderList()

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Returns
Type Description
List<? extends com.google.backstory.LabelOrBuilder>

getRuleName()

public String getRuleName()

Name of the security rule (e.g. "BlockInboundToOracle").

string rule_name = 5;

Returns
Type Description
String

The ruleName.

getRuleNameBytes()

public ByteString getRuleNameBytes()

Name of the security rule (e.g. "BlockInboundToOracle").

string rule_name = 5;

Returns
Type Description
ByteString

The bytes for ruleName.

getRuleSet()

public String getRuleSet()

The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts.

string rule_set = 29;

Returns
Type Description
String

The ruleSet.

getRuleSetBytes()

public ByteString getRuleSetBytes()

The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts.

string rule_set = 29;

Returns
Type Description
ByteString

The bytes for ruleSet.

getRuleSetDisplayName()

public String getRuleSetDisplayName()

The curated detections rule set display name. This is primarily set in rule-generated detections and alerts.

string rule_set_display_name = 30;

Returns
Type Description
String

The ruleSetDisplayName.

getRuleSetDisplayNameBytes()

public ByteString getRuleSetDisplayNameBytes()

The curated detections rule set display name. This is primarily set in rule-generated detections and alerts.

string rule_set_display_name = 30;

Returns
Type Description
ByteString

The bytes for ruleSetDisplayName.

getRuleType()

public String getRuleType()

The type of security rule.

string rule_type = 22;

Returns
Type Description
String

The ruleType.

getRuleTypeBytes()

public ByteString getRuleTypeBytes()

The type of security rule.

string rule_type = 22;

Returns
Type Description
ByteString

The bytes for ruleType.

getRuleVersion()

public String getRuleVersion()

Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed.

string rule_version = 20;

Returns
Type Description
String

The ruleVersion.

getRuleVersionBytes()

public ByteString getRuleVersionBytes()

Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed.

string rule_version = 20;

Returns
Type Description
ByteString

The bytes for ruleVersion.

getRulesetCategoryDisplayName()

public String getRulesetCategoryDisplayName()

The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts.

string ruleset_category_display_name = 41;

Returns
Type Description
String

The rulesetCategoryDisplayName.

getRulesetCategoryDisplayNameBytes()

public ByteString getRulesetCategoryDisplayNameBytes()

The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts.

string ruleset_category_display_name = 41;

Returns
Type Description
ByteString

The bytes for rulesetCategoryDisplayName.

getSeverity()

public SecurityResult.ProductSeverity getSeverity()

The severity of the result.

.google.backstory.SecurityResult.ProductSeverity severity = 9;

Returns
Type Description
SecurityResult.ProductSeverity

The severity.

getSeverityDetails()

public String getSeverityDetails()

Vendor-specific severity. This field is not populated when the SecurityResult appears in a detection.

string severity_details = 12;

Returns
Type Description
String

The severityDetails.

getSeverityDetailsBytes()

public ByteString getSeverityDetailsBytes()

Vendor-specific severity. This field is not populated when the SecurityResult appears in a detection.

string severity_details = 12;

Returns
Type Description
ByteString

The bytes for severityDetails.

getSeverityValue()

public int getSeverityValue()

The severity of the result.

.google.backstory.SecurityResult.ProductSeverity severity = 9;

Returns
Type Description
int

The enum numeric value on the wire for severity.

getSummary()

public String getSummary()

A short human-readable summary (e.g. "failed login occurred")

string summary = 6;

Returns
Type Description
String

The summary.

getSummaryBytes()

public ByteString getSummaryBytes()

A short human-readable summary (e.g. "failed login occurred")

string summary = 6;

Returns
Type Description
ByteString

The bytes for summary.

getThreatCollections(int index)

public SecurityResult.ThreatCollectionItem getThreatCollections(int index)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.ThreatCollectionItem

getThreatCollectionsBuilder(int index)

public SecurityResult.ThreatCollectionItem.Builder getThreatCollectionsBuilder(int index)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.ThreatCollectionItem.Builder

getThreatCollectionsBuilderList()

public List<SecurityResult.ThreatCollectionItem.Builder> getThreatCollectionsBuilderList()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
List<Builder>

getThreatCollectionsCount()

public int getThreatCollectionsCount()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
int

getThreatCollectionsList()

public List<SecurityResult.ThreatCollectionItem> getThreatCollectionsList()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
List<ThreatCollectionItem>

getThreatCollectionsOrBuilder(int index)

public SecurityResult.ThreatCollectionItemOrBuilder getThreatCollectionsOrBuilder(int index)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.ThreatCollectionItemOrBuilder

getThreatCollectionsOrBuilderList()

public List<? extends SecurityResult.ThreatCollectionItemOrBuilder> getThreatCollectionsOrBuilderList()

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Returns
Type Description
List<? extends com.google.backstory.SecurityResult.ThreatCollectionItemOrBuilder>

getThreatFeedName()

public String getThreatFeedName()

Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a detection.

string threat_feed_name = 27;

Returns
Type Description
String

The threatFeedName.

getThreatFeedNameBytes()

public ByteString getThreatFeedNameBytes()

Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a detection.

string threat_feed_name = 27;

Returns
Type Description
ByteString

The bytes for threatFeedName.

getThreatId()

public String getThreatId()

Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a detection.

string threat_id = 17;

Returns
Type Description
String

The threatId.

getThreatIdBytes()

public ByteString getThreatIdBytes()

Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a detection.

string threat_id = 17;

Returns
Type Description
ByteString

The bytes for threatId.

getThreatIdNamespace()

public Id.Namespace getThreatIdNamespace()

The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Id.Namespace threat_id_namespace = 24;

Returns
Type Description
Id.Namespace

The threatIdNamespace.

getThreatIdNamespaceValue()

public int getThreatIdNamespaceValue()

The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Id.Namespace threat_id_namespace = 24;

Returns
Type Description
int

The enum numeric value on the wire for threatIdNamespace.

getThreatName()

public String getThreatName()

A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a detection.

string threat_name = 4;

Returns
Type Description
String

The threatName.

getThreatNameBytes()

public ByteString getThreatNameBytes()

A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a detection.

string threat_name = 4;

Returns
Type Description
ByteString

The bytes for threatName.

getThreatStatus()

public SecurityResult.ThreatStatus getThreatStatus()

Current status of the threat This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ThreatStatus threat_status = 18;

Returns
Type Description
SecurityResult.ThreatStatus

The threatStatus.

getThreatStatusValue()

public int getThreatStatusValue()

Current status of the threat This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ThreatStatus threat_status = 18;

Returns
Type Description
int

The enum numeric value on the wire for threatStatus.

getThreatVerdict()

public ThreatVerdict getThreatVerdict()

GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.ThreatVerdict threat_verdict = 39;

Returns
Type Description
ThreatVerdict

The threatVerdict.

getThreatVerdictValue()

public int getThreatVerdictValue()

GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.ThreatVerdict threat_verdict = 39;

Returns
Type Description
int

The enum numeric value on the wire for threatVerdict.

getUrlBackToProduct()

public String getUrlBackToProduct()

URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a detection.

string url_back_to_product = 15;

Returns
Type Description
String

The urlBackToProduct.

getUrlBackToProductBytes()

public ByteString getUrlBackToProductBytes()

URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a detection.

string url_back_to_product = 15;

Returns
Type Description
ByteString

The bytes for urlBackToProduct.

getVariables() (deprecated)

public Map<String,FindingVariable> getVariables()

Use #getVariablesMap() instead.

Returns
Type Description
Map<String,FindingVariable>

getVariablesCount()

public int getVariablesCount()

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Returns
Type Description
int

getVariablesMap()

public Map<String,FindingVariable> getVariablesMap()

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Returns
Type Description
Map<String,FindingVariable>

getVariablesOrDefault(String key, FindingVariable defaultValue)

public FindingVariable getVariablesOrDefault(String key, FindingVariable defaultValue)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameters
Name Description
key String
defaultValue FindingVariable
Returns
Type Description
FindingVariable

getVariablesOrThrow(String key)

public FindingVariable getVariablesOrThrow(String key)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameter
Name Description
key String
Returns
Type Description
FindingVariable

getVerdict() (deprecated)

public SecurityResult.Verdict getVerdict()

Deprecated. google.backstory.SecurityResult.verdict is deprecated. See backstory/udm.proto;l=2726

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Returns
Type Description
SecurityResult.Verdict

The verdict.

getVerdictBuilder() (deprecated)

public SecurityResult.Verdict.Builder getVerdictBuilder()

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Returns
Type Description
SecurityResult.Verdict.Builder

getVerdictInfo(int index)

public SecurityResult.VerdictInfo getVerdictInfo(int index)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.VerdictInfo

getVerdictInfoBuilder(int index)

public SecurityResult.VerdictInfo.Builder getVerdictInfoBuilder(int index)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.VerdictInfo.Builder

getVerdictInfoBuilderList()

public List<SecurityResult.VerdictInfo.Builder> getVerdictInfoBuilderList()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
List<Builder>

getVerdictInfoCount()

public int getVerdictInfoCount()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
int

getVerdictInfoList()

public List<SecurityResult.VerdictInfo> getVerdictInfoList()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
List<VerdictInfo>

getVerdictInfoOrBuilder(int index)

public SecurityResult.VerdictInfoOrBuilder getVerdictInfoOrBuilder(int index)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.VerdictInfoOrBuilder

getVerdictInfoOrBuilderList()

public List<? extends SecurityResult.VerdictInfoOrBuilder> getVerdictInfoOrBuilderList()

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Returns
Type Description
List<? extends com.google.backstory.SecurityResult.VerdictInfoOrBuilder>

getVerdictOrBuilder() (deprecated)

public SecurityResult.VerdictOrBuilder getVerdictOrBuilder()

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Returns
Type Description
SecurityResult.VerdictOrBuilder

hasAbout()

public boolean hasAbout()

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Returns
Type Description
boolean

Whether the about field is set.

hasAttackDetails()

public boolean hasAttackDetails()

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Returns
Type Description
boolean

Whether the attackDetails field is set.

hasFirstDiscoveredTime()

public boolean hasFirstDiscoveredTime()

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Returns
Type Description
boolean

Whether the firstDiscoveredTime field is set.

hasLastDiscoveredTime()

public boolean hasLastDiscoveredTime()

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Returns
Type Description
boolean

Whether the lastDiscoveredTime field is set.

hasLastUpdatedTime()

public boolean hasLastUpdatedTime()

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Returns
Type Description
boolean

Whether the lastUpdatedTime field is set.

hasVerdict() (deprecated)

public boolean hasVerdict()

Deprecated. google.backstory.SecurityResult.verdict is deprecated. See backstory/udm.proto;l=2726

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Returns
Type Description
boolean

Whether the verdict field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAbout(Noun value)

public SecurityResult.Builder mergeAbout(Noun value)

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Parameter
Name Description
value Noun
Returns
Type Description
SecurityResult.Builder

mergeAttackDetails(AttackDetails value)

public SecurityResult.Builder mergeAttackDetails(AttackDetails value)

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Parameter
Name Description
value AttackDetails
Returns
Type Description
SecurityResult.Builder

mergeFirstDiscoveredTime(Timestamp value)

public SecurityResult.Builder mergeFirstDiscoveredTime(Timestamp value)

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

mergeFrom(SecurityResult other)

public SecurityResult.Builder mergeFrom(SecurityResult other)
Parameter
Name Description
other SecurityResult
Returns
Type Description
SecurityResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecurityResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecurityResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecurityResult.Builder
Overrides

mergeLastDiscoveredTime(Timestamp value)

public SecurityResult.Builder mergeLastDiscoveredTime(Timestamp value)

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

mergeLastUpdatedTime(Timestamp value)

public SecurityResult.Builder mergeLastUpdatedTime(Timestamp value)

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

mergeVerdict(SecurityResult.Verdict value) (deprecated)

public SecurityResult.Builder mergeVerdict(SecurityResult.Verdict value)

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Parameter
Name Description
value SecurityResult.Verdict
Returns
Type Description
SecurityResult.Builder

putAllVariables(Map<String,FindingVariable> values)

public SecurityResult.Builder putAllVariables(Map<String,FindingVariable> values)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameter
Name Description
values Map<String,FindingVariable>
Returns
Type Description
SecurityResult.Builder

putVariables(String key, FindingVariable value)

public SecurityResult.Builder putVariables(String key, FindingVariable value)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameters
Name Description
key String
value FindingVariable
Returns
Type Description
SecurityResult.Builder

putVariablesBuilderIfAbsent(String key)

public FindingVariable.Builder putVariablesBuilderIfAbsent(String key)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameter
Name Description
key String
Returns
Type Description
FindingVariable.Builder

removeAnalyticsMetadata(int index)

public SecurityResult.Builder removeAnalyticsMetadata(int index)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeAssociations(int index)

public SecurityResult.Builder removeAssociations(int index)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeDetectionFields(int index)

public SecurityResult.Builder removeDetectionFields(int index)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeOutcomes(int index) (deprecated)

public SecurityResult.Builder removeOutcomes(int index)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeRuleLabels(int index)

public SecurityResult.Builder removeRuleLabels(int index)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeThreatCollections(int index)

public SecurityResult.Builder removeThreatCollections(int index)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

removeVariables(String key)

public SecurityResult.Builder removeVariables(String key)

A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values.

This is only populated when the SecurityResult appears in a detection.

map<string, .google.backstory.FindingVariable> variables = 44;

Parameter
Name Description
key String
Returns
Type Description
SecurityResult.Builder

removeVerdictInfo(int index)

public SecurityResult.Builder removeVerdictInfo(int index)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameter
Name Description
index int
Returns
Type Description
SecurityResult.Builder

setAbout(Noun value)

public SecurityResult.Builder setAbout(Noun value)

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Parameter
Name Description
value Noun
Returns
Type Description
SecurityResult.Builder

setAbout(Noun.Builder builderForValue)

public SecurityResult.Builder setAbout(Noun.Builder builderForValue)

If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Noun about = 1;

Parameter
Name Description
builderForValue Noun.Builder
Returns
Type Description
SecurityResult.Builder

setAction(int index, SecurityResult.Action value)

public SecurityResult.Builder setAction(int index, SecurityResult.Action value)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameters
Name Description
index int

The index to set the value at.

value SecurityResult.Action

The action to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setActionDetails(String value)

public SecurityResult.Builder setActionDetails(String value)

The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a detection.

string action_details = 19;

Parameter
Name Description
value String

The actionDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setActionDetailsBytes(ByteString value)

public SecurityResult.Builder setActionDetailsBytes(ByteString value)

The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a detection.

string action_details = 19;

Parameter
Name Description
value ByteString

The bytes for actionDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setActionValue(int index, int value)

public SecurityResult.Builder setActionValue(int index, int value)

Actions taken for this event. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.Action action = 8;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for action to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setAlertState(SecurityResult.AlertState value)

public SecurityResult.Builder setAlertState(SecurityResult.AlertState value)

The alerting types of this security result. This is primarily set for rule-generated detections and alerts.

.google.backstory.SecurityResult.AlertState alert_state = 21;

Parameter
Name Description
value SecurityResult.AlertState

The alertState to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setAlertStateValue(int value)

public SecurityResult.Builder setAlertStateValue(int value)

The alerting types of this security result. This is primarily set for rule-generated detections and alerts.

.google.backstory.SecurityResult.AlertState alert_state = 21;

Parameter
Name Description
value int

The enum numeric value on the wire for alertState to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setAnalyticsMetadata(int index, AnalyticsMetadata value)

public SecurityResult.Builder setAnalyticsMetadata(int index, AnalyticsMetadata value)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameters
Name Description
index int
value AnalyticsMetadata
Returns
Type Description
SecurityResult.Builder

setAnalyticsMetadata(int index, AnalyticsMetadata.Builder builderForValue)

public SecurityResult.Builder setAnalyticsMetadata(int index, AnalyticsMetadata.Builder builderForValue)

Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.AnalyticsMetadata analytics_metadata = 43;

Parameters
Name Description
index int
builderForValue AnalyticsMetadata.Builder
Returns
Type Description
SecurityResult.Builder

setAssociations(int index, SecurityResult.Association value)

public SecurityResult.Builder setAssociations(int index, SecurityResult.Association value)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameters
Name Description
index int
value SecurityResult.Association
Returns
Type Description
SecurityResult.Builder

setAssociations(int index, SecurityResult.Association.Builder builderForValue)

public SecurityResult.Builder setAssociations(int index, SecurityResult.Association.Builder builderForValue)

Associations related to the threat.

repeated .google.backstory.SecurityResult.Association associations = 34;

Parameters
Name Description
index int
builderForValue SecurityResult.Association.Builder
Returns
Type Description
SecurityResult.Builder

setAttackDetails(AttackDetails value)

public SecurityResult.Builder setAttackDetails(AttackDetails value)

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Parameter
Name Description
value AttackDetails
Returns
Type Description
SecurityResult.Builder

setAttackDetails(AttackDetails.Builder builderForValue)

public SecurityResult.Builder setAttackDetails(AttackDetails.Builder builderForValue)

MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.AttackDetails attack_details = 32;

Parameter
Name Description
builderForValue AttackDetails.Builder
Returns
Type Description
SecurityResult.Builder

setCampaigns(int index, String value) (deprecated)

public SecurityResult.Builder setCampaigns(int index, String value)

Deprecated. google.backstory.SecurityResult.campaigns is deprecated. See backstory/udm.proto;l=2718

Campaigns using this IOC threat. This is deprecated. Use threat_collections instead.

repeated string campaigns = 35 [deprecated = true];

Parameters
Name Description
index int

The index to set the value at.

value String

The campaigns to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setCategory(int index, SecurityResult.SecurityCategory value)

public SecurityResult.Builder setCategory(int index, SecurityResult.SecurityCategory value)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameters
Name Description
index int

The index to set the value at.

value SecurityResult.SecurityCategory

The category to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setCategoryDetails(int index, String value)

public SecurityResult.Builder setCategoryDetails(int index, String value)

For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a detection.

repeated string category_details = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The categoryDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setCategoryValue(int index, int value)

public SecurityResult.Builder setCategoryValue(int index, int value)

The security category. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.SecurityCategory category = 2;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for category to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setConfidence(SecurityResult.ProductConfidence value)

public SecurityResult.Builder setConfidence(SecurityResult.ProductConfidence value)

The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductConfidence confidence = 10;

Parameter
Name Description
value SecurityResult.ProductConfidence

The confidence to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setConfidenceDetails(String value)

public SecurityResult.Builder setConfidenceDetails(String value)

Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a detection.

string confidence_details = 13;

Parameter
Name Description
value String

The confidenceDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setConfidenceDetailsBytes(ByteString value)

public SecurityResult.Builder setConfidenceDetailsBytes(ByteString value)

Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a detection.

string confidence_details = 13;

Parameter
Name Description
value ByteString

The bytes for confidenceDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setConfidenceScore(float value)

public SecurityResult.Builder setConfidenceScore(float value)

The confidence score of the security result. This field is not populated when the SecurityResult appears in a detection.

float confidence_score = 42;

Parameter
Name Description
value float

The confidenceScore to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setConfidenceValue(int value)

public SecurityResult.Builder setConfidenceValue(int value)

The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductConfidence confidence = 10;

Parameter
Name Description
value int

The enum numeric value on the wire for confidence to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setDescription(String value)

public SecurityResult.Builder setDescription(String value)

A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary.

string description = 7;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public SecurityResult.Builder setDescriptionBytes(ByteString value)

A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary.

string description = 7;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setDetectionDepth(long value)

public SecurityResult.Builder setDetectionDepth(long value)

The depth of the detection chain. Applies only to composite detections.

int64 detection_depth = 47;

Parameter
Name Description
value long

The detectionDepth to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setDetectionFields(int index, Label value)

public SecurityResult.Builder setDetectionFields(int index, Label value)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

setDetectionFields(int index, Label.Builder builderForValue)

public SecurityResult.Builder setDetectionFields(int index, Label.Builder builderForValue)

An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables).

For Collection SecurityResults, prefer variables instead.

repeated .google.backstory.Label detection_fields = 23;

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

setDisplayName(String value)

public SecurityResult.Builder setDisplayName(String value)

The display name of the security result. This is populated from 'name_override' Outcome Variable, if present. Otherwise, this field is not set.

string display_name = 49;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public SecurityResult.Builder setDisplayNameBytes(ByteString value)

The display name of the security result. This is populated from 'name_override' Outcome Variable, if present. Otherwise, this field is not set.

string display_name = 49;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setFirstDiscoveredTime(Timestamp value)

public SecurityResult.Builder setFirstDiscoveredTime(Timestamp value)

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

setFirstDiscoveredTime(Timestamp.Builder builderForValue)

public SecurityResult.Builder setFirstDiscoveredTime(Timestamp.Builder builderForValue)

First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp first_discovered_time = 33;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityResult.Builder

setLastDiscoveredTime(Timestamp value)

public SecurityResult.Builder setLastDiscoveredTime(Timestamp value)

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

setLastDiscoveredTime(Timestamp.Builder builderForValue)

public SecurityResult.Builder setLastDiscoveredTime(Timestamp.Builder builderForValue)

Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_discovered_time = 40;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityResult.Builder

setLastUpdatedTime(Timestamp value)

public SecurityResult.Builder setLastUpdatedTime(Timestamp value)

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Parameter
Name Description
value Timestamp
Returns
Type Description
SecurityResult.Builder

setLastUpdatedTime(Timestamp.Builder builderForValue)

public SecurityResult.Builder setLastUpdatedTime(Timestamp.Builder builderForValue)

Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a detection.

.google.protobuf.Timestamp last_updated_time = 37;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SecurityResult.Builder

setOutcomes(int index, Label value) (deprecated)

public SecurityResult.Builder setOutcomes(int index, Label value)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

setOutcomes(int index, Label.Builder builderForValue) (deprecated)

public SecurityResult.Builder setOutcomes(int index, Label.Builder builderForValue)

A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values.

This is only populated when the SecurityResult appears in a detection. This is deprecated. Use variables instead.

repeated .google.backstory.Label outcomes = 28 [deprecated = true];

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

setPriority(SecurityResult.ProductPriority value)

public SecurityResult.Builder setPriority(SecurityResult.ProductPriority value)

The priority of the result. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductPriority priority = 11;

Parameter
Name Description
value SecurityResult.ProductPriority

The priority to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setPriorityDetails(String value)

public SecurityResult.Builder setPriorityDetails(String value)

Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a detection.

string priority_details = 14;

Parameter
Name Description
value String

The priorityDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setPriorityDetailsBytes(ByteString value)

public SecurityResult.Builder setPriorityDetailsBytes(ByteString value)

Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a detection.

string priority_details = 14;

Parameter
Name Description
value ByteString

The bytes for priorityDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setPriorityValue(int value)

public SecurityResult.Builder setPriorityValue(int value)

The priority of the result. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ProductPriority priority = 11;

Parameter
Name Description
value int

The enum numeric value on the wire for priority to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setReports(int index, String value) (deprecated)

public SecurityResult.Builder setReports(int index, String value)

Deprecated. google.backstory.SecurityResult.reports is deprecated. See backstory/udm.proto;l=2722

Reports that reference this IOC threat. These are the report IDs. This is deprecated. Use threat_collections instead.

repeated string reports = 46 [deprecated = true];

Parameters
Name Description
index int

The index to set the value at.

value String

The reports to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRiskScore(float value)

public SecurityResult.Builder setRiskScore(float value)

The risk score of the security result.

float risk_score = 31;

Parameter
Name Description
value float

The riskScore to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleAuthor(String value)

public SecurityResult.Builder setRuleAuthor(String value)

Author of the security rule. This field is not populated when the SecurityResult appears in a detection.

string rule_author = 25;

Parameter
Name Description
value String

The ruleAuthor to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleAuthorBytes(ByteString value)

public SecurityResult.Builder setRuleAuthorBytes(ByteString value)

Author of the security rule. This field is not populated when the SecurityResult appears in a detection.

string rule_author = 25;

Parameter
Name Description
value ByteString

The bytes for ruleAuthor to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleId(String value)

public SecurityResult.Builder setRuleId(String value)

A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe").

string rule_id = 16;

Parameter
Name Description
value String

The ruleId to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleIdBytes(ByteString value)

public SecurityResult.Builder setRuleIdBytes(ByteString value)

A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe").

string rule_id = 16;

Parameter
Name Description
value ByteString

The bytes for ruleId to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleLabels(int index, Label value)

public SecurityResult.Builder setRuleLabels(int index, Label value)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameters
Name Description
index int
value Label
Returns
Type Description
SecurityResult.Builder

setRuleLabels(int index, Label.Builder builderForValue)

public SecurityResult.Builder setRuleLabels(int index, Label.Builder builderForValue)

A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts.

repeated .google.backstory.Label rule_labels = 26;

Parameters
Name Description
index int
builderForValue Label.Builder
Returns
Type Description
SecurityResult.Builder

setRuleName(String value)

public SecurityResult.Builder setRuleName(String value)

Name of the security rule (e.g. "BlockInboundToOracle").

string rule_name = 5;

Parameter
Name Description
value String

The ruleName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleNameBytes(ByteString value)

public SecurityResult.Builder setRuleNameBytes(ByteString value)

Name of the security rule (e.g. "BlockInboundToOracle").

string rule_name = 5;

Parameter
Name Description
value ByteString

The bytes for ruleName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleSet(String value)

public SecurityResult.Builder setRuleSet(String value)

The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts.

string rule_set = 29;

Parameter
Name Description
value String

The ruleSet to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleSetBytes(ByteString value)

public SecurityResult.Builder setRuleSetBytes(ByteString value)

The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts.

string rule_set = 29;

Parameter
Name Description
value ByteString

The bytes for ruleSet to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleSetDisplayName(String value)

public SecurityResult.Builder setRuleSetDisplayName(String value)

The curated detections rule set display name. This is primarily set in rule-generated detections and alerts.

string rule_set_display_name = 30;

Parameter
Name Description
value String

The ruleSetDisplayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleSetDisplayNameBytes(ByteString value)

public SecurityResult.Builder setRuleSetDisplayNameBytes(ByteString value)

The curated detections rule set display name. This is primarily set in rule-generated detections and alerts.

string rule_set_display_name = 30;

Parameter
Name Description
value ByteString

The bytes for ruleSetDisplayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleType(String value)

public SecurityResult.Builder setRuleType(String value)

The type of security rule.

string rule_type = 22;

Parameter
Name Description
value String

The ruleType to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleTypeBytes(ByteString value)

public SecurityResult.Builder setRuleTypeBytes(ByteString value)

The type of security rule.

string rule_type = 22;

Parameter
Name Description
value ByteString

The bytes for ruleType to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleVersion(String value)

public SecurityResult.Builder setRuleVersion(String value)

Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed.

string rule_version = 20;

Parameter
Name Description
value String

The ruleVersion to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRuleVersionBytes(ByteString value)

public SecurityResult.Builder setRuleVersionBytes(ByteString value)

Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed.

string rule_version = 20;

Parameter
Name Description
value ByteString

The bytes for ruleVersion to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRulesetCategoryDisplayName(String value)

public SecurityResult.Builder setRulesetCategoryDisplayName(String value)

The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts.

string ruleset_category_display_name = 41;

Parameter
Name Description
value String

The rulesetCategoryDisplayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setRulesetCategoryDisplayNameBytes(ByteString value)

public SecurityResult.Builder setRulesetCategoryDisplayNameBytes(ByteString value)

The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts.

string ruleset_category_display_name = 41;

Parameter
Name Description
value ByteString

The bytes for rulesetCategoryDisplayName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSeverity(SecurityResult.ProductSeverity value)

public SecurityResult.Builder setSeverity(SecurityResult.ProductSeverity value)

The severity of the result.

.google.backstory.SecurityResult.ProductSeverity severity = 9;

Parameter
Name Description
value SecurityResult.ProductSeverity

The severity to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSeverityDetails(String value)

public SecurityResult.Builder setSeverityDetails(String value)

Vendor-specific severity. This field is not populated when the SecurityResult appears in a detection.

string severity_details = 12;

Parameter
Name Description
value String

The severityDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSeverityDetailsBytes(ByteString value)

public SecurityResult.Builder setSeverityDetailsBytes(ByteString value)

Vendor-specific severity. This field is not populated when the SecurityResult appears in a detection.

string severity_details = 12;

Parameter
Name Description
value ByteString

The bytes for severityDetails to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSeverityValue(int value)

public SecurityResult.Builder setSeverityValue(int value)

The severity of the result.

.google.backstory.SecurityResult.ProductSeverity severity = 9;

Parameter
Name Description
value int

The enum numeric value on the wire for severity to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSummary(String value)

public SecurityResult.Builder setSummary(String value)

A short human-readable summary (e.g. "failed login occurred")

string summary = 6;

Parameter
Name Description
value String

The summary to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setSummaryBytes(ByteString value)

public SecurityResult.Builder setSummaryBytes(ByteString value)

A short human-readable summary (e.g. "failed login occurred")

string summary = 6;

Parameter
Name Description
value ByteString

The bytes for summary to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatCollections(int index, SecurityResult.ThreatCollectionItem value)

public SecurityResult.Builder setThreatCollections(int index, SecurityResult.ThreatCollectionItem value)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameters
Name Description
index int
value SecurityResult.ThreatCollectionItem
Returns
Type Description
SecurityResult.Builder

setThreatCollections(int index, SecurityResult.ThreatCollectionItem.Builder builderForValue)

public SecurityResult.Builder setThreatCollections(int index, SecurityResult.ThreatCollectionItem.Builder builderForValue)

GTI collections associated with the security result.

repeated .google.backstory.SecurityResult.ThreatCollectionItem threat_collections = 48;

Parameters
Name Description
index int
builderForValue SecurityResult.ThreatCollectionItem.Builder
Returns
Type Description
SecurityResult.Builder

setThreatFeedName(String value)

public SecurityResult.Builder setThreatFeedName(String value)

Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a detection.

string threat_feed_name = 27;

Parameter
Name Description
value String

The threatFeedName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatFeedNameBytes(ByteString value)

public SecurityResult.Builder setThreatFeedNameBytes(ByteString value)

Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a detection.

string threat_feed_name = 27;

Parameter
Name Description
value ByteString

The bytes for threatFeedName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatId(String value)

public SecurityResult.Builder setThreatId(String value)

Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a detection.

string threat_id = 17;

Parameter
Name Description
value String

The threatId to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatIdBytes(ByteString value)

public SecurityResult.Builder setThreatIdBytes(ByteString value)

Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a detection.

string threat_id = 17;

Parameter
Name Description
value ByteString

The bytes for threatId to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatIdNamespace(Id.Namespace value)

public SecurityResult.Builder setThreatIdNamespace(Id.Namespace value)

The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Id.Namespace threat_id_namespace = 24;

Parameter
Name Description
value Id.Namespace

The threatIdNamespace to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatIdNamespaceValue(int value)

public SecurityResult.Builder setThreatIdNamespaceValue(int value)

The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.Id.Namespace threat_id_namespace = 24;

Parameter
Name Description
value int

The enum numeric value on the wire for threatIdNamespace to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatName(String value)

public SecurityResult.Builder setThreatName(String value)

A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a detection.

string threat_name = 4;

Parameter
Name Description
value String

The threatName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatNameBytes(ByteString value)

public SecurityResult.Builder setThreatNameBytes(ByteString value)

A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a detection.

string threat_name = 4;

Parameter
Name Description
value ByteString

The bytes for threatName to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatStatus(SecurityResult.ThreatStatus value)

public SecurityResult.Builder setThreatStatus(SecurityResult.ThreatStatus value)

Current status of the threat This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ThreatStatus threat_status = 18;

Parameter
Name Description
value SecurityResult.ThreatStatus

The threatStatus to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatStatusValue(int value)

public SecurityResult.Builder setThreatStatusValue(int value)

Current status of the threat This field is not populated when the SecurityResult appears in a detection.

.google.backstory.SecurityResult.ThreatStatus threat_status = 18;

Parameter
Name Description
value int

The enum numeric value on the wire for threatStatus to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatVerdict(ThreatVerdict value)

public SecurityResult.Builder setThreatVerdict(ThreatVerdict value)

GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.ThreatVerdict threat_verdict = 39;

Parameter
Name Description
value ThreatVerdict

The threatVerdict to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setThreatVerdictValue(int value)

public SecurityResult.Builder setThreatVerdictValue(int value)

GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a detection.

.google.backstory.ThreatVerdict threat_verdict = 39;

Parameter
Name Description
value int

The enum numeric value on the wire for threatVerdict to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setUrlBackToProduct(String value)

public SecurityResult.Builder setUrlBackToProduct(String value)

URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a detection.

string url_back_to_product = 15;

Parameter
Name Description
value String

The urlBackToProduct to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setUrlBackToProductBytes(ByteString value)

public SecurityResult.Builder setUrlBackToProductBytes(ByteString value)

URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a detection.

string url_back_to_product = 15;

Parameter
Name Description
value ByteString

The bytes for urlBackToProduct to set.

Returns
Type Description
SecurityResult.Builder

This builder for chaining.

setVerdict(SecurityResult.Verdict value) (deprecated)

public SecurityResult.Builder setVerdict(SecurityResult.Verdict value)

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Parameter
Name Description
value SecurityResult.Verdict
Returns
Type Description
SecurityResult.Builder

setVerdict(SecurityResult.Verdict.Builder builderForValue) (deprecated)

public SecurityResult.Builder setVerdict(SecurityResult.Verdict.Builder builderForValue)

Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead.

.google.backstory.SecurityResult.Verdict verdict = 36 [deprecated = true];

Parameter
Name Description
builderForValue SecurityResult.Verdict.Builder
Returns
Type Description
SecurityResult.Builder

setVerdictInfo(int index, SecurityResult.VerdictInfo value)

public SecurityResult.Builder setVerdictInfo(int index, SecurityResult.VerdictInfo value)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameters
Name Description
index int
value SecurityResult.VerdictInfo
Returns
Type Description
SecurityResult.Builder

setVerdictInfo(int index, SecurityResult.VerdictInfo.Builder builderForValue)

public SecurityResult.Builder setVerdictInfo(int index, SecurityResult.VerdictInfo.Builder builderForValue)

Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a detection.

repeated .google.backstory.SecurityResult.VerdictInfo verdict_info = 38;

Parameters
Name Description
index int
builderForValue SecurityResult.VerdictInfo.Builder
Returns
Type Description
SecurityResult.Builder