Class: Google::Apis::ServicemanagementV1::UsageRule
- Inherits:
-
Object
- Object
- Google::Apis::ServicemanagementV1::UsageRule
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicemanagement_v1/classes.rb,
generated/google/apis/servicemanagement_v1/representations.rb,
generated/google/apis/servicemanagement_v1/representations.rb
Overview
Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules:
- selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules:
- selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true
Instance Attribute Summary collapse
-
#allow_unregistered_calls ⇒ Boolean
(also: #allow_unregistered_calls?)
If true, the selected method allows unregistered calls, e.g.
-
#selector ⇒ String
Selects the methods to which this rule applies.
-
#skip_service_control ⇒ Boolean
(also: #skip_service_control?)
If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available.
Instance Method Summary collapse
-
#initialize(**args) ⇒ UsageRule
constructor
A new instance of UsageRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ UsageRule
Returns a new instance of UsageRule
4492 4493 4494 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4492 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allow_unregistered_calls ⇒ Boolean Also known as: allow_unregistered_calls?
If true, the selected method allows unregistered calls, e.g. calls
that don't identify any user or application.
Corresponds to the JSON property allowUnregisteredCalls
4473 4474 4475 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4473 def allow_unregistered_calls @allow_unregistered_calls end |
#selector ⇒ String
Selects the methods to which this rule applies. Use '*' to indicate all
methods in all APIs.
Refer to selector for syntax details.
Corresponds to the JSON property selector
4481 4482 4483 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4481 def selector @selector end |
#skip_service_control ⇒ Boolean Also known as: skip_service_control?
If true, the selected method should skip service control and the control
plane features, such as quota and billing, will not be available.
This flag is used by Google Cloud Endpoints to bypass checks for internal
methods, such as service health check methods.
Corresponds to the JSON property skipServiceControl
4489 4490 4491 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4489 def skip_service_control @skip_service_control end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4497 4498 4499 4500 4501 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4497 def update!(**args) @allow_unregistered_calls = args[:allow_unregistered_calls] if args.key?(:allow_unregistered_calls) @selector = args[:selector] if args.key?(:selector) @skip_service_control = args[:skip_service_control] if args.key?(:skip_service_control) end |