Class Context (2.10.0)

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

Implements

ContextOrBuilder

Static Fields

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Context getDefaultInstance()
Returns
TypeDescription
Context

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Context.Builder newBuilder()
Returns
TypeDescription
Context.Builder

newBuilder(Context prototype)

public static Context.Builder newBuilder(Context prototype)
Parameter
NameDescription
prototypeContext
Returns
TypeDescription
Context.Builder

parseDelimitedFrom(InputStream input)

public static Context parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Context parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Context parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Context parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Context parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Context parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Context
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Context> parser()
Returns
TypeDescription
Parser<Context>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
TypeDescription
Context

getParserForType()

public Parser<Context> getParserForType()
Returns
TypeDescription
Parser<Context>
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
NameDescription
indexint
Returns
TypeDescription
ContextRule

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.api.ContextRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Context.Builder newBuilderForType()
Returns
TypeDescription
Context.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Context.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Context.Builder toBuilder()
Returns
TypeDescription
Context.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException