Class Reference.Builder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public static final class Reference.Builder extends GeneratedMessage.Builder<Reference.Builder> 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

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Reference.Builder

Implements

ReferenceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllJoinedDataTableRows(Iterable<? extends DataTableRowInfo> values)

public Reference.Builder addAllJoinedDataTableRows(Iterable<? extends DataTableRowInfo> values)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

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

Returns
Type	Description
Reference.Builder

addJoinedDataTableRows(DataTableRowInfo value)

public Reference.Builder addJoinedDataTableRows(DataTableRowInfo value)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name	Description
value	DataTableRowInfo

Returns
Type	Description
Reference.Builder

addJoinedDataTableRows(DataTableRowInfo.Builder builderForValue)

public Reference.Builder addJoinedDataTableRows(DataTableRowInfo.Builder builderForValue)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameter
Name	Description
builderForValue	DataTableRowInfo.Builder

Returns
Type	Description
Reference.Builder

addJoinedDataTableRows(int index, DataTableRowInfo value)

public Reference.Builder addJoinedDataTableRows(int index, DataTableRowInfo value)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameters
Name	Description
index	int
value	DataTableRowInfo

Returns
Type	Description
Reference.Builder

addJoinedDataTableRows(int index, DataTableRowInfo.Builder builderForValue)

public Reference.Builder addJoinedDataTableRows(int index, DataTableRowInfo.Builder builderForValue)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameters
Name	Description
index	int
builderForValue	DataTableRowInfo.Builder

Returns
Type	Description
Reference.Builder

addJoinedDataTableRowsBuilder()

public DataTableRowInfo.Builder addJoinedDataTableRowsBuilder()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type	Description
DataTableRowInfo.Builder

addJoinedDataTableRowsBuilder(int index)

public DataTableRowInfo.Builder addJoinedDataTableRowsBuilder(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.Builder

build()

public Reference build()

Returns
Type	Description
Reference

buildPartial()

public Reference buildPartial()

Returns
Type	Description
Reference

clear()

public Reference.Builder clear()

Returns
Type	Description
Reference.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearEntity()

public Reference.Builder clearEntity()

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
Reference.Builder

clearEvent()

public Reference.Builder clearEvent()

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
Reference.Builder

clearGraphEnrichment()

public Reference.Builder clearGraphEnrichment()

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
Reference.Builder

clearId()

public Reference.Builder clearId()

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
Reference.Builder

clearJoinedDataTableRows()

public Reference.Builder clearJoinedDataTableRows()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type	Description
Reference.Builder

clearLogBatchToken()

public Reference.Builder clearLogBatchToken()

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
Reference.Builder	This builder for chaining.

getDefaultInstanceForType()

public Reference getDefaultInstanceForType()

Returns
Type	Description
Reference

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

getEntityBuilder()

public Entity.Builder getEntityBuilder()

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.Builder

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.

getEventBuilder()

public UDM.Builder getEventBuilder()

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.Builder

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.

getGraphEnrichmentBuilder()

public EntityGraphEnrichment.Builder getGraphEnrichmentBuilder()

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.Builder

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.

getIdBuilder()

public Id.Builder getIdBuilder()

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.Builder

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

getJoinedDataTableRowsBuilder(int index)

public DataTableRowInfo.Builder getJoinedDataTableRowsBuilder(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.Builder

getJoinedDataTableRowsBuilderList()

public List<DataTableRowInfo.Builder> getJoinedDataTableRowsBuilderList()

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Returns
Type	Description
List<Builder>

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeEntity(Entity value)

public Reference.Builder mergeEntity(Entity value)

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;

Parameter
Name	Description
value	Entity

Returns
Type	Description
Reference.Builder

mergeEvent(UDM value)

public Reference.Builder mergeEvent(UDM value)

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

.google.backstory.UDM event = 1;

Parameter
Name	Description
value	UDM

Returns
Type	Description
Reference.Builder

mergeFrom(Reference other)

public Reference.Builder mergeFrom(Reference other)

Parameter
Name	Description
other	Reference

Returns
Type	Description
Reference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Reference.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Reference.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Reference.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Reference.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGraphEnrichment(EntityGraphEnrichment value)

public Reference.Builder mergeGraphEnrichment(EntityGraphEnrichment value)

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;

Parameter
Name	Description
value	EntityGraphEnrichment

Returns
Type	Description
Reference.Builder

mergeId(Id value)

public Reference.Builder mergeId(Id value)

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;

Parameter
Name	Description
value	Id

Returns
Type	Description
Reference.Builder

removeJoinedDataTableRows(int index)

public Reference.Builder removeJoinedDataTableRows(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
Reference.Builder

setEntity(Entity value)

public Reference.Builder setEntity(Entity value)

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;

Parameter
Name	Description
value	Entity

Returns
Type	Description
Reference.Builder

setEntity(Entity.Builder builderForValue)

public Reference.Builder setEntity(Entity.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Entity.Builder

Returns
Type	Description
Reference.Builder

setEvent(UDM value)

public Reference.Builder setEvent(UDM value)

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

.google.backstory.UDM event = 1;

Parameter
Name	Description
value	UDM

Returns
Type	Description
Reference.Builder

setEvent(UDM.Builder builderForValue)

public Reference.Builder setEvent(UDM.Builder builderForValue)

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

.google.backstory.UDM event = 1;

Parameter
Name	Description
builderForValue	UDM.Builder

Returns
Type	Description
Reference.Builder

setGraphEnrichment(EntityGraphEnrichment value)

public Reference.Builder setGraphEnrichment(EntityGraphEnrichment value)

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;

Parameter
Name	Description
value	EntityGraphEnrichment

Returns
Type	Description
Reference.Builder

setGraphEnrichment(EntityGraphEnrichment.Builder builderForValue)

public Reference.Builder setGraphEnrichment(EntityGraphEnrichment.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	EntityGraphEnrichment.Builder

Returns
Type	Description
Reference.Builder

setId(Id value)

public Reference.Builder setId(Id value)

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;

Parameter
Name	Description
value	Id

Returns
Type	Description
Reference.Builder

setId(Id.Builder builderForValue)

public Reference.Builder setId(Id.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Id.Builder

Returns
Type	Description
Reference.Builder

setJoinedDataTableRows(int index, DataTableRowInfo value)

public Reference.Builder setJoinedDataTableRows(int index, DataTableRowInfo value)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameters
Name	Description
index	int
value	DataTableRowInfo

Returns
Type	Description
Reference.Builder

setJoinedDataTableRows(int index, DataTableRowInfo.Builder builderForValue)

public Reference.Builder setJoinedDataTableRows(int index, DataTableRowInfo.Builder builderForValue)

The data table rows joined with the event.

repeated .google.backstory.DataTableRowInfo joined_data_table_rows = 4;

Parameters
Name	Description
index	int
builderForValue	DataTableRowInfo.Builder

Returns
Type	Description
Reference.Builder

setLogBatchToken(String value)

public Reference.Builder setLogBatchToken(String value)

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;

Parameter
Name	Description
value	String The logBatchToken to set.

Returns
Type	Description
Reference.Builder	This builder for chaining.

setLogBatchTokenBytes(ByteString value)

public Reference.Builder setLogBatchTokenBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for logBatchToken to set.

Returns
Type	Description
Reference.Builder	This builder for chaining.