entitlements
Creates, updates, deletes, gets or lists an entitlements resource.
Overview
| Name | entitlements |
| Type | Resource |
| Id | google.apim.entitlements |
Fields
The following fields are returned by SELECT queries:
- get_entitlement
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. The entitlement resource name projects/{project}/locations/{location}/entitlement |
apiObservationEntitled | boolean | Whether API Observation is entitled. |
billingProjectNumber | string (int64) | Project number of associated billing project that has Apigee and Advanced API Security entitled. |
createTime | string (google-datetime) | Output only. The time of the entitlement creation. |
updateTime | string (google-datetime) | Output only. The time of the entitlement update. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_entitlement | select | projectsId, locationsId | GetEntitlement returns the entitlement for the provided project. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
locationsId | string | |
projectsId | string |
SELECT examples
- get_entitlement
GetEntitlement returns the entitlement for the provided project.
SELECT
name,
apiObservationEntitled,
billingProjectNumber,
createTime,
updateTime
FROM google.apim.entitlements
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;