Class: Google::Apis::ServiceusageV1beta1::UsageRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1beta1/classes.rb,
lib/google/apis/serviceusage_v1beta1/representations.rb,
lib/google/apis/serviceusage_v1beta1/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UsageRule

Returns a new instance of UsageRule.



5225
5226
5227
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 5225

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

Returns:

  • (Boolean) 


5207
5208
5209
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 5207

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

Returns:

  • (String) 


5214
5215
5216
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 5214

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

Returns:

  • (Boolean) 


5222
5223
5224
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 5222

def skip_service_control
  @skip_service_control
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5230
5231
5232
5233
5234
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 5230

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