Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add ReportMetadata to MeasurementSpec #222

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/main/proto/wfa/measurement/api/v2alpha/measurement_spec.proto
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,29 @@ message MeasurementSpec {
(google.api.resource_reference).type = "halo.wfanet.org/ModelLine",
(google.api.field_behavior) = IMMUTABLE
];

// Metadata provided by the Reporting System that describes how the
// Measurement is being used.
message ReportingMetadata {
// Resource name of the containing `Report`
string report = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = { type: "halo.wfanet.org/Report" }
];
// Resource name of the containing `Metric`
string metric = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = { type: "halo.wfanet.org/Metric" }
];
}
// Metadata provided by the Reporting System.
//
// When present the report_metadata can be used by EDPs to group Measurements
// into logical units to help optimize fulfilment processes.
ReportingMetadata reporting_metadata = 11 [
(google.api.field_behavior) = OPTIONAL,
(google.api.field_behavior) = IMMUTABLE
];
}