Send feedback
Class Context (2.28.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.28.0 keyboard_arrow_down
public final class Context extends GeneratedMessageV3 implements ContextOrBuilder
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.
Protobuf type google.api.Context
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static Context getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Context . Builder newBuilder ()
newBuilder(Context prototype)
public static Context . Builder newBuilder ( Context prototype )
Parameter Name Description prototypeContext
parseDelimitedFrom(InputStream input)
public static Context parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Context parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Context parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static Context parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static Context parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Context parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Context parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Context> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getDefaultInstanceForType()
public Context getDefaultInstanceForType ()
getParserForType()
public Parser<Context> getParserForType ()
Overrides
getRules(int index)
public ContextRule getRules ( int index )
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.ContextRule rules = 1;
Parameter Name Description indexint
getRulesCount()
public int getRulesCount ()
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.ContextRule rules = 1;
Returns Type Description int
getRulesList()
public List<ContextRule> getRulesList ()
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.ContextRule rules = 1;
getRulesOrBuilder(int index)
public ContextRuleOrBuilder getRulesOrBuilder ( int index )
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.ContextRule rules = 1;
Parameter Name Description indexint
getRulesOrBuilderList()
public List <? extends ContextRuleOrBuilder > getRulesOrBuilderList ()
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.ContextRule rules = 1;
Returns Type Description List <? extends com.google.api.ContextRuleOrBuilder >
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Context . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Context . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public Context . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-03 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-03 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-03 UTC."]]
