Class Investigation (0.3.0)

public final class Investigation extends GeneratedMessage 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 Fields

COMMENTS_FIELD_NUMBER

public static final int COMMENTS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

REASON_FIELD_NUMBER

public static final int REASON_FIELD_NUMBER
Field Value
Type Description
int

REPUTATION_FIELD_NUMBER

public static final int REPUTATION_FIELD_NUMBER
Field Value
Type Description
int

RISK_SCORE_FIELD_NUMBER

public static final int RISK_SCORE_FIELD_NUMBER
Field Value
Type Description
int

ROOT_CAUSE_FIELD_NUMBER

public static final int ROOT_CAUSE_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_SCORE_FIELD_NUMBER

public static final int SEVERITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

VERDICT_FIELD_NUMBER

public static final int VERDICT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Investigation getDefaultInstance()
Returns
Type Description
Investigation

getDescriptor()

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

newBuilder()

public static Investigation.Builder newBuilder()
Returns
Type Description
Investigation.Builder

newBuilder(Investigation prototype)

public static Investigation.Builder newBuilder(Investigation prototype)
Parameter
Name Description
prototype Investigation
Returns
Type Description
Investigation.Builder

parseDelimitedFrom(InputStream input)

public static Investigation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Investigation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Investigation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Investigation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Investigation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Investigation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Investigation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Investigation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Investigation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Investigation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Investigation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Investigation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Investigation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Investigation> parser()
Returns
Type Description
Parser<Investigation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<Investigation> getParserForType()
Returns
Type Description
Parser<Investigation>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Investigation.Builder newBuilderForType()
Returns
Type Description
Investigation.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Investigation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Investigation.Builder
Overrides

toBuilder()

public Investigation.Builder toBuilder()
Returns
Type Description
Investigation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException