Class Investigation.Builder (0.3.0)

public static final class Investigation.Builder extends GeneratedMessage.Builder<Investigation.Builder> implements InvestigationOrBuilder

Represents the aggregated state of an investigation such as categorization, severity, and status. Can be expanded to include analyst assignment details and more.

Protobuf type google.backstory.Investigation

Static Methods

getDescriptor()

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

Methods

addAllComments(Iterable<String> values)

public Investigation.Builder addAllComments(Iterable<String> values)

Comment added by the Analyst.

repeated string comments = 6;

Parameter
Name Description
values Iterable<String>

The comments to add.

Returns
Type Description
Investigation.Builder

This builder for chaining.

addComments(String value)

public Investigation.Builder addComments(String value)

Comment added by the Analyst.

repeated string comments = 6;

Parameter
Name Description
value String

The comments to add.

Returns
Type Description
Investigation.Builder

This builder for chaining.

addCommentsBytes(ByteString value)

public Investigation.Builder addCommentsBytes(ByteString value)

Comment added by the Analyst.

repeated string comments = 6;

Parameter
Name Description
value ByteString

The bytes of the comments to add.

Returns
Type Description
Investigation.Builder

This builder for chaining.

build()

public Investigation build()
Returns
Type Description
Investigation

buildPartial()

public Investigation buildPartial()
Returns
Type Description
Investigation

clear()

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

clearComments()

public Investigation.Builder clearComments()

Comment added by the Analyst.

repeated string comments = 6;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearId()

public Investigation.Builder clearId()

Identifier for the investigation

optional string id = 11;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearPriority()

public Investigation.Builder clearPriority()

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearReason()

public Investigation.Builder clearReason()

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearReputation()

public Investigation.Builder clearReputation()

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearRiskScore()

public Investigation.Builder clearRiskScore()

Risk score for a finding set by an analyst.

optional uint32 risk_score = 10;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearRootCause()

public Investigation.Builder clearRootCause()

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearSeverityScore()

public Investigation.Builder clearSeverityScore()

Severity score for a finding set by an analyst.

optional uint32 severity_score = 4;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearStatus()

public Investigation.Builder clearStatus()

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Returns
Type Description
Investigation.Builder

This builder for chaining.

clearVerdict()

public Investigation.Builder clearVerdict()

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Returns
Type Description
Investigation.Builder

This builder for chaining.

getComments(int index)

public String getComments(int index)

Comment added by the Analyst.

repeated string comments = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The comments at the given index.

getCommentsBytes(int index)

public ByteString getCommentsBytes(int index)

Comment added by the Analyst.

repeated string comments = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the comments at the given index.

getCommentsCount()

public int getCommentsCount()

Comment added by the Analyst.

repeated string comments = 6;

Returns
Type Description
int

The count of comments.

getCommentsList()

public ProtocolStringList getCommentsList()

Comment added by the Analyst.

repeated string comments = 6;

Returns
Type Description
ProtocolStringList

A list containing the comments.

getDefaultInstanceForType()

public Investigation getDefaultInstanceForType()
Returns
Type Description
Investigation

getDescriptorForType()

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

getId()

public String getId()

Identifier for the investigation

optional string id = 11;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Identifier for the investigation

optional string id = 11;

Returns
Type Description
ByteString

The bytes for id.

getPriority()

public Priority getPriority()

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Returns
Type Description
Priority

The priority.

getPriorityValue()

public int getPriorityValue()

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Returns
Type Description
int

The enum numeric value on the wire for priority.

getReason()

public Reason getReason()

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Returns
Type Description
Reason

The reason.

getReasonValue()

public int getReasonValue()

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Returns
Type Description
int

The enum numeric value on the wire for reason.

getReputation()

public Reputation getReputation()

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Returns
Type Description
Reputation

The reputation.

getReputationValue()

public int getReputationValue()

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Returns
Type Description
int

The enum numeric value on the wire for reputation.

getRiskScore()

public int getRiskScore()

Risk score for a finding set by an analyst.

optional uint32 risk_score = 10;

Returns
Type Description
int

The riskScore.

getRootCause()

public String getRootCause()

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Returns
Type Description
String

The rootCause.

getRootCauseBytes()

public ByteString getRootCauseBytes()

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Returns
Type Description
ByteString

The bytes for rootCause.

getSeverityScore()

public int getSeverityScore()

Severity score for a finding set by an analyst.

optional uint32 severity_score = 4;

Returns
Type Description
int

The severityScore.

getStatus()

public Status getStatus()

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Returns
Type Description
Status

The status.

getStatusValue()

public int getStatusValue()

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Returns
Type Description
int

The enum numeric value on the wire for status.

getVerdict()

public Verdict getVerdict()

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Returns
Type Description
Verdict

The verdict.

getVerdictValue()

public int getVerdictValue()

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Returns
Type Description
int

The enum numeric value on the wire for verdict.

hasId()

public boolean hasId()

Identifier for the investigation

optional string id = 11;

Returns
Type Description
boolean

Whether the id field is set.

hasPriority()

public boolean hasPriority()

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Returns
Type Description
boolean

Whether the priority field is set.

hasReason()

public boolean hasReason()

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Returns
Type Description
boolean

Whether the reason field is set.

hasReputation()

public boolean hasReputation()

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Returns
Type Description
boolean

Whether the reputation field is set.

hasRiskScore()

public boolean hasRiskScore()

Risk score for a finding set by an analyst.

optional uint32 risk_score = 10;

Returns
Type Description
boolean

Whether the riskScore field is set.

hasRootCause()

public boolean hasRootCause()

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Returns
Type Description
boolean

Whether the rootCause field is set.

hasSeverityScore()

public boolean hasSeverityScore()

Severity score for a finding set by an analyst.

optional uint32 severity_score = 4;

Returns
Type Description
boolean

Whether the severityScore field is set.

hasStatus()

public boolean hasStatus()

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Returns
Type Description
boolean

Whether the status field is set.

hasVerdict()

public boolean hasVerdict()

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Returns
Type Description
boolean

Whether the verdict field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Investigation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setComments(int index, String value)

public Investigation.Builder setComments(int index, String value)

Comment added by the Analyst.

repeated string comments = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The comments to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setId(String value)

public Investigation.Builder setId(String value)

Identifier for the investigation

optional string id = 11;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Investigation.Builder setIdBytes(ByteString value)

Identifier for the investigation

optional string id = 11;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setPriority(Priority value)

public Investigation.Builder setPriority(Priority value)

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Parameter
Name Description
value Priority

The priority to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setPriorityValue(int value)

public Investigation.Builder setPriorityValue(int value)

Priority of the Alert or Finding set by analyst.

optional .google.backstory.Priority priority = 7;

Parameter
Name Description
value int

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

Returns
Type Description
Investigation.Builder

This builder for chaining.

setReason(Reason value)

public Investigation.Builder setReason(Reason value)

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Parameter
Name Description
value Reason

The reason to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setReasonValue(int value)

public Investigation.Builder setReasonValue(int value)

Reason for closing the Case or Alert.

optional .google.backstory.Reason reason = 9;

Parameter
Name Description
value int

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

Returns
Type Description
Investigation.Builder

This builder for chaining.

setReputation(Reputation value)

public Investigation.Builder setReputation(Reputation value)

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Parameter
Name Description
value Reputation

The reputation to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setReputationValue(int value)

public Investigation.Builder setReputationValue(int value)

Describes whether a finding was useful or not-useful.

optional .google.backstory.Reputation reputation = 3;

Parameter
Name Description
value int

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

Returns
Type Description
Investigation.Builder

This builder for chaining.

setRiskScore(int value)

public Investigation.Builder setRiskScore(int value)

Risk score for a finding set by an analyst.

optional uint32 risk_score = 10;

Parameter
Name Description
value int

The riskScore to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setRootCause(String value)

public Investigation.Builder setRootCause(String value)

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Parameter
Name Description
value String

The rootCause to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setRootCauseBytes(ByteString value)

public Investigation.Builder setRootCauseBytes(ByteString value)

Root cause of the Alert or Finding set by analyst.

optional string root_cause = 8;

Parameter
Name Description
value ByteString

The bytes for rootCause to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setSeverityScore(int value)

public Investigation.Builder setSeverityScore(int value)

Severity score for a finding set by an analyst.

optional uint32 severity_score = 4;

Parameter
Name Description
value int

The severityScore to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setStatus(Status value)

public Investigation.Builder setStatus(Status value)

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Parameter
Name Description
value Status

The status to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setStatusValue(int value)

public Investigation.Builder setStatusValue(int value)

Describes the workflow status of a finding.

optional .google.backstory.Status status = 5;

Parameter
Name Description
value int

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

Returns
Type Description
Investigation.Builder

This builder for chaining.

setVerdict(Verdict value)

public Investigation.Builder setVerdict(Verdict value)

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Parameter
Name Description
value Verdict

The verdict to set.

Returns
Type Description
Investigation.Builder

This builder for chaining.

setVerdictValue(int value)

public Investigation.Builder setVerdictValue(int value)

Describes reason a finding investigation was resolved.

optional .google.backstory.Verdict verdict = 2;

Parameter
Name Description
value int

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

Returns
Type Description
Investigation.Builder

This builder for chaining.