public static final class Context.Builder extends GeneratedMessageV3.Builder<Context.Builder> 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 Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addAllRules(Iterable<? extends ContextRule> values)
public Context.Builder addAllRules(Iterable<? extends ContextRule> values)
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;
| Name | Description |
| values | Iterable<? extends com.google.api.ContextRule>
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
addRules(ContextRule value)
public Context.Builder addRules(ContextRule value)
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;
addRules(ContextRule.Builder builderForValue)
public Context.Builder addRules(ContextRule.Builder builderForValue)
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;
addRules(int index, ContextRule value)
public Context.Builder addRules(int index, ContextRule value)
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;
addRules(int index, ContextRule.Builder builderForValue)
public Context.Builder addRules(int index, ContextRule.Builder builderForValue)
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;
addRulesBuilder()
public ContextRule.Builder addRulesBuilder()
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;
addRulesBuilder(int index)
public ContextRule.Builder addRulesBuilder(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;
build()
Returns
buildPartial()
public Context buildPartial()
Returns
clear()
public Context.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public Context.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearRules()
public Context.Builder clearRules()
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;
clone()
public Context.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Context getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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;
getRulesBuilder(int index)
public ContextRule.Builder getRulesBuilder(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;
getRulesBuilderList()
public List<ContextRule.Builder> getRulesBuilderList()
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.api.ContextRuleOrBuilder> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Context other)
public Context.Builder mergeFrom(Context other)
Parameter
Returns
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Context.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
removeRules(int index)
public Context.Builder removeRules(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;
setField(Descriptors.FieldDescriptor field, Object value)
public Context.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Context.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setRules(int index, ContextRule value)
public Context.Builder setRules(int index, ContextRule value)
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;
setRules(int index, ContextRule.Builder builderForValue)
public Context.Builder setRules(int index, ContextRule.Builder builderForValue)
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;
setUnknownFields(UnknownFieldSet unknownFields)
public final Context.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
