1// Copyright 2023 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
15syntax = "proto3";
16
17package google.cloud.talent.v4;
18
19option go_package = "cloud.google.com/go/talent/apiv4/talentpb;talentpb";
20option java_multiple_files = true;
21option java_outer_classname = "HistogramProto";
22option java_package = "com.google.cloud.talent.v4";
23option objc_class_prefix = "CTS";
24
25// The histogram request.
26message HistogramQuery {
27  // An expression specifies a histogram request against matching jobs for
28  // searches.
29  //
30  // See
31  // [SearchJobsRequest.histogram_queries][google.cloud.talent.v4.SearchJobsRequest.histogram_queries]
32  // for details about syntax.
33  string histogram_query = 1;
34}
35
36// Histogram result that matches
37// [HistogramQuery][google.cloud.talent.v4.HistogramQuery] specified in
38// searches.
39message HistogramQueryResult {
40  // Requested histogram expression.
41  string histogram_query = 1;
42
43  // A map from the values of the facet associated with distinct values to the
44  // number of matching entries with corresponding value.
45  //
46  // The key format is:
47  //
48  // * (for string histogram) string values stored in the field.
49  // * (for named numeric bucket) name specified in `bucket()` function, like
50  //   for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`.
51  // * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for
52  //   example, `0-1000`, `MIN-0`, and `0-MAX`.
53  map<string, int64> histogram = 2;
54}
55