Package com.google.api

Class Context.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>
com.google.api.Context.Builder
All Implemented Interfaces:
ContextOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Context
public static final class Context.Builder extends com.google.protobuf.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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • clear

      public Context.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • getDefaultInstanceForType

      public Context getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Context build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Context buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Context.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • setField

      public Context.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • clearField

      public Context.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • clearOneof

      public Context.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • setRepeatedField

      public Context.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • addRepeatedField

      public Context.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • mergeFrom

      public Context.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Context.Builder>

    • mergeFrom

      public Context.Builder mergeFrom(Context other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • mergeFrom

      public Context.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Context.Builder>
      Throws:
      IOException

    • 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;
      Specified by:
      getRulesList in interface ContextOrBuilder

    • 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;
      Specified by:
      getRulesCount in interface ContextOrBuilder

    • getRules

      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;
      Specified by:
      getRules in interface ContextOrBuilder

    • setRules

      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

      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;

    • addRules

      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

      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

      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

      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;

    • addAllRules

      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;

    • 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;

    • removeRules

      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;

    • getRulesBuilder

      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;

    • getRulesOrBuilder

      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;
      Specified by:
      getRulesOrBuilder in interface ContextOrBuilder

    • 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;
      Specified by:
      getRulesOrBuilderList in interface ContextOrBuilder

    • 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

      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;

    • 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;

    • setUnknownFields

      public final Context.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>

    • mergeUnknownFields

      public final Context.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Context.Builder>