Class: Google::Apis::ServiceusageV1::Context
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1::Context
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb
Overview
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
andgoogle.rpc.context.OriginContext
. Available context types are defined in packagegoogle.rpc.context
. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext- -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.
Instance Attribute Summary collapse
-
#rules ⇒ Array<Google::Apis::ServiceusageV1::ContextRule>
A list of RPC context rules that apply to individual API methods.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Context
constructor
A new instance of Context.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Context
Returns a new instance of Context
596 597 598 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 596 def initialize(**args) update!(**args) end |
Instance Attribute Details
#rules ⇒ Array<Google::Apis::ServiceusageV1::ContextRule>
A list of RPC context rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
Corresponds to the JSON property rules
594 595 596 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 594 def rules @rules end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
601 602 603 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 601 def update!(**args) @rules = args[:rules] if args.key?(:rules) end |