effective_tags
Creates, updates, deletes, gets or lists an effective_tags
resource.
Overview
Name | effective_tags |
Type | Resource |
Id | google.cloudresourcemanager.effective_tags |
Fields
The following fields are returned by SELECT
queries:
- list
Successful response
Name | Datatype | Description |
---|---|---|
inherited | boolean | Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false. |
namespacedTagKey | string | The namespaced name of the TagKey. Can be in the form {organization_id}/{tag_key_short_name} or {project_id}/{tag_key_short_name} or {project_number}/{tag_key_short_name} . |
namespacedTagValue | string | The namespaced name of the TagValue. Can be in the form {organization_id}/{tag_key_short_name}/{tag_value_short_name} or {project_id}/{tag_key_short_name}/{tag_value_short_name} or {project_number}/{tag_key_short_name}/{tag_value_short_name} . |
tagKey | string | The name of the TagKey, in the format tagKeys/{id} , such as tagKeys/123 . |
tagKeyParentName | string | The parent name of the tag key. Must be in the format organizations/{organization_id} or projects/{project_number} |
tagValue | string | Resource name for TagValue in the format tagValues/456 . |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | parent , pageSize , pageToken | Return a list of effective tags for the given Google Cloud resource, as specified in parent . |
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 |
---|---|---|
pageSize | integer (int32) | |
pageToken | string | |
parent | string |
SELECT
examples
- list
Return a list of effective tags for the given Google Cloud resource, as specified in parent
.
SELECT
inherited,
namespacedTagKey,
namespacedTagValue,
tagKey,
tagKeyParentName,
tagValue
FROM google.cloudresourcemanager.effective_tags
WHERE parent = '{{ parent }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';