Google API Common Protos Client - Class Context (4.12.4)

Reference documentation and code samples for the Google API Common Protos Client class 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.

Generated from protobuf message google.api.Context

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ rules array<ContextRule>

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

getRules

A list of RPC context rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRules

A list of RPC context rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Parameter
Name Description
var array<ContextRule>
Returns
Type Description
$this