Reference documentation and code samples for the Google Cloud Api Keys V2 Client class Restrictions.
Describes the restrictions on the key.
Generated from protobuf message google.api.apikeys.v2.Restrictions
Namespace
Google \ Cloud \ ApiKeys \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ browser_key_restrictions |
BrowserKeyRestrictions
The HTTP referrers (websites) that are allowed to use the key. |
↳ server_key_restrictions |
ServerKeyRestrictions
The IP addresses of callers that are allowed to use the key. |
↳ android_key_restrictions |
AndroidKeyRestrictions
The Android apps that are allowed to use the key. |
↳ ios_key_restrictions |
IosKeyRestrictions
The iOS apps that are allowed to use the key. |
↳ api_targets |
array<ApiTarget>
A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed. |
getBrowserKeyRestrictions
The HTTP referrers (websites) that are allowed to use the key.
| Returns | |
|---|---|
| Type | Description |
BrowserKeyRestrictions|null |
|
hasBrowserKeyRestrictions
setBrowserKeyRestrictions
The HTTP referrers (websites) that are allowed to use the key.
| Parameter | |
|---|---|
| Name | Description |
var |
BrowserKeyRestrictions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServerKeyRestrictions
The IP addresses of callers that are allowed to use the key.
| Returns | |
|---|---|
| Type | Description |
ServerKeyRestrictions|null |
|
hasServerKeyRestrictions
setServerKeyRestrictions
The IP addresses of callers that are allowed to use the key.
| Parameter | |
|---|---|
| Name | Description |
var |
ServerKeyRestrictions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAndroidKeyRestrictions
The Android apps that are allowed to use the key.
| Returns | |
|---|---|
| Type | Description |
AndroidKeyRestrictions|null |
|
hasAndroidKeyRestrictions
setAndroidKeyRestrictions
The Android apps that are allowed to use the key.
| Parameter | |
|---|---|
| Name | Description |
var |
AndroidKeyRestrictions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIosKeyRestrictions
The iOS apps that are allowed to use the key.
| Returns | |
|---|---|
| Type | Description |
IosKeyRestrictions|null |
|
hasIosKeyRestrictions
setIosKeyRestrictions
The iOS apps that are allowed to use the key.
| Parameter | |
|---|---|
| Name | Description |
var |
IosKeyRestrictions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiTargets
A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setApiTargets
A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ApiTarget>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientRestrictions
| Returns | |
|---|---|
| Type | Description |
string |
|