Class Metadata.Builder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public static final class Metadata.Builder extends GeneratedMessage.Builder<Metadata.Builder> implements MetadataOrBuilder

General information associated with a UDM event.

Protobuf type google.backstory.Metadata

Inheritance

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

Implements

MetadataOrBuilder

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

addAllEventTimestampAttributes(Iterable<? extends Metadata.EventTimestampAttribute> values)

public Metadata.Builder addAllEventTimestampAttributes(Iterable<? extends Metadata.EventTimestampAttribute> values)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
values	Iterable<? extends com.google.backstory.Metadata.EventTimestampAttribute> The eventTimestampAttributes to add.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

addAllEventTimestampAttributesValue(Iterable<Integer> values)

public Metadata.Builder addAllEventTimestampAttributesValue(Iterable<Integer> values)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
values	Iterable<Integer> The enum numeric values on the wire for eventTimestampAttributes to add.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

addAllIngestionLabels(Iterable<? extends Label> values)

public Metadata.Builder addAllIngestionLabels(Iterable<? extends Label> values)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

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

Returns
Type	Description
Metadata.Builder

addEventTimestampAttributes(Metadata.EventTimestampAttribute value)

public Metadata.Builder addEventTimestampAttributes(Metadata.EventTimestampAttribute value)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
value	Metadata.EventTimestampAttribute The eventTimestampAttributes to add.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

addEventTimestampAttributesValue(int value)

public Metadata.Builder addEventTimestampAttributesValue(int value)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
value	int The enum numeric value on the wire for eventTimestampAttributes to add.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

addIngestionLabels(Label value)

public Metadata.Builder addIngestionLabels(Label value)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
value	Label

Returns
Type	Description
Metadata.Builder

addIngestionLabels(Label.Builder builderForValue)

public Metadata.Builder addIngestionLabels(Label.Builder builderForValue)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
builderForValue	Label.Builder

Returns
Type	Description
Metadata.Builder

addIngestionLabels(int index, Label value)

public Metadata.Builder addIngestionLabels(int index, Label value)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameters
Name	Description
index	int
value	Label

Returns
Type	Description
Metadata.Builder

addIngestionLabels(int index, Label.Builder builderForValue)

public Metadata.Builder addIngestionLabels(int index, Label.Builder builderForValue)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameters
Name	Description
index	int
builderForValue	Label.Builder

Returns
Type	Description
Metadata.Builder

addIngestionLabelsBuilder()

public Label.Builder addIngestionLabelsBuilder()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
Label.Builder

addIngestionLabelsBuilder(int index)

public Label.Builder addIngestionLabelsBuilder(int index)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Label.Builder

build()

public Metadata build()

Returns
Type	Description
Metadata

buildPartial()

public Metadata buildPartial()

Returns
Type	Description
Metadata

clear()

public Metadata.Builder clear()

Returns
Type	Description
Metadata.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearBaseLabels()

public Metadata.Builder clearBaseLabels()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
Metadata.Builder

clearCollectedTimestamp()

public Metadata.Builder clearCollectedTimestamp()

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Returns
Type	Description
Metadata.Builder

clearDescription()

public Metadata.Builder clearDescription()

A human-readable unparsable description of the event.

string description = 9;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearEnrichmentLabels()

public Metadata.Builder clearEnrichmentLabels()

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Returns
Type	Description
Metadata.Builder

clearEnrichmentState()

public Metadata.Builder clearEnrichmentState()

The enrichment state.

.google.backstory.Metadata.EnrichmentState enrichment_state = 16;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearEventTimestamp()

public Metadata.Builder clearEventTimestamp()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
Metadata.Builder

clearEventTimestampAttributes()

public Metadata.Builder clearEventTimestampAttributes()

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearEventType()

public Metadata.Builder clearEventType()

The event type. If an event has multiple possible types, this specifies the most specific type.

.google.backstory.Metadata.EventType event_type = 4;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearId()

public Metadata.Builder clearId()

ID of the UDM event. Can be used for raw and normalized event retrieval.

bytes id = 15;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearIngestedTimestamp()

public Metadata.Builder clearIngestedTimestamp()

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Returns
Type	Description
Metadata.Builder

clearIngestionLabels()

public Metadata.Builder clearIngestionLabels()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
Metadata.Builder

clearLogType()

public Metadata.Builder clearLogType()

The string value of log type.

string log_type = 17;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearParserVersion()

public Metadata.Builder clearParserVersion()

The version of the parser that generated this UDM event.

string parser_version = 22;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearProductDeploymentId()

public Metadata.Builder clearProductDeploymentId()

The deployment identifier assigned by the vendor for a product deployment.

string product_deployment_id = 14;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearProductEventType()

public Metadata.Builder clearProductEventType()

A short, descriptive, human-readable, product-specific event name or type (e.g. "Scanned X", "User account created", "process_start").

string product_event_type = 8;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearProductLogId()

public Metadata.Builder clearProductLogId()

A vendor-specific event identifier to uniquely identify the event (e.g. a GUID).

string product_log_id = 1;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearProductName()

public Metadata.Builder clearProductName()

The name of the product.

string product_name = 6;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearProductVersion()

public Metadata.Builder clearProductVersion()

The version of the product.

string product_version = 7;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearStructuredFields() (deprecated)

public Metadata.Builder clearStructuredFields()

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Returns
Type	Description
Metadata.Builder

clearTags()

public Metadata.Builder clearTags()

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Returns
Type	Description
Metadata.Builder

clearUrlBackToProduct()

public Metadata.Builder clearUrlBackToProduct()

A URL that takes the user to the source product console for this event.

string url_back_to_product = 10;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

clearVendorName()

public Metadata.Builder clearVendorName()

The name of the product vendor.

string vendor_name = 5;

Returns
Type	Description
Metadata.Builder	This builder for chaining.

getBaseLabels()

public DataAccessLabels getBaseLabels()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
DataAccessLabels	The baseLabels.

getBaseLabelsBuilder()

public DataAccessLabels.Builder getBaseLabelsBuilder()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
DataAccessLabels.Builder

getBaseLabelsOrBuilder()

public DataAccessLabelsOrBuilder getBaseLabelsOrBuilder()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
DataAccessLabelsOrBuilder

getCollectedTimestamp()

public Timestamp getCollectedTimestamp()

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Returns
Type	Description
Timestamp	The collectedTimestamp.

getCollectedTimestampBuilder()

public Timestamp.Builder getCollectedTimestampBuilder()

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Returns
Type	Description
Builder

getCollectedTimestampOrBuilder()

public TimestampOrBuilder getCollectedTimestampOrBuilder()

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Metadata getDefaultInstanceForType()

Returns
Type	Description
Metadata

getDescription()

public String getDescription()

A human-readable unparsable description of the event.

string description = 9;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A human-readable unparsable description of the event.

string description = 9;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEnrichmentLabels()

public DataAccessLabels getEnrichmentLabels()

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Returns
Type	Description
DataAccessLabels	The enrichmentLabels.

getEnrichmentLabelsBuilder()

public DataAccessLabels.Builder getEnrichmentLabelsBuilder()

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Returns
Type	Description
DataAccessLabels.Builder

getEnrichmentLabelsOrBuilder()

public DataAccessLabelsOrBuilder getEnrichmentLabelsOrBuilder()

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Returns
Type	Description
DataAccessLabelsOrBuilder

getEnrichmentState()

public Metadata.EnrichmentState getEnrichmentState()

The enrichment state.

.google.backstory.Metadata.EnrichmentState enrichment_state = 16;

Returns
Type	Description
Metadata.EnrichmentState	The enrichmentState.

getEnrichmentStateValue()

public int getEnrichmentStateValue()

The enrichment state.

.google.backstory.Metadata.EnrichmentState enrichment_state = 16;

Returns
Type	Description
int	The enum numeric value on the wire for enrichmentState.

getEventTimestamp()

public Timestamp getEventTimestamp()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
Timestamp	The eventTimestamp.

getEventTimestampAttributes(int index)

public Metadata.EventTimestampAttribute getEventTimestampAttributes(int index)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
Metadata.EventTimestampAttribute	The eventTimestampAttributes at the given index.

getEventTimestampAttributesCount()

public int getEventTimestampAttributesCount()

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Returns
Type	Description
int	The count of eventTimestampAttributes.

getEventTimestampAttributesList()

public List<Metadata.EventTimestampAttribute> getEventTimestampAttributesList()

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Returns
Type	Description
List<EventTimestampAttribute>	A list containing the eventTimestampAttributes.

getEventTimestampAttributesValue(int index)

public int getEventTimestampAttributesValue(int index)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of eventTimestampAttributes at the given index.

getEventTimestampAttributesValueList()

public List<Integer> getEventTimestampAttributesValueList()

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for eventTimestampAttributes.

getEventTimestampBuilder()

public Timestamp.Builder getEventTimestampBuilder()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
Builder

getEventTimestampOrBuilder()

public TimestampOrBuilder getEventTimestampOrBuilder()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
TimestampOrBuilder

getEventType()

public Metadata.EventType getEventType()

The event type. If an event has multiple possible types, this specifies the most specific type.

.google.backstory.Metadata.EventType event_type = 4;

Returns
Type	Description
Metadata.EventType	The eventType.

getEventTypeValue()

public int getEventTypeValue()

The event type. If an event has multiple possible types, this specifies the most specific type.

.google.backstory.Metadata.EventType event_type = 4;

Returns
Type	Description
int	The enum numeric value on the wire for eventType.

getId()

public ByteString getId()

ID of the UDM event. Can be used for raw and normalized event retrieval.

bytes id = 15;

Returns
Type	Description
ByteString	The id.

getIngestedTimestamp()

public Timestamp getIngestedTimestamp()

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Returns
Type	Description
Timestamp	The ingestedTimestamp.

getIngestedTimestampBuilder()

public Timestamp.Builder getIngestedTimestampBuilder()

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Returns
Type	Description
Builder

getIngestedTimestampOrBuilder()

public TimestampOrBuilder getIngestedTimestampOrBuilder()

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Returns
Type	Description
TimestampOrBuilder

getIngestionLabels(int index)

public Label getIngestionLabels(int index)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Label

getIngestionLabelsBuilder(int index)

public Label.Builder getIngestionLabelsBuilder(int index)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Label.Builder

getIngestionLabelsBuilderList()

public List<Label.Builder> getIngestionLabelsBuilderList()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
List<Builder>

getIngestionLabelsCount()

public int getIngestionLabelsCount()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
int

getIngestionLabelsList()

public List<Label> getIngestionLabelsList()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
List<Label>

getIngestionLabelsOrBuilder(int index)

public LabelOrBuilder getIngestionLabelsOrBuilder(int index)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
LabelOrBuilder

getIngestionLabelsOrBuilderList()

public List<? extends LabelOrBuilder> getIngestionLabelsOrBuilderList()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

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

getLogType()

public String getLogType()

The string value of log type.

string log_type = 17;

Returns
Type	Description
String	The logType.

getLogTypeBytes()

public ByteString getLogTypeBytes()

The string value of log type.

string log_type = 17;

Returns
Type	Description
ByteString	The bytes for logType.

getParserVersion()

public String getParserVersion()

The version of the parser that generated this UDM event.

string parser_version = 22;

Returns
Type	Description
String	The parserVersion.

getParserVersionBytes()

public ByteString getParserVersionBytes()

The version of the parser that generated this UDM event.

string parser_version = 22;

Returns
Type	Description
ByteString	The bytes for parserVersion.

getProductDeploymentId()

public String getProductDeploymentId()

The deployment identifier assigned by the vendor for a product deployment.

string product_deployment_id = 14;

Returns
Type	Description
String	The productDeploymentId.

getProductDeploymentIdBytes()

public ByteString getProductDeploymentIdBytes()

The deployment identifier assigned by the vendor for a product deployment.

string product_deployment_id = 14;

Returns
Type	Description
ByteString	The bytes for productDeploymentId.

getProductEventType()

public String getProductEventType()

A short, descriptive, human-readable, product-specific event name or type (e.g. "Scanned X", "User account created", "process_start").

string product_event_type = 8;

Returns
Type	Description
String	The productEventType.

getProductEventTypeBytes()

public ByteString getProductEventTypeBytes()

A short, descriptive, human-readable, product-specific event name or type (e.g. "Scanned X", "User account created", "process_start").

string product_event_type = 8;

Returns
Type	Description
ByteString	The bytes for productEventType.

getProductLogId()

public String getProductLogId()

A vendor-specific event identifier to uniquely identify the event (e.g. a GUID).

string product_log_id = 1;

Returns
Type	Description
String	The productLogId.

getProductLogIdBytes()

public ByteString getProductLogIdBytes()

A vendor-specific event identifier to uniquely identify the event (e.g. a GUID).

string product_log_id = 1;

Returns
Type	Description
ByteString	The bytes for productLogId.

getProductName()

public String getProductName()

The name of the product.

string product_name = 6;

Returns
Type	Description
String	The productName.

getProductNameBytes()

public ByteString getProductNameBytes()

The name of the product.

string product_name = 6;

Returns
Type	Description
ByteString	The bytes for productName.

getProductVersion()

public String getProductVersion()

The version of the product.

string product_version = 7;

Returns
Type	Description
String	The productVersion.

getProductVersionBytes()

public ByteString getProductVersionBytes()

The version of the product.

string product_version = 7;

Returns
Type	Description
ByteString	The bytes for productVersion.

getStructuredFields() (deprecated)

public Struct getStructuredFields()

Deprecated. google.backstory.Metadata.structured_fields is deprecated. See backstory/udm.proto;l=762

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Returns
Type	Description
Struct	The structuredFields.

getStructuredFieldsBuilder() (deprecated)

public Struct.Builder getStructuredFieldsBuilder()

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Returns
Type	Description
Builder

getStructuredFieldsOrBuilder() (deprecated)

public StructOrBuilder getStructuredFieldsOrBuilder()

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Returns
Type	Description
StructOrBuilder

getTags()

public Tags getTags()

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Returns
Type	Description
Tags	The tags.

getTagsBuilder()

public Tags.Builder getTagsBuilder()

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Returns
Type	Description
Tags.Builder

getTagsOrBuilder()

public TagsOrBuilder getTagsOrBuilder()

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Returns
Type	Description
TagsOrBuilder

getUrlBackToProduct()

public String getUrlBackToProduct()

A URL that takes the user to the source product console for this event.

string url_back_to_product = 10;

Returns
Type	Description
String	The urlBackToProduct.

getUrlBackToProductBytes()

public ByteString getUrlBackToProductBytes()

A URL that takes the user to the source product console for this event.

string url_back_to_product = 10;

Returns
Type	Description
ByteString	The bytes for urlBackToProduct.

getVendorName()

public String getVendorName()

The name of the product vendor.

string vendor_name = 5;

Returns
Type	Description
String	The vendorName.

getVendorNameBytes()

public ByteString getVendorNameBytes()

The name of the product vendor.

string vendor_name = 5;

Returns
Type	Description
ByteString	The bytes for vendorName.

hasBaseLabels()

public boolean hasBaseLabels()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
boolean	Whether the baseLabels field is set.

hasCollectedTimestamp()

public boolean hasCollectedTimestamp()

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Returns
Type	Description
boolean	Whether the collectedTimestamp field is set.

hasEnrichmentLabels()

public boolean hasEnrichmentLabels()

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Returns
Type	Description
boolean	Whether the enrichmentLabels field is set.

hasEventTimestamp()

public boolean hasEventTimestamp()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
boolean	Whether the eventTimestamp field is set.

hasIngestedTimestamp()

public boolean hasIngestedTimestamp()

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Returns
Type	Description
boolean	Whether the ingestedTimestamp field is set.

hasStructuredFields() (deprecated)

public boolean hasStructuredFields()

Deprecated. google.backstory.Metadata.structured_fields is deprecated. See backstory/udm.proto;l=762

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Returns
Type	Description
boolean	Whether the structuredFields field is set.

hasTags()

public boolean hasTags()

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

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

mergeBaseLabels(DataAccessLabels value)

public Metadata.Builder mergeBaseLabels(DataAccessLabels value)

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Parameter
Name	Description
value	DataAccessLabels

Returns
Type	Description
Metadata.Builder

mergeCollectedTimestamp(Timestamp value)

public Metadata.Builder mergeCollectedTimestamp(Timestamp value)

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

mergeEnrichmentLabels(DataAccessLabels value)

public Metadata.Builder mergeEnrichmentLabels(DataAccessLabels value)

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Parameter
Name	Description
value	DataAccessLabels

Returns
Type	Description
Metadata.Builder

mergeEventTimestamp(Timestamp value)

public Metadata.Builder mergeEventTimestamp(Timestamp value)

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

mergeFrom(Metadata other)

public Metadata.Builder mergeFrom(Metadata other)

Parameter
Name	Description
other	Metadata

Returns
Type	Description
Metadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metadata.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Metadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Metadata.Builder

Overrides

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

mergeIngestedTimestamp(Timestamp value)

public Metadata.Builder mergeIngestedTimestamp(Timestamp value)

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

mergeStructuredFields(Struct value) (deprecated)

public Metadata.Builder mergeStructuredFields(Struct value)

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Parameter
Name	Description
value	Struct

Returns
Type	Description
Metadata.Builder

mergeTags(Tags value)

public Metadata.Builder mergeTags(Tags value)

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Parameter
Name	Description
value	Tags

Returns
Type	Description
Metadata.Builder

removeIngestionLabels(int index)

public Metadata.Builder removeIngestionLabels(int index)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Metadata.Builder

setBaseLabels(DataAccessLabels value)

public Metadata.Builder setBaseLabels(DataAccessLabels value)

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Parameter
Name	Description
value	DataAccessLabels

Returns
Type	Description
Metadata.Builder

setBaseLabels(DataAccessLabels.Builder builderForValue)

public Metadata.Builder setBaseLabels(DataAccessLabels.Builder builderForValue)

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Parameter
Name	Description
builderForValue	DataAccessLabels.Builder

Returns
Type	Description
Metadata.Builder

setCollectedTimestamp(Timestamp value)

public Metadata.Builder setCollectedTimestamp(Timestamp value)

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

setCollectedTimestamp(Timestamp.Builder builderForValue)

public Metadata.Builder setCollectedTimestamp(Timestamp.Builder builderForValue)

The GMT timestamp when the event was collected by the vendor's local collection infrastructure.

.google.protobuf.Timestamp collected_timestamp = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Metadata.Builder

setDescription(String value)

public Metadata.Builder setDescription(String value)

A human-readable unparsable description of the event.

string description = 9;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Metadata.Builder setDescriptionBytes(ByteString value)

A human-readable unparsable description of the event.

string description = 9;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEnrichmentLabels(DataAccessLabels value)

public Metadata.Builder setEnrichmentLabels(DataAccessLabels value)

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Parameter
Name	Description
value	DataAccessLabels

Returns
Type	Description
Metadata.Builder

setEnrichmentLabels(DataAccessLabels.Builder builderForValue)

public Metadata.Builder setEnrichmentLabels(DataAccessLabels.Builder builderForValue)

Data access labels from all the contextual events used to enrich the base event.

.google.backstory.DataAccessLabels enrichment_labels = 19;

Parameter
Name	Description
builderForValue	DataAccessLabels.Builder

Returns
Type	Description
Metadata.Builder

setEnrichmentState(Metadata.EnrichmentState value)

public Metadata.Builder setEnrichmentState(Metadata.EnrichmentState value)

The enrichment state.

.google.backstory.Metadata.EnrichmentState enrichment_state = 16;

Parameter
Name	Description
value	Metadata.EnrichmentState The enrichmentState to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEnrichmentStateValue(int value)

public Metadata.Builder setEnrichmentStateValue(int value)

The enrichment state.

.google.backstory.Metadata.EnrichmentState enrichment_state = 16;

Parameter
Name	Description
value	int The enum numeric value on the wire for enrichmentState to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEventTimestamp(Timestamp value)

public Metadata.Builder setEventTimestamp(Timestamp value)

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

setEventTimestamp(Timestamp.Builder builderForValue)

public Metadata.Builder setEventTimestamp(Timestamp.Builder builderForValue)

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Metadata.Builder

setEventTimestampAttributes(int index, Metadata.EventTimestampAttribute value)

public Metadata.Builder setEventTimestampAttributes(int index, Metadata.EventTimestampAttribute value)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameters
Name	Description
index	int The index to set the value at.
value	Metadata.EventTimestampAttribute The eventTimestampAttributes to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEventTimestampAttributesValue(int index, int value)

public Metadata.Builder setEventTimestampAttributesValue(int index, int value)

Attributes associated with event_timestamp. This field is used to distinguish between different types of timestamps that can be used to represent the event_timestamp.

repeated .google.backstory.Metadata.EventTimestampAttribute event_timestamp_attributes = 21;

Parameters
Name	Description
index	int The index to set the value at.
value	int The enum numeric value on the wire for eventTimestampAttributes to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEventType(Metadata.EventType value)

public Metadata.Builder setEventType(Metadata.EventType value)

The event type. If an event has multiple possible types, this specifies the most specific type.

.google.backstory.Metadata.EventType event_type = 4;

Parameter
Name	Description
value	Metadata.EventType The eventType to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setEventTypeValue(int value)

public Metadata.Builder setEventTypeValue(int value)

The event type. If an event has multiple possible types, this specifies the most specific type.

.google.backstory.Metadata.EventType event_type = 4;

Parameter
Name	Description
value	int The enum numeric value on the wire for eventType to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setId(ByteString value)

public Metadata.Builder setId(ByteString value)

ID of the UDM event. Can be used for raw and normalized event retrieval.

bytes id = 15;

Parameter
Name	Description
value	ByteString The id to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setIngestedTimestamp(Timestamp value)

public Metadata.Builder setIngestedTimestamp(Timestamp value)

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Metadata.Builder

setIngestedTimestamp(Timestamp.Builder builderForValue)

public Metadata.Builder setIngestedTimestamp(Timestamp.Builder builderForValue)

The GMT timestamp when the event was ingested (received) by Chronicle.

.google.protobuf.Timestamp ingested_timestamp = 11;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Metadata.Builder

setIngestionLabels(int index, Label value)

public Metadata.Builder setIngestionLabels(int index, Label value)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameters
Name	Description
index	int
value	Label

Returns
Type	Description
Metadata.Builder

setIngestionLabels(int index, Label.Builder builderForValue)

public Metadata.Builder setIngestionLabels(int index, Label.Builder builderForValue)

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Parameters
Name	Description
index	int
builderForValue	Label.Builder

Returns
Type	Description
Metadata.Builder

setLogType(String value)

public Metadata.Builder setLogType(String value)

The string value of log type.

string log_type = 17;

Parameter
Name	Description
value	String The logType to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setLogTypeBytes(ByteString value)

public Metadata.Builder setLogTypeBytes(ByteString value)

The string value of log type.

string log_type = 17;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setParserVersion(String value)

public Metadata.Builder setParserVersion(String value)

The version of the parser that generated this UDM event.

string parser_version = 22;

Parameter
Name	Description
value	String The parserVersion to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setParserVersionBytes(ByteString value)

public Metadata.Builder setParserVersionBytes(ByteString value)

The version of the parser that generated this UDM event.

string parser_version = 22;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductDeploymentId(String value)

public Metadata.Builder setProductDeploymentId(String value)

The deployment identifier assigned by the vendor for a product deployment.

string product_deployment_id = 14;

Parameter
Name	Description
value	String The productDeploymentId to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductDeploymentIdBytes(ByteString value)

public Metadata.Builder setProductDeploymentIdBytes(ByteString value)

The deployment identifier assigned by the vendor for a product deployment.

string product_deployment_id = 14;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductEventType(String value)

public Metadata.Builder setProductEventType(String value)

A short, descriptive, human-readable, product-specific event name or type (e.g. "Scanned X", "User account created", "process_start").

string product_event_type = 8;

Parameter
Name	Description
value	String The productEventType to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductEventTypeBytes(ByteString value)

public Metadata.Builder setProductEventTypeBytes(ByteString value)

A short, descriptive, human-readable, product-specific event name or type (e.g. "Scanned X", "User account created", "process_start").

string product_event_type = 8;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductLogId(String value)

public Metadata.Builder setProductLogId(String value)

A vendor-specific event identifier to uniquely identify the event (e.g. a GUID).

string product_log_id = 1;

Parameter
Name	Description
value	String The productLogId to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductLogIdBytes(ByteString value)

public Metadata.Builder setProductLogIdBytes(ByteString value)

A vendor-specific event identifier to uniquely identify the event (e.g. a GUID).

string product_log_id = 1;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductName(String value)

public Metadata.Builder setProductName(String value)

The name of the product.

string product_name = 6;

Parameter
Name	Description
value	String The productName to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductNameBytes(ByteString value)

public Metadata.Builder setProductNameBytes(ByteString value)

The name of the product.

string product_name = 6;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductVersion(String value)

public Metadata.Builder setProductVersion(String value)

The version of the product.

string product_version = 7;

Parameter
Name	Description
value	String The productVersion to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setProductVersionBytes(ByteString value)

public Metadata.Builder setProductVersionBytes(ByteString value)

The version of the product.

string product_version = 7;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setStructuredFields(Struct value) (deprecated)

public Metadata.Builder setStructuredFields(Struct value)

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Parameter
Name	Description
value	Struct

Returns
Type	Description
Metadata.Builder

setStructuredFields(Struct.Builder builderForValue) (deprecated)

public Metadata.Builder setStructuredFields(Struct.Builder builderForValue)

Flattened fields extracted from the log.

.google.protobuf.Struct structured_fields = 20 [deprecated = true];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Metadata.Builder

setTags(Tags value)

public Metadata.Builder setTags(Tags value)

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Parameter
Name	Description
value	Tags

Returns
Type	Description
Metadata.Builder

setTags(Tags.Builder builderForValue)

public Metadata.Builder setTags(Tags.Builder builderForValue)

Tags added by Chronicle after an event is parsed. It is an error to populate this field from within a parser.

.google.backstory.Tags tags = 13;

Parameter
Name	Description
builderForValue	Tags.Builder

Returns
Type	Description
Metadata.Builder

setUrlBackToProduct(String value)

public Metadata.Builder setUrlBackToProduct(String value)

A URL that takes the user to the source product console for this event.

string url_back_to_product = 10;

Parameter
Name	Description
value	String The urlBackToProduct to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setUrlBackToProductBytes(ByteString value)

public Metadata.Builder setUrlBackToProductBytes(ByteString value)

A URL that takes the user to the source product console for this event.

string url_back_to_product = 10;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setVendorName(String value)

public Metadata.Builder setVendorName(String value)

The name of the product vendor.

string vendor_name = 5;

Parameter
Name	Description
value	String The vendorName to set.

Returns
Type	Description
Metadata.Builder	This builder for chaining.

setVendorNameBytes(ByteString value)

public Metadata.Builder setVendorNameBytes(ByteString value)

The name of the product vendor.

string vendor_name = 5;

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

Returns
Type	Description
Metadata.Builder	This builder for chaining.