kythe.io@v0.0.68-0.20240422202219-7225dbc01741/kythe/proto/status_service.proto (about)

     1  /*
     2   * Copyright 2016 The Kythe Authors. All rights reserved.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *   http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  syntax = "proto3";
    18  
    19  package kythe.proto;
    20  
    21  option go_package = "kythe.io/kythe/proto/status_service_go_proto";
    22  option java_package = "com.google.devtools.kythe.proto";
    23  
    24  import "kythe/proto/common.proto";
    25  
    26  // StatusService provides clients a way to request information about the data
    27  // provided by another Kythe service such as XRefService. Clients can use this
    28  // to inform decisions about what requests to make to the primary service.
    29  service StatusService {
    30    rpc Status(StatusRequest) returns (StatusReply) {}
    31  }
    32  
    33  message StatusRequest {}
    34  
    35  message StatusReply {
    36    // The origins of the data served by this endpoint.
    37    repeated kythe.proto.common.Origin origins = 1;
    38  
    39    // The languages supported by this endpoint.
    40    repeated kythe.proto.common.Language languages = 2;
    41  
    42    // An index may comprise data from multiple build origins.  An index_version
    43    // is an opaque identifier for a complete index, encompassing all reported
    44    // origins being served.  This is usually distinct from each origin's
    45    // revision, and may be as simple as a timestamp at which the serving data
    46    // were created.
    47    string index_version = 3;
    48  }