Class Context.Builder (2.61.3) 

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 “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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Context.Builder

Implements

ContextOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

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;

Parameter
Name Description
values Iterable<? extends com.google.api.ContextRule>
Returns
Type Description
Context.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Context.Builder
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;

Parameter
Name Description
value ContextRule
Returns
Type Description
Context.Builder

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;

Parameter
Name Description
builderForValue ContextRule.Builder
Returns
Type Description
Context.Builder

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;

Parameters
Name Description
index int
value ContextRule
Returns
Type Description
Context.Builder

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;

Parameters
Name Description
index int
builderForValue ContextRule.Builder
Returns
Type Description
Context.Builder

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;

Returns
Type Description
ContextRule.Builder

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;

Parameter
Name Description
index int
Returns
Type Description
ContextRule.Builder

build()

public Context build()
Returns
Type Description
Context

buildPartial()

public Context buildPartial()
Returns
Type Description
Context

clear()

public Context.Builder clear()
Returns
Type Description
Context.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Context.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Context.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Context.Builder
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;

Returns
Type Description
Context.Builder

clone()

public Context.Builder clone()
Returns
Type Description
Context.Builder
Overrides

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
Type Description
Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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
index int
Returns
Type Description
ContextRule

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;

Parameter
Name Description
index int
Returns
Type Description
ContextRule.Builder

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;

Returns
Type Description
List<Builder>

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;

Returns
Type Description
List<ContextRule>

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
index int
Returns
Type Description
ContextRuleOrBuilder

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Context other)

public Context.Builder mergeFrom(Context other)
Parameter
Name Description
other Context
Returns
Type Description
Context.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Context.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Context.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Context.Builder
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;

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Context.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Context.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Context.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Context.Builder
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;

Parameters
Name Description
index int
value ContextRule
Returns
Type Description
Context.Builder

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;

Parameters
Name Description
index int
builderForValue ContextRule.Builder
Returns
Type Description
Context.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Context.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Context.Builder
Overrides