histogram.proto 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.talent.v4beta1;
  16. import "google/api/annotations.proto";
  17. option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
  18. option java_multiple_files = true;
  19. option java_outer_classname = "HistogramProto";
  20. option java_package = "com.google.cloud.talent.v4beta1";
  21. option objc_class_prefix = "CTS";
  22. // The histogram request.
  23. message HistogramQuery {
  24. // An expression specifies a histogram request against matching resources
  25. // (for example, jobs, profiles) for searches.
  26. //
  27. // See [SearchJobsRequest.histogram_queries][google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries] and
  28. // [SearchProfilesRequest.histogram_queries][google.cloud.talent.v4beta1.SearchProfilesRequest.histogram_queries] for details about syntax.
  29. string histogram_query = 1;
  30. }
  31. // Histogram result that matches [HistogramQuery][google.cloud.talent.v4beta1.HistogramQuery] specified in searches.
  32. message HistogramQueryResult {
  33. // Requested histogram expression.
  34. string histogram_query = 1;
  35. // A map from the values of the facet associated with distinct values to the
  36. // number of matching entries with corresponding value.
  37. //
  38. // The key format is:
  39. //
  40. // * (for string histogram) string values stored in the field.
  41. // * (for named numeric bucket) name specified in `bucket()` function, like
  42. // for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
  43. // * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
  44. // example, `0-1000`, `MIN-0`, and `0-MAX`.
  45. map<string, int64> histogram = 2;
  46. }