Class/Object

com.youtube.vitess.proto.vtrpc

CallerID

Related Docs: object CallerID | package vtrpc

Permalink

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. 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()
Linear Supertypes
Product, Equals, Updatable[CallerID], Message[CallerID], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallerID
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CallerID(principal: String = "", component: String = "", subcomponent: String = "")

    Permalink

    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.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def companion: CallerID.type

    Permalink
    Definition Classes
    CallerID → GeneratedMessage
  7. val component: String

    Permalink

    component describes the running process of the effective caller.

    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.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    CallerID → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    CallerID → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def mergeFrom(_input__: CodedInputStream): CallerID

    Permalink
    Definition Classes
    CallerID → Message
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. val principal: String

    Permalink

    principal is the effective user identifier.

    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.

  19. final def serializedSize: Int

    Permalink
    Definition Classes
    CallerID → GeneratedMessage
  20. val subcomponent: String

    Permalink

    subcomponent describes a component inisde the immediate caller which is responsible for generating is request.

    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.

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  23. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  24. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  25. def toString(): String

    Permalink
    Definition Classes
    CallerID → AnyRef → Any
  26. def update(ms: (Lens[CallerID, CallerID]) ⇒ Mutation[CallerID]*): CallerID

    Permalink
    Definition Classes
    Updatable
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withComponent(__v: String): CallerID

    Permalink
  31. def withPrincipal(__v: String): CallerID

    Permalink
  32. def withSubcomponent(__v: String): CallerID

    Permalink
  33. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage
  34. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    CallerID → GeneratedMessage
  35. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[CallerID]

Inherited from Message[CallerID]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped