Context

com.google.api.context.Context
See theContext companion object
final case class Context(rules: Seq[ContextRule], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Context]

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 allowlist 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.

Attributes

rules

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

Companion:
object
Source:
Context.scala
Graph
Supertypes
trait Updatable[Context]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

Source:
Context.scala

Attributes

Source:
Context.scala

Attributes

Source:
Context.scala
def companion: Context.type

Attributes

Source:
Context.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
Context.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
Context.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
Context.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
Context.scala

Attributes

Source:
Context.scala
def withUnknownFields(`__v`: UnknownFieldSet): Context

Attributes

Source:
Context.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
Context.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[Context, Context] => () => Context*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala