Class: Google::Apis::ServiceuserV1::UsageRule

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



3535
3536
3537
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3535

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) 


3516
3517
3518
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3516

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) 


3524
3525
3526
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3524

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. This flag is used by ESP to allow some Endpoints customers to bypass Google internal checks. Corresponds to the JSON property skipServiceControl

Returns:

  • (Boolean) 


3532
3533
3534
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3532

def skip_service_control
  @skip_service_control
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3540
3541
3542
3543
3544
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3540

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