Skip to content
Snippets Groups Projects
Select Git revision
  • 795aeb65ee38447bbbdb176179139883be74ac9a
  • master default protected
  • feature/PRXS-3383-CollectionsRankSort
  • feature/3149-LocaleCodeAsID
  • refactor/PRXS-3053-RefactorFiles
  • feature/3146-UpdateItemStorageInterface
  • feature/3180-RemoveOldHugo
  • feature/3264-FixExtracTranslationsArrays
  • feature/3274-ObjectIndexesFixes
  • feature/2931-AllowPartialDecode
  • feature/3055-ItemsRestAPI
  • feature/3082-gitlab-triage
  • feature/3055-LogsRestAPI
  • feature/2985-add-preset-settings
  • feature/2929-MultiInvitationFix
  • feature/2929-MultiInvitation
  • docs/2889-HugoModules
  • docs/2954-CheckResource
  • docs/3012-SplitBuild
  • docs/3024-PerxisWebStatic
  • feature/2911-GetArchive
  • v0.27.0
  • v0.21.0
  • v0.19.0
  • v0.20.0
25 results

status.proto

Blame
  • status.proto 3.86 KiB
    // Copyright (c) 2015, Google Inc.
    //
    // Licensed under the Apache License, Version 2.0 (the "License");
    // you may not use this file except in compliance with the License.
    // You may obtain a copy of the License at
    //
    //     http://www.apache.org/licenses/LICENSE-2.0
    //
    // Unless required by applicable law or agreed to in writing, software
    // distributed under the License is distributed on an "AS IS" BASIS,
    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    // See the License for the specific language governing permissions and
    // limitations under the License.
    
    syntax = "proto3";
    
    package google.rpc;
    
    import "google/protobuf/any.proto";
    
    option java_multiple_files = true;
    option java_outer_classname = "StatusProto";
    option java_package = "com.google.rpc";
    
    
    // The `Status` type defines a logical error model that is suitable for different
    // programming environments, including REST APIs and RPC APIs. It is used by
    // [gRPC](https://github.com/grpc). The error model is designed to be:
    //
    // - Simple to use and understand for most users
    // - Flexible enough to meet unexpected needs
    //
    // # Overview
    //
    // The `Status` message contains three pieces of data: error code, error message,
    // and error details. The error code should be an enum value of
    // [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed.  The
    // error message should be a developer-facing English message that helps
    // developers *understand* and *resolve* the error. If a localized user-facing
    // error message is needed, put the localized message in the error details or
    // localize it in the client. The optional error details may contain arbitrary
    // information about the error. There is a predefined set of error detail types
    // in the package `google.rpc` which can be used for common error conditions.
    //
    // # Language mapping
    //
    // The `Status` message is the logical representation of the error model, but it
    // is not necessarily the actual wire format. When the `Status` message is
    // exposed in different client libraries and different wire protocols, it can be
    // mapped differently. For example, it will likely be mapped to some exceptions
    // in Java, but more likely mapped to some error codes in C.
    //
    // # Other uses
    //
    // The error model and the `Status` message can be used in a variety of
    // environments, either with or without APIs, to provide a
    // consistent developer experience across different environments.
    //
    // Example uses of this error model include:
    //
    // - Partial errors. If a service needs to return partial errors to the client,
    //     it may embed the `Status` in the normal response to indicate the partial
    //     errors.
    //
    // - Workflow errors. A typical workflow has multiple steps. Each step may
    //     have a `Status` message for error reporting purpose.
    //
    // - Batch operations. If a client uses batch request and batch response, the
    //     `Status` message should be used directly inside batch response, one for
    //     each error sub-response.
    //
    // - Asynchronous operations. If an API call embeds asynchronous operation
    //     results in its response, the status of those operations should be
    //     represented directly using the `Status` message.
    //
    // - Logging. If some API errors are stored in logs, the message `Status` could
    //     be used directly after any stripping needed for security/privacy reasons.
    message Status {
      // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      int32 code = 1;
    
      // A developer-facing error message, which should be in English. Any
      // user-facing error message should be localized and sent in the
      // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
      string message = 2;
    
      // A list of messages that carry the error details.  There will be a
      // common set of message types for APIs to use.
      repeated google.protobuf.Any details = 3;
    }