Reference documentation and code samples for the Service Management V1 API class Google::Api::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#rules
def rules() -> ::Array<::Google::Api::ContextRule>
-
(::Array<::Google::Api::ContextRule>) — A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
#rules=
def rules=(value) -> ::Array<::Google::Api::ContextRule>
-
value (::Array<::Google::Api::ContextRule>) — A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
-
(::Array<::Google::Api::ContextRule>) — A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.