Interface MetadataOrBuilder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public interface MetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaseLabels()

public abstract DataAccessLabels getBaseLabels()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
DataAccessLabels	The baseLabels.

getBaseLabelsOrBuilder()

public abstract DataAccessLabelsOrBuilder getBaseLabelsOrBuilder()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type	Description
DataAccessLabelsOrBuilder

getCollectedTimestamp()

public abstract 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.

getCollectedTimestampOrBuilder()

public abstract 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

getDescription()

public abstract String getDescription()

A human-readable unparsable description of the event.

string description = 9;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A human-readable unparsable description of the event.

string description = 9;

Returns
Type	Description
ByteString	The bytes for description.

getEnrichmentLabels()

public abstract 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.

getEnrichmentLabelsOrBuilder()

public abstract 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 abstract Metadata.EnrichmentState getEnrichmentState()

The enrichment state.

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

Returns
Type	Description
Metadata.EnrichmentState	The enrichmentState.

getEnrichmentStateValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getEventTimestampOrBuilder()

public abstract TimestampOrBuilder getEventTimestampOrBuilder()

The GMT timestamp when the event was generated.

.google.protobuf.Timestamp event_timestamp = 2;

Returns
Type	Description
TimestampOrBuilder

getEventType()

public abstract 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 abstract 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 abstract 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 abstract 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.

getIngestedTimestampOrBuilder()

public abstract 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 abstract 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

getIngestionLabelsCount()

public abstract int getIngestionLabelsCount()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
int

getIngestionLabelsList()

public abstract List<Label> getIngestionLabelsList()

User-configured ingestion metadata labels.

repeated .google.backstory.Label ingestion_labels = 12;

Returns
Type	Description
List<Label>

getIngestionLabelsOrBuilder(int index)

public abstract 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 abstract 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 abstract String getLogType()

The string value of log type.

string log_type = 17;

Returns
Type	Description
String	The logType.

getLogTypeBytes()

public abstract ByteString getLogTypeBytes()

The string value of log type.

string log_type = 17;

Returns
Type	Description
ByteString	The bytes for logType.

getParserVersion()

public abstract String getParserVersion()

The version of the parser that generated this UDM event.

string parser_version = 22;

Returns
Type	Description
String	The parserVersion.

getParserVersionBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getProductName()

The name of the product.

string product_name = 6;

Returns
Type	Description
String	The productName.

getProductNameBytes()

public abstract ByteString getProductNameBytes()

The name of the product.

string product_name = 6;

Returns
Type	Description
ByteString	The bytes for productName.

getProductVersion()

public abstract String getProductVersion()

The version of the product.

string product_version = 7;

Returns
Type	Description
String	The productVersion.

getProductVersionBytes()

public abstract ByteString getProductVersionBytes()

The version of the product.

string product_version = 7;

Returns
Type	Description
ByteString	The bytes for productVersion.

getStructuredFields() (deprecated)

public abstract 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.

getStructuredFieldsOrBuilder() (deprecated)

public abstract StructOrBuilder getStructuredFieldsOrBuilder()

Flattened fields extracted from the log.

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

Returns
Type	Description
StructOrBuilder

getTags()

public abstract 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.

getTagsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract String getVendorName()

The name of the product vendor.

string vendor_name = 5;

Returns
Type	Description
String	The vendorName.

getVendorNameBytes()

public abstract ByteString getVendorNameBytes()

The name of the product vendor.

string vendor_name = 5;

Returns
Type	Description
ByteString	The bytes for vendorName.

hasBaseLabels()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.