vtrpc

Type Members

1. final case class CallerID(principal: String = "", component: String = "", subcomponent: String = "") extends GeneratedMessage with Message[CallerID] with Updatable[CallerID] with Product with Serializable

   

   CallerID is passed along RPCs to identify the originating client for a request.

   CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes.

   principal

   principal is the effective user identifier. It is usually filled in with whoever made the request to the appserver, if the request came from an automated job or another system component. If the request comes directly from the Internet, or if the Vitess client takes action on its own accord, it is okay for this field to be absent.

   component

   component describes the running process of the effective caller. It can for instance be the hostname:port of the servlet initiating the database call, or the container engine ID used by the servlet.

   subcomponent

   subcomponent describes a component inisde the immediate caller which is responsible for generating is request. Suggested values are a servlet name or an API endpoint name.

   Annotations

   @SerialVersionUID()

2. sealed trait Code extends GeneratedEnum

   

3. sealed trait LegacyErrorCode extends GeneratedEnum

   

4. final case class RPCError(legacyCode: LegacyErrorCode = ..., message: String = "", code: Code = ...) extends GeneratedMessage with Message[RPCError] with Updatable[RPCError] with Product with Serializable

   

   RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate).

   RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code.

   Annotations

   @SerialVersionUID()