Send feedback
Class Context (2.8.4) Stay organized with collections
Save and categorize content based on your preferences.
Version 2.8.4 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 \u201cx-goog-ext-<extension_id>-bin\u201d and
\u201cx-goog-ext-<extension_id>-jspb\u201d 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
Static Fields
RULES_FIELD_NUMBER
public
static
final
int
RULES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Context
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Context
.
Builder
newBuilder
()
Returns
newBuilder(Context prototype)
public
static
Context
.
Builder
newBuilder
(
Context
prototype
)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public
static
Context
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Context
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Context
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public
static
Context
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public
static
Context
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Context
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Context
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Context>
parser
()
Returns
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public
Context
getDefaultInstanceForType
()
Returns
getParserForType()
public
Parser<Context>
getParserForType
()
Returns
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
Returns
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
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;
Returns
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
Returns
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
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Context
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Context
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Context
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
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 2025-09-04 UTC.
Need to tell us more?
[[["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 2025-09-04 UTC."],[],[],null,[]]
