http4s-grpc-google-common-protos
2.18.0+0.0.5
API
Generated with
http4s-grpc-google-common-protos/com.google.api.context

com.google.api.context

package com.google.api.context

Members list

Concise view

Type members

Classlikes

final case class Context(rules: Seq[ContextRule], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Context]

Context defines which contexts an API requests.

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
object Context extends GeneratedMessageCompanion[Context]

Attributes

Companion:
class
Source:
Context.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Context]
trait Serializable
class Object
trait Matchable
class Any
Self type
Context.type
object ContextProto extends GeneratedFileObject

Attributes

Source:
ContextProto.scala
Graph
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ContextRule(selector: String, requested: Seq[String], provided: Seq[String], allowedRequestExtensions: Seq[String], allowedResponseExtensions: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ContextRule]

A context rule provides information about the context for an individual API element.

A context rule provides information about the context for an individual API element.

Attributes

allowedRequestExtensions

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided

A list of full type names of provided contexts.

requested

A list of full type names of requested contexts.

selector

Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

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

Attributes

Companion:
class
Source:
ContextRule.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ContextRule]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with