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

Inherits:

Object

• Object
• Google::Apis::ServiceuserV1::UsageRule

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

• #allow_unregistered_calls ⇒ Boolean (also: #allow_unregistered_calls?)

  True, if the method allows unregistered calls; false otherwise.

• #selector ⇒ String

  Selects the methods to which this rule applies.

Instance Method Summary

• #initialize(**args) ⇒ UsageRule constructor

  A new instance of UsageRule.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1921

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)

# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1918

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)

# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1913

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1926

def update!(**args)
  @selector = args[:selector] if args.key?(:selector)
  @allow_unregistered_calls = args[:allow_unregistered_calls] if args.key?(:allow_unregistered_calls)
end