Service Usage V1 API - Class Google::Api::UsageRule (v0.2.1)

Version 0.2.1

• 1.1.0 (latest)
• 1.0.1
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.1
• 0.1.4

Reference documentation and code samples for the Service Usage V1 API class Google::Api::UsageRule.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_unregistered_calls

def allow_unregistered_calls() -> ::Boolean

Returns

• (::Boolean) — If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

#allow_unregistered_calls=

def allow_unregistered_calls=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

Returns

• (::Boolean) — If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.

#selector

def selector() -> ::String

Returns

• (::String) — Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

  Refer to selector for syntax details.

#selector=

def selector=(value) -> ::String

Parameter

• value (::String) — Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

  Refer to selector for syntax details.

Returns

• (::String) — Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

  Refer to selector for syntax details.

#skip_service_control

def skip_service_control() -> ::Boolean

Returns

• (::Boolean) — 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.

#skip_service_control=

def skip_service_control=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.