Skip to main content

metrics.proto

path mgmt/v1alpha1/metrics.proto

package mgmt.v1alpha1


Messages

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.

NameTypeDescription
yearuint32Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
monthuint32Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
dayuint32Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

DayResult

NameTypeDescription
dateDate
countuint64

GetDailyMetricCountRequest

NameTypeDescription
startDateThe start day
endDateThe end day
metricRangedMetricNameThe metric to return
account_idstringThe account identifier that will be used to filter by
job_idstringThe job identifier that will be used to filter by
run_idstringThe run identifier that will be used to filter by

GetDailyMetricCountResponse

NameTypeDescription
resultsrepeated DayResult

GetMetricCountRequest

NameTypeDescription
startgoogle.protobuf.Timestamp@deprecated - use start_day
endgoogle.protobuf.Timestamp@deprecated - use end_day
metricRangedMetricNameThe metric to return
account_idstringThe account identifier that will be used to filter by
job_idstringThe job identifier that will be used to filter by
run_idstringThe run identifier that will be used to filter by
start_dayDate
end_dayDate

GetMetricCountResponse

NameTypeDescription
countuint64The summed up count of the metric based on the input query and timerange specified

Enums

RangedMetricName

NameNumberDescription
RANGED_METRIC_NAME_UNSPECIFIED0If unspecified, an error will be thrown
RANGED_METRIC_NAME_INPUT_RECEIVED1The input_received metric

Services

MetricsService

GetDailyMetricCount

MethodGetDailyMetricCount
RequestGetDailyMetricCountRequest
ResponseGetDailyMetricCountResponse
DescriptionRetrieve a timed range of records

GetMetricCount

MethodGetMetricCount
RequestGetMetricCountRequest
ResponseGetMetricCountResponse
DescriptionFor the given metric and time range, returns the total count found