Class Context (2.17.0)

 public sealed class Context : IMessage<Context>, IEquatable<Context>, IDeepCloneable<Context>, IBufferMessage, IMessage 

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.

Inheritance

object > Context

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Context()

 public Context() 

Context(Context)

 public Context(Context other) 
Parameter
Name
Description
other

Fields

RulesFieldNumber

  public 
  
 const 
  
 int 
  
 RulesFieldNumber 
  
 = 
  
 1 
 

Field number for the "rules" field.

Field Value
Type
Description
int

Properties

Descriptor

 public static MessageDescriptor Descriptor { get; } 
Property Value
Type
Description

Parser

 public static MessageParser<Context> Parser { get; } 
Property Value
Type
Description

Rules

 public RepeatedField<ContextRule> Rules { get; } 

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

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

Property Value
Type
Description

Methods

CalculateSize()

 public int CalculateSize() 
Returns
Type
Description
int

Clone()

 public Context Clone() 
Returns
Type
Description

Equals(Context)

 public bool Equals(Context other) 
Parameter
Name
Description
other
Returns
Type
Description

Equals(object)

 public override bool Equals(object other) 
Parameter
Name
Description
other
Returns
Type
Description
Overrides

GetHashCode()

 public override int GetHashCode() 
Returns
Type
Description
int
Overrides

MergeFrom(Context)

 public void MergeFrom(Context other) 
Parameter
Name
Description
other

MergeFrom(CodedInputStream)

 public void MergeFrom(CodedInputStream input) 
Parameter
Name
Description

ToString()

 public override string ToString() 
Returns
Type
Description
Overrides

WriteTo(CodedOutputStream)

 public void WriteTo(CodedOutputStream output) 
Parameter
Name
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: