Class Context.Builder (2.23.1)

Version 2.23.1

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

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

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Context.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Context.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Context.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Context getDefaultInstanceForType()

Returns
Type	Description
Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Context.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Context.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Context.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)