final case class Context(rules: Seq[ContextRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Context] with Product with Serializable

Context defines which contexts an API requests.

Example:

context: rules:

  • selector: "*" requested:
    • google.rpc.context.ProjectContext
    • google.rpc.context.OriginContext

The above specifies that all methods in the API request google.rpc.context.ProjectContext and google.rpc.context.OriginContext.

Available context types are defined in package google.rpc.context.

This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and “x-goog-ext-<extension_id>-jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file:

Example:

context: rules:

  • selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions:
    • google.foo.v1.NewExtension allowed_response_extensions:
    • google.foo.v1.NewExtension

You can also specify extension ID instead of fully qualified extension name here.

rules

A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Context], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Context
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Context(rules: Seq[ContextRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    rules

    A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllRules(__vs: Iterable[ContextRule]): Context
  5. def addRules(__vs: ContextRule*): Context
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearRules: Context
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companion: Context.type
    Definition Classes
    Context → GeneratedMessage
  10. def discardUnknownFields: Context
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Context → GeneratedMessage
  15. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Context → GeneratedMessage
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val rules: Seq[ContextRule]
  21. def serializedSize: Int
    Definition Classes
    Context → GeneratedMessage
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    Context → GeneratedMessage
  27. val unknownFields: UnknownFieldSet
  28. def update(ms: (Lens[Context, Context]) ⇒ Mutation[Context]*): Context
    Definition Classes
    Updatable
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def withRules(__v: Seq[ContextRule]): Context
  33. def withUnknownFields(__v: UnknownFieldSet): Context
  34. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  35. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Context → GeneratedMessage
  36. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Context]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped