Google API Common Protos Client - Class UsageRule (4.14.0)

Reference documentation and code samples for the Google API Common Protos Client class UsageRule.

Usage configuration rules for the service.

Generated from protobuf message google.api.UsageRule

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ selector
string

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.

↳ allow_unregistered_calls
bool

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). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.

↳ skip_service_control
bool

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.

getSelector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

Refer to selector for syntax details.

Returns
Type
Description
string

setSelector

Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.

Refer to selector for syntax details.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAllowUnregisteredCalls

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). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.

Returns
Type
Description
bool

setAllowUnregisteredCalls

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). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSkipServiceControl

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
Type
Description
bool

setSkipServiceControl

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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: