Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::Metric.
Stores precomputed aggregated analytic data for an entity.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dimensions
def dimensions() -> ::Array<::Google::Backstory::Metric::Dimension>
Returns
- (::Array<::Google::Backstory::Metric::Dimension>) — All group by clauses used to calculate the metric.
#dimensions=
def dimensions=(value) -> ::Array<::Google::Backstory::Metric::Dimension>
Parameter
- value (::Array<::Google::Backstory::Metric::Dimension>) — All group by clauses used to calculate the metric.
Returns
- (::Array<::Google::Backstory::Metric::Dimension>) — All group by clauses used to calculate the metric.
#display_name
def display_name() -> ::String
Returns
- (::String) — Display name of the custom metric. Google-authored metrics do not have a display name.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Display name of the custom metric. Google-authored metrics do not have a display name.
Returns
- (::String) — Display name of the custom metric. Google-authored metrics do not have a display name.
#export_window
def export_window() -> ::Integer
Returns
- (::Integer) — Export window for which the metric was exported.
#export_window=
def export_window=(value) -> ::Integer
Parameter
- value (::Integer) — Export window for which the metric was exported.
Returns
- (::Integer) — Export window for which the metric was exported.
#first_seen
def first_seen() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Timestamp of the first time the entity was seen in the environment.
#first_seen=
def first_seen=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Timestamp of the first time the entity was seen in the environment.
Returns
- (::Google::Protobuf::Timestamp) — Timestamp of the first time the entity was seen in the environment.
#last_seen
def last_seen() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time stamp of the last time last time the entity was seen in the environment.
#last_seen=
def last_seen=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time stamp of the last time last time the entity was seen in the environment.
Returns
- (::Google::Protobuf::Timestamp) — Time stamp of the last time last time the entity was seen in the environment.
#match_variables
def match_variables() -> ::Array<::Google::Backstory::FindingVariable>
Returns
- (::Array<::Google::Backstory::FindingVariable>) — List of match variables used in the custom metric.
#match_variables=
def match_variables=(value) -> ::Array<::Google::Backstory::FindingVariable>
Parameter
- value (::Array<::Google::Backstory::FindingVariable>) — List of match variables used in the custom metric.
Returns
- (::Array<::Google::Backstory::FindingVariable>) — List of match variables used in the custom metric.
#metric_name
def metric_name() -> ::Google::Backstory::Metric::MetricName
Returns
- (::Google::Backstory::Metric::MetricName) — Name of the analytic.
#metric_name=
def metric_name=(value) -> ::Google::Backstory::Metric::MetricName
Parameter
- value (::Google::Backstory::Metric::MetricName) — Name of the analytic.
Returns
- (::Google::Backstory::Metric::MetricName) — Name of the analytic.
#outcome_variables
def outcome_variables() -> ::Array<::Google::Backstory::FindingVariable>
Returns
- (::Array<::Google::Backstory::FindingVariable>) — List of outcome variables used in the custom metric.
#outcome_variables=
def outcome_variables=(value) -> ::Array<::Google::Backstory::FindingVariable>
Parameter
- value (::Array<::Google::Backstory::FindingVariable>) — List of outcome variables used in the custom metric.
Returns
- (::Array<::Google::Backstory::FindingVariable>) — List of outcome variables used in the custom metric.
#sum_measure
def sum_measure() -> ::Google::Backstory::Metric::Measure
Returns
- (::Google::Backstory::Metric::Measure) — Sum of all precomputed measures for the given metric.
#sum_measure=
def sum_measure=(value) -> ::Google::Backstory::Metric::Measure
Parameter
- value (::Google::Backstory::Metric::Measure) — Sum of all precomputed measures for the given metric.
Returns
- (::Google::Backstory::Metric::Measure) — Sum of all precomputed measures for the given metric.
#time_range
def time_range() -> ::Google::Type::Interval
Returns
- (::Google::Type::Interval) — Time range for which the custom metric was calculated.
#time_range=
def time_range=(value) -> ::Google::Type::Interval
Parameter
- value (::Google::Type::Interval) — Time range for which the custom metric was calculated.
Returns
- (::Google::Type::Interval) — Time range for which the custom metric was calculated.
#total_events
def total_events() -> ::Integer
Returns
- (::Integer) — Total number of events used to calculate the given precomputed metric.
#total_events=
def total_events=(value) -> ::Integer
Parameter
- value (::Integer) — Total number of events used to calculate the given precomputed metric.
Returns
- (::Integer) — Total number of events used to calculate the given precomputed metric.