Class Reference (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public final class Reference extends GeneratedMessage implements ReferenceOrBuilder

Reference to model primatives including event and entity. As support is added for fast retrieval of objects by identifiers, this will be expanded to include ID references rather than full object copies.

Protobuf type google.backstory.Reference

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Reference

Implements

ReferenceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER

Field Value
Type	Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER

Field Value
Type	Description
int

GRAPH_ENRICHMENT_FIELD_NUMBER

public static final int GRAPH_ENRICHMENT_FIELD_NUMBER

Field Value
Type	Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
int

JOINED_DATA_TABLE_ROWS_FIELD_NUMBER

public static final int JOINED_DATA_TABLE_ROWS_FIELD_NUMBER

Field Value
Type	Description
int

LOG_BATCH_TOKEN_FIELD_NUMBER

public static final int LOG_BATCH_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Reference getDefaultInstance()

Returns
Type	Description
Reference

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Reference.Builder newBuilder()

Returns
Type	Description
Reference.Builder

newBuilder(Reference prototype)

public static Reference.Builder newBuilder(Reference prototype)

Parameter
Name	Description
prototype	Reference

Returns
Type	Description
Reference.Builder

parseDelimitedFrom(InputStream input)

public static Reference parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Reference parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Reference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Reference parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Reference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Reference parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Reference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Reference parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Reference parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Reference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Reference> parser()

Returns
Type	Description
Parser<Reference>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Reference getDefaultInstanceForType()

Returns
Type	Description
Reference

getEntity()

public Entity getEntity()

Entity being referenced. In cases where the entity graph is overridden by data table, this will represent the original entity. End one-of

.google.backstory.Entity entity = 2;

Returns
Type	Description
Entity	The entity.

getEntityOrBuilder()

public EntityOrBuilder getEntityOrBuilder()

Entity being referenced. In cases where the entity graph is overridden by data table, this will represent the original entity. End one-of

.google.backstory.Entity entity = 2;

Returns
Type	Description
EntityOrBuilder

getEvent()

public UDM getEvent()

Only one of event or entity will be populated for a single reference. Start one-of Event being referenced.

.google.backstory.UDM event = 1;

Returns
Type	Description
UDM	The event.

getEventOrBuilder()

public UDMOrBuilder getEventOrBuilder()

Only one of event or entity will be populated for a single reference. Start one-of Event being referenced.

.google.backstory.UDM event = 1;

Returns
Type	Description
UDMOrBuilder

getGraphEnrichment()

public EntityGraphEnrichment getGraphEnrichment()

The entity graph enrichment details. Only set when the reference is an Entity which has been overridden by a data table or appended from a data table.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type	Description
EntityGraphEnrichment	The graphEnrichment.

getGraphEnrichmentOrBuilder()

public EntityGraphEnrichmentOrBuilder getGraphEnrichmentOrBuilder()

The entity graph enrichment details. Only set when the reference is an Entity which has been overridden by a data table or appended from a data table.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type	Description
EntityGraphEnrichmentOrBuilder

getId()

public Id getId()

Id being referenced. This field will also be populated for both event and entity with the event id. For detections, only this field will be populated.

.google.backstory.Id id = 3;

Returns
Type	Description
Id	The id.

getIdOrBuilder()

public IdOrBuilder getIdOrBuilder()

Id being referenced. This field will also be populated for both event and entity with the event id. For detections, only this field will be populated.

.google.backstory.Id id = 3;

Returns
Type	Description
IdOrBuilder

getJoinedDataTableRows(int index)

public DataTableRowInfo getJoinedDataTableRows(int index)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
DataTableRowInfo

getJoinedDataTableRowsCount()

public int getJoinedDataTableRowsCount()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type	Description
int

getJoinedDataTableRowsList()

public List<DataTableRowInfo> getJoinedDataTableRowsList()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type	Description
List<DataTableRowInfo>

getJoinedDataTableRowsOrBuilder(int index)

public DataTableRowInfoOrBuilder getJoinedDataTableRowsOrBuilder(int index)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
DataTableRowInfoOrBuilder

getJoinedDataTableRowsOrBuilderList()

public List<? extends DataTableRowInfoOrBuilder> getJoinedDataTableRowsOrBuilderList()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

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

getLogBatchToken()

public String getLogBatchToken()

The log batch token of the event being referenced. This field is used to fetch the raw log associated with the event in some legacy systems. This field is only populated for events/entities.

string log_batch_token = 6;

Returns
Type	Description
String	The logBatchToken.

getLogBatchTokenBytes()

public ByteString getLogBatchTokenBytes()

The log batch token of the event being referenced. This field is used to fetch the raw log associated with the event in some legacy systems. This field is only populated for events/entities.

string log_batch_token = 6;

Returns
Type	Description
ByteString	The bytes for logBatchToken.

getParserForType()

public Parser<Reference> getParserForType()

Returns
Type	Description
Parser<Reference>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasEntity()

public boolean hasEntity()

Entity being referenced. In cases where the entity graph is overridden by data table, this will represent the original entity. End one-of

.google.backstory.Entity entity = 2;

Returns
Type	Description
boolean	Whether the entity field is set.

hasEvent()

public boolean hasEvent()

Only one of event or entity will be populated for a single reference. Start one-of Event being referenced.

.google.backstory.UDM event = 1;

Returns
Type	Description
boolean	Whether the event field is set.

hasGraphEnrichment()

public boolean hasGraphEnrichment()

The entity graph enrichment details. Only set when the reference is an Entity which has been overridden by a data table or appended from a data table.

.google.backstory.EntityGraphEnrichment graph_enrichment = 5;

Returns
Type	Description
boolean	Whether the graphEnrichment field is set.

hasId()

public boolean hasId()

Id being referenced. This field will also be populated for both event and entity with the event id. For detections, only this field will be populated.

.google.backstory.Id id = 3;

Returns
Type	Description
boolean	Whether the id field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Reference.Builder newBuilderForType()

Returns
Type	Description
Reference.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Reference.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Reference.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Reference.Builder toBuilder()

Returns
Type	Description
Reference.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException