Class Metadata (0.3.0)

public final class Metadata extends GeneratedMessage implements MetadataOrBuilder

General information associated with a UDM event.

Protobuf type google.backstory.Metadata

Implements

MetadataOrBuilder

Static Fields

BASE_LABELS_FIELD_NUMBER

public static final int BASE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

COLLECTED_TIMESTAMP_FIELD_NUMBER

public static final int COLLECTED_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENRICHMENT_LABELS_FIELD_NUMBER

public static final int ENRICHMENT_LABELS_FIELD_NUMBER
Field Value
Type Description
int

ENRICHMENT_STATE_FIELD_NUMBER

public static final int ENRICHMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TIMESTAMP_ATTRIBUTES_FIELD_NUMBER

public static final int EVENT_TIMESTAMP_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TIMESTAMP_FIELD_NUMBER

public static final int EVENT_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TYPE_FIELD_NUMBER

public static final int EVENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INGESTED_TIMESTAMP_FIELD_NUMBER

public static final int INGESTED_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

INGESTION_LABELS_FIELD_NUMBER

public static final int INGESTION_LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOG_TYPE_FIELD_NUMBER

public static final int LOG_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PARSER_VERSION_FIELD_NUMBER

public static final int PARSER_VERSION_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_DEPLOYMENT_ID_FIELD_NUMBER

public static final int PRODUCT_DEPLOYMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_EVENT_TYPE_FIELD_NUMBER

public static final int PRODUCT_EVENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_LOG_ID_FIELD_NUMBER

public static final int PRODUCT_LOG_ID_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_NAME_FIELD_NUMBER

public static final int PRODUCT_NAME_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_VERSION_FIELD_NUMBER

public static final int PRODUCT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

STRUCTURED_FIELDS_FIELD_NUMBER

public static final int STRUCTURED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

URL_BACK_TO_PRODUCT_FIELD_NUMBER

public static final int URL_BACK_TO_PRODUCT_FIELD_NUMBER
Field Value
Type Description
int

VENDOR_NAME_FIELD_NUMBER

public static final int VENDOR_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Metadata getDefaultInstance()
Returns
Type Description
Metadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Metadata.Builder newBuilder()
Returns
Type Description
Metadata.Builder

newBuilder(Metadata prototype)

public static Metadata.Builder newBuilder(Metadata prototype)
Parameter
Name Description
prototype Metadata
Returns
Type Description
Metadata.Builder

parseDelimitedFrom(InputStream input)

public static Metadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Metadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Metadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Metadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Metadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Metadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Metadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Metadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Metadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Metadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Metadata> parser()
Returns
Type Description
Parser<Metadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaseLabels()

public DataAccessLabels getBaseLabels()

Data access labels on the base event.

.google.backstory.DataAccessLabels base_labels = 18;

Returns
Type Description
DataAccessLabels

The baseLabels.

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.

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.

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.

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.

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.

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

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.

getParserForType()

public Parser<Metadata> getParserForType()
Returns
Type Description
Parser<Metadata>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Metadata.Builder newBuilderForType()
Returns
Type Description
Metadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Metadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Metadata.Builder
Overrides

toBuilder()

public Metadata.Builder toBuilder()
Returns
Type Description
Metadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException