Class Element.Builder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public static final class Element.Builder extends GeneratedMessage.Builder<Element.Builder> implements ElementOrBuilder

Protobuf type google.backstory.Element

Inheritance

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

Implements

ElementOrBuilder

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

addAllReferences(Iterable<? extends Reference> values)

public Element.Builder addAllReferences(Iterable<? extends Reference> values)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

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

Returns
Type	Description
Element.Builder

addReferences(Reference value)

public Element.Builder addReferences(Reference value)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
value	Reference

Returns
Type	Description
Element.Builder

addReferences(Reference.Builder builderForValue)

public Element.Builder addReferences(Reference.Builder builderForValue)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
builderForValue	Reference.Builder

Returns
Type	Description
Element.Builder

addReferences(int index, Reference value)

public Element.Builder addReferences(int index, Reference value)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameters
Name	Description
index	int
value	Reference

Returns
Type	Description
Element.Builder

addReferences(int index, Reference.Builder builderForValue)

public Element.Builder addReferences(int index, Reference.Builder builderForValue)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameters
Name	Description
index	int
builderForValue	Reference.Builder

Returns
Type	Description
Element.Builder

addReferencesBuilder()

public Reference.Builder addReferencesBuilder()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type	Description
Reference.Builder

addReferencesBuilder(int index)

public Reference.Builder addReferencesBuilder(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Reference.Builder

build()

public Element build()

Returns
Type	Description
Element

buildPartial()

public Element buildPartial()

Returns
Type	Description
Element

clear()

public Element.Builder clear()

Returns
Type	Description
Element.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAssociation()

public Element.Builder clearAssociation()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type	Description
Element.Builder

clearLabel()

public Element.Builder clearLabel()

A name that labels the entire references group.

string label = 3;

Returns
Type	Description
Element.Builder	This builder for chaining.

clearLatencyMetrics()

public Element.Builder clearLatencyMetrics()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type	Description
Element.Builder

clearReferences()

public Element.Builder clearReferences()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type	Description
Element.Builder

clearReferencesSampled()

public Element.Builder clearReferencesSampled()

Copied from the detection event_sample.too_many_event_samples field. If true, the number of references will be capped at the sample limit (set at rule service). This is applicable to both UDM references and Entity references.

bool references_sampled = 4;

Returns
Type	Description
Element.Builder	This builder for chaining.

getAssociation()

public SecurityResult getAssociation()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type	Description
SecurityResult	The association.

getAssociationBuilder()

public SecurityResult.Builder getAssociationBuilder()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type	Description
SecurityResult.Builder

getAssociationOrBuilder()

public SecurityResultOrBuilder getAssociationOrBuilder()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type	Description
SecurityResultOrBuilder

getDefaultInstanceForType()

public Element getDefaultInstanceForType()

Returns
Type	Description
Element

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getLabel()

public String getLabel()

A name that labels the entire references group.

string label = 3;

Returns
Type	Description
String	The label.

getLabelBytes()

public ByteString getLabelBytes()

A name that labels the entire references group.

string label = 3;

Returns
Type	Description
ByteString	The bytes for label.

getLatencyMetrics()

public LatencyMetrics getLatencyMetrics()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type	Description
LatencyMetrics	The latencyMetrics.

getLatencyMetricsBuilder()

public LatencyMetrics.Builder getLatencyMetricsBuilder()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type	Description
LatencyMetrics.Builder

getLatencyMetricsOrBuilder()

public LatencyMetricsOrBuilder getLatencyMetricsOrBuilder()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type	Description
LatencyMetricsOrBuilder

getReferences(int index)

public Reference getReferences(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Reference

getReferencesBuilder(int index)

public Reference.Builder getReferencesBuilder(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Reference.Builder

getReferencesBuilderList()

public List<Reference.Builder> getReferencesBuilderList()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type	Description
List<Builder>

getReferencesCount()

public int getReferencesCount()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type	Description
int

getReferencesList()

public List<Reference> getReferencesList()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Returns
Type	Description
List<Reference>

getReferencesOrBuilder(int index)

public ReferenceOrBuilder getReferencesOrBuilder(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
ReferenceOrBuilder

getReferencesOrBuilderList()

public List<? extends ReferenceOrBuilder> getReferencesOrBuilderList()

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

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

getReferencesSampled()

public boolean getReferencesSampled()

Copied from the detection event_sample.too_many_event_samples field. If true, the number of references will be capped at the sample limit (set at rule service). This is applicable to both UDM references and Entity references.

bool references_sampled = 4;

Returns
Type	Description
boolean	The referencesSampled.

hasAssociation()

public boolean hasAssociation()

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Returns
Type	Description
boolean	Whether the association field is set.

hasLatencyMetrics()

public boolean hasLatencyMetrics()

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Returns
Type	Description
boolean	Whether the latencyMetrics 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()

mergeAssociation(SecurityResult value)

public Element.Builder mergeAssociation(SecurityResult value)

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Parameter
Name	Description
value	SecurityResult

Returns
Type	Description
Element.Builder

mergeFrom(Element other)

public Element.Builder mergeFrom(Element other)

Parameter
Name	Description
other	Element

Returns
Type	Description
Element.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Element.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Element.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Element.Builder

Overrides

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

mergeLatencyMetrics(LatencyMetrics value)

public Element.Builder mergeLatencyMetrics(LatencyMetrics value)

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Parameter
Name	Description
value	LatencyMetrics

Returns
Type	Description
Element.Builder

removeReferences(int index)

public Element.Builder removeReferences(int index)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Element.Builder

setAssociation(SecurityResult value)

public Element.Builder setAssociation(SecurityResult value)

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Parameter
Name	Description
value	SecurityResult

Returns
Type	Description
Element.Builder

setAssociation(SecurityResult.Builder builderForValue)

public Element.Builder setAssociation(SecurityResult.Builder builderForValue)

Metadata that provides the relevant association for the references in the element. For a detection, this can be the correlated aspect of the references that contributed to the overall detection. For example, may include sub-rule condition, machine learning model metadata, and/or indicators implicated in this component of the detection (using the .about field).

.google.backstory.SecurityResult association = 1;

Parameter
Name	Description
builderForValue	SecurityResult.Builder

Returns
Type	Description
Element.Builder

setLabel(String value)

public Element.Builder setLabel(String value)

A name that labels the entire references group.

string label = 3;

Parameter
Name	Description
value	String The label to set.

Returns
Type	Description
Element.Builder	This builder for chaining.

setLabelBytes(ByteString value)

public Element.Builder setLabelBytes(ByteString value)

A name that labels the entire references group.

string label = 3;

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

Returns
Type	Description
Element.Builder	This builder for chaining.

setLatencyMetrics(LatencyMetrics value)

public Element.Builder setLatencyMetrics(LatencyMetrics value)

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Parameter
Name	Description
value	LatencyMetrics

Returns
Type	Description
Element.Builder

setLatencyMetrics(LatencyMetrics.Builder builderForValue)

public Element.Builder setLatencyMetrics(LatencyMetrics.Builder builderForValue)

Latency metrics for the specific element. These are calculated from all the contributing events or entities for a single event variable, not just the sampled ones included in references. This is currently only populated for UDM events.

.google.backstory.LatencyMetrics latency_metrics = 5;

Parameter
Name	Description
builderForValue	LatencyMetrics.Builder

Returns
Type	Description
Element.Builder

setReferences(int index, Reference value)

public Element.Builder setReferences(int index, Reference value)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameters
Name	Description
index	int
value	Reference

Returns
Type	Description
Element.Builder

setReferences(int index, Reference.Builder builderForValue)

public Element.Builder setReferences(int index, Reference.Builder builderForValue)

References to model primatives including events and entities that share a common association. Even though a reference can have both UDM and entity, a collection of references (of a single element) will only have one type of message in it (either UDM / Entity).

repeated .google.backstory.Reference references = 2;

Parameters
Name	Description
index	int
builderForValue	Reference.Builder

Returns
Type	Description
Element.Builder

setReferencesSampled(boolean value)

public Element.Builder setReferencesSampled(boolean value)

Copied from the detection event_sample.too_many_event_samples field. If true, the number of references will be capped at the sample limit (set at rule service). This is applicable to both UDM references and Entity references.

bool references_sampled = 4;

Parameter
Name	Description
value	boolean The referencesSampled to set.

Returns
Type	Description
Element.Builder	This builder for chaining.