Class: Google::Apis::ServicemanagementV1::UsageRule

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UsageRule

Returns a new instance of UsageRule



4506
4507
4508
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4506

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_unregistered_calls ⇒ Boolean Also known as: allow_unregistered_calls?

True, if the method allows unregistered calls; false otherwise. Corresponds to the JSON property allowUnregisteredCalls

Returns:

  • (Boolean) 


4489
4490
4491
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4489

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) 


4497
4498
4499
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4497

def selector
  @selector
end

#skip_service_control ⇒ Boolean Also known as: skip_service_control?

True, if the method should skip service control. If so, no control plane feature (like quota and billing) will be enabled. Corresponds to the JSON property skipServiceControl

Returns:

  • (Boolean) 


4503
4504
4505
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4503

def skip_service_control
  @skip_service_control
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4511
4512
4513
4514
4515
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4511

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