Reference documentation and code samples for the Google API Common Protos Client class 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
Generated from protobuf message google.api.UsageRule
Namespace
Google \ ApiMethods
__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
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. |
↳ 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
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setAllowUnregisteredCalls
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
| 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 |
|