Services
RPC methods exposed by this API.ResourceAttributeService
| Method | Request | Response | Description |
|---|---|---|---|
| CreateResourceAttributeKey | CreateResourceAttributeKeyRequest | CreateResourceAttributeKeyResponse | |
| GetResourceAttributeKey | GetResourceAttributeKeyRequest | GetResourceAttributeKeyResponse | |
| ListResourceAttributeKeys | ListResourceAttributeKeysRequest | ListResourceAttributeKeysResponse | |
| UpdateResourceAttributeKey | UpdateResourceAttributeKeyRequest | UpdateResourceAttributeKeyResponse | |
| CheckResourceAttributeKeyArchiveImpact | CheckResourceAttributeKeyArchiveImpactRequest | CheckResourceAttributeKeyArchiveImpactResponse | |
| ArchiveResourceAttributeKey | ArchiveResourceAttributeKeyRequest | ArchiveResourceAttributeKeyResponse | Archives a resource_attribute key AND all its associated enum values AND all its associated resource-attributes. |
| UnarchiveResourceAttributeKey | UnarchiveResourceAttributeKeyRequest | UnarchiveResourceAttributeKeyResponse | Unarchives a resource_attribute key BUT NOT its associated enum values OR resource-attributes. |
| BatchArchiveResourceAttributeKeys | BatchArchiveResourceAttributeKeysRequest | BatchArchiveResourceAttributeKeysResponse | Archives multiple resource_attribute keys AND all their associated enum values AND all their associated resource-attributes. |
| BatchUnarchiveResourceAttributeKeys | BatchUnarchiveResourceAttributeKeysRequest | BatchUnarchiveResourceAttributeKeysResponse | Unarchives multiple resource_attribute keys BUT NOT their associated enum values OR resource-attributes. |
| CreateResourceAttributeEnumValue | CreateResourceAttributeEnumValueRequest | CreateResourceAttributeEnumValueResponse | |
| GetResourceAttributeEnumValue | GetResourceAttributeEnumValueRequest | GetResourceAttributeEnumValueResponse | |
| ListResourceAttributeEnumValues | ListResourceAttributeEnumValuesRequest | ListResourceAttributeEnumValuesResponse | |
| UpdateResourceAttributeEnumValue | UpdateResourceAttributeEnumValueRequest | UpdateResourceAttributeEnumValueResponse | |
| ArchiveResourceAttributeEnumValue | ArchiveResourceAttributeEnumValueRequest | ArchiveResourceAttributeEnumValueResponse | Archives an enum value and migrates all resource-attributes with that value to a replacement value. |
| UnarchiveResourceAttributeEnumValue | UnarchiveResourceAttributeEnumValueRequest | UnarchiveResourceAttributeEnumValueResponse | Unarchives an enum value BUT DOES NOT migrate resource-attributes with a replacement value back to the original value. |
| BatchArchiveResourceAttributeEnumValues | BatchArchiveResourceAttributeEnumValuesRequest | BatchArchiveResourceAttributeEnumValuesResponse | Archives multiple enum values and migrates all resource-attributes with those values to their respective replacement values. |
| BatchUnarchiveResourceAttributeEnumValues | BatchUnarchiveResourceAttributeEnumValuesRequest | BatchUnarchiveResourceAttributeEnumValuesResponse | Unarchives multiple enum values BUT DOES NOT migrate resource-attributes with a replacement value back to the original value. |
| BatchCreateResourceAttributes | BatchCreateResourceAttributesRequest | BatchCreateResourceAttributesResponse | Creates resource-attributes for multiple entities with the same key-value pair. |
| GetResourceAttribute | GetResourceAttributeRequest | GetResourceAttributeResponse | |
| ListResourceAttributes | ListResourceAttributesRequest | ListResourceAttributesResponse | |
| ListResourceAttributesByEntity | ListResourceAttributesByEntityRequest | ListResourceAttributesByEntityResponse | Lists all resource-attributes for a specific entity. Excludes archived by default. |
| BatchListResourceAttributesByEntity | BatchListResourceAttributesByEntityRequest | BatchListResourceAttributesByEntityResponse | Batch lists all resource-attributes for multiple entities. Excludes archived by default. |
| ArchiveResourceAttribute | ArchiveResourceAttributeRequest | ArchiveResourceAttributeResponse | |
| UnarchiveResourceAttribute | UnarchiveResourceAttributeRequest | UnarchiveResourceAttributeResponse | |
| BatchArchiveResourceAttributes | BatchArchiveResourceAttributesRequest | BatchArchiveResourceAttributesResponse | Archives multiple resource-attributes. |
| BatchUnarchiveResourceAttributes | BatchUnarchiveResourceAttributesRequest | BatchUnarchiveResourceAttributesResponse | Unarchives multiple resource-attributes. |
Messages
Data models used across requests/responses.ArchiveResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
|---|---|---|---|
| archived_enum_value_id | string | ||
| replacement_enum_value_id | string | When the archived_enum_value_id is archived all resource-attributes that reference it will be migrated to the replacement_enum_value_id if provided. Otherwise, resource-attributes that reference it will be archived as well. |
ArchiveResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attributes_migrated | int32 | Total number of resource-attributes migrated or archived by this operation. When a replacement enum value is provided, this represents attributes migrated to the new value. When no replacement is provided, this represents attributes that were archived. |
ArchiveResourceAttributeKeyRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string |
ArchiveResourceAttributeKeyResponse
This message has no fields.ArchiveResourceAttributeRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_id | string |
ArchiveResourceAttributeResponse
This message has no fields.BatchArchiveResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| archival_requests | BatchArchiveResourceAttributeEnumValuesRequest.EnumValueArchival | repeated |
BatchArchiveResourceAttributeEnumValuesRequest.EnumValueArchival
| Field | Type | Label | Description |
|---|---|---|---|
| archived_enum_value_id | string | The enum value ID to archive. | |
| replacement_enum_value_id | string | When the archived_enum_value_id is archived all resource-attributes that reference it will be migrated to the replacement_enum_value_id if provided. Otherwise, resource-attributes that reference it will be archived as well. |
BatchArchiveResourceAttributeEnumValuesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| total_resource_attributes_migrated | int32 | Total number of resource-attributes migrated or archived across all enum value operations. This includes both attributes migrated to replacement values and attributes archived without replacement. |
BatchArchiveResourceAttributeKeysRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_ids | string | repeated |
BatchArchiveResourceAttributeKeysResponse
This message has no fields.BatchArchiveResourceAttributesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_ids | string | repeated |
BatchArchiveResourceAttributesResponse
This message has no fields.BatchCreateResourceAttributesRequest
ResourceAttribute RPC messages| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string | ||
| oneof value. resource_attribute_enum_value_id | string | For ENUM type: exactly one enum value ID. | |
| oneof value. resource_attribute_enum_value_ids | ResourceAttributeEnumValueIdList | For SET_OF_ENUM type: one or more enum value IDs representing the complete desired set. Omitted enum values that are currently active for each entity+key will be archived. | |
| oneof value. boolean_value | bool | ||
| oneof value. number_value | int64 | ||
| entities | ResourceAttributeEntityIdentifier | repeated |
BatchCreateResourceAttributesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attributes | ResourceAttribute | repeated |
BatchListResourceAttributesByEntityRequest
| Field | Type | Label | Description |
|---|---|---|---|
| entities | ResourceAttributeEntityIdentifier | repeated | |
| include_archived | bool | Whether to include archived resource-attributes. Defaults to false. |
BatchListResourceAttributesByEntityResponse
| Field | Type | Label | Description |
|---|---|---|---|
| results | BatchListResourceAttributesByEntityResponse.EntityResourceAttributes | repeated |
BatchListResourceAttributesByEntityResponse.EntityResourceAttributes
| Field | Type | Label | Description |
|---|---|---|---|
| entity | ResourceAttributeEntityIdentifier | The entity the attributes belong to | |
| resource_attributes | ResourceAttribute | repeated | All resource-attributes for this entity |
BatchUnarchiveResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value_ids | string | repeated |
BatchUnarchiveResourceAttributeEnumValuesResponse
This message has no fields.BatchUnarchiveResourceAttributeKeysRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_ids | string | repeated |
BatchUnarchiveResourceAttributeKeysResponse
This message has no fields.BatchUnarchiveResourceAttributesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_ids | string | repeated |
BatchUnarchiveResourceAttributesResponse
This message has no fields.CheckResourceAttributeKeyArchiveImpactRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string |
CheckResourceAttributeKeyArchiveImpactResponse
| Field | Type | Label | Description |
|---|---|---|---|
| active_resource_attribute_assignment_count | int64 | The number of active resource attribute assignments that will be affected by archiving this key. |
CreateResourceAttributeEnumValueRequest
ResourceAttribute Enum Value RPC messages| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string | ||
| display_name | string | ||
| description | string |
CreateResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value | ResourceAttributeEnumValue |
CreateResourceAttributeKeyRequest
ResourceAttribute Key RPC messages| Field | Type | Label | Description |
|---|---|---|---|
| display_name | string | ||
| description | string | ||
| type | ResourceAttributeKeyType | ||
| initial_enum_values | CreateResourceAttributeKeyRequest.InitialEnumValue | repeated | Optional initial enum values to create alongside the key. Only applicable for ENUM type keys. |
CreateResourceAttributeKeyRequest.InitialEnumValue
Nested message for initial enum values in create requests.| Field | Type | Label | Description |
|---|---|---|---|
| display_name | string | ||
| description | string |
CreateResourceAttributeKeyResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key | ResourceAttributeKey | ||
| enum_values | ResourceAttributeEnumValue | repeated | The enum values created alongside the key, if any were provided in the request. |
GetResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value_id | string |
GetResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value | ResourceAttributeEnumValue |
GetResourceAttributeKeyRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string |
GetResourceAttributeKeyResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key | ResourceAttributeKey |
GetResourceAttributeRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_id | string |
GetResourceAttributeResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute | ResourceAttribute |
ListResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string | ||
| page_size | uint32 | The maximum number of enum values to return. The service may return fewer than this value. If unspecified, at most 50 enum values will be returned. The maximum value is 100; values above 100 will be coerced to 100. | |
| page_token | string | A page token, received from a previous ListResourceAttributeEnumValues call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourceAttributeEnumValues must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are resource_attribute_enum_value_id, name, description, created_by_user_id, modified_by_user_id, created_date, and modified_date. Archive state is controlled via the include_archived field below, not via filter. For further information about how to use CELs, please refer to this guide. | |
| order_by | string | How to order the retrieved enum values. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date, modified_date, and name. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: “name,created_date desc” | |
| include_archived | bool | Whether to include archived enum values. Defaults to false. |
ListResourceAttributeEnumValuesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_values | ResourceAttributeEnumValue | repeated | |
| next_page_token | string |
ListResourceAttributeKeysRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of resource_attribute keys to return. The service may return fewer than this value. If unspecified, at most 50 resource_attribute keys will be returned. The maximum value is 100; values above 100 will be coerced to 100. | |
| page_token | string | A page token, received from a previous ListResourceAttributeKeys call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourceAttributeKeys must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are resource_attribute_key_id, name, description, key_type, and created_date. Archive state is controlled via the include_archived field below, not via filter. For further information about how to use CELs, please refer to this guide. | |
| order_by | string | How to order the retrieved resource_attribute keys. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date, modified_date, and name. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,name” | |
| include_archived | bool | Whether to include archived resource_attribute keys. Defaults to false. |
ListResourceAttributeKeysResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_keys | ResourceAttributeKey | repeated | |
| next_page_token | string |
ListResourceAttributesByEntityRequest
| Field | Type | Label | Description |
|---|---|---|---|
| entity | ResourceAttributeEntityIdentifier | ||
| include_archived | bool | Whether to include archived resource-attributes. Defaults to false. | |
| page_size | uint32 | The maximum number of resource-attributes to return. The service may return fewer than this value. If unspecified, at most 50 resource-attributes will be returned. The maximum value is 100; values above 100 will be coerced to 100. | |
| page_token | string | A page token, received from a previous ListResourceAttributesByEntity call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourceAttributesByEntity must match the call that provided the page token. |
ListResourceAttributesByEntityResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attributes | ResourceAttribute | repeated | |
| next_page_token | string |
ListResourceAttributesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of resource-attributes to return. The service may return fewer than this value. If unspecified, at most 50 resource-attributes will be returned. The maximum value is 100; values above 100 will be coerced to 100. | |
| page_token | string | A page token, received from a previous ListResourceAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourceAttributes must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are resource_attribute_id, entity_id, entity_type, resource_attribute_key_id, resource_attribute_enum_value_id, boolean_value, number_value, created_by_user_id, and created_date. Archive state is controlled via the include_archived field below, not via filter. For further information about how to use CELs, please refer to this guide. | |
| order_by | string | How to order the retrieved resource-attributes. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date and entity.entity_id. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: “entity.entity_id,created_date desc” | |
| include_archived | bool | Whether to include archived resource-attributes. Defaults to false. |
ListResourceAttributesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attributes | ResourceAttribute | repeated | |
| next_page_token | string |
ResourceAttribute
Represents the assignment of a resource_attribute key-value pair to an entity (asset or channel).| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_id | string | ||
| organization_id | string | ||
| entity | ResourceAttributeEntityIdentifier | ||
| resource_attribute_key_id | string | ||
| key | ResourceAttributeKey | Populated in responses with full key details. | |
| oneof value. resource_attribute_enum_value_id | string | ||
| oneof value. boolean_value | bool | ||
| oneof value. number_value | int64 | ||
| enum_value_details | ResourceAttributeEnumValue | Populated in responses with full enum value details. | |
| created_date | google.protobuf.Timestamp | The timestamp when the relation between the Entity and ResourceAttribute Key and Value was created. | |
| created_by_user_id | string | ||
| archived_date | google.protobuf.Timestamp | ||
| is_archived | bool | Whether or not the resource attribute is archived. This is inferred from whether archived_date is set. |
ResourceAttributeEntityIdentifier
Represents an entity to which a resource_attribute will be assigned.| Field | Type | Label | Description |
|---|---|---|---|
| entity_id | string | ||
| entity_type | ResourceAttributeEntityType |
ResourceAttributeEnumValue
Represents a possible enumerable value for ENUM type resource_attribute keys. Users can add new enum values as needed.| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value_id | string | ||
| resource_attribute_key_id | string | ||
| display_name | string | ||
| description | string | ||
| created_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_date | google.protobuf.Timestamp | ||
| modified_by_user_id | string | ||
| archived_date | google.protobuf.Timestamp | ||
| is_archived | bool | Whether or not the enum value is archived. This is inferred from whether archived_date is set. |
ResourceAttributeEnumValueIdList
| Field | Type | Label | Description |
|---|---|---|---|
| ids | string | repeated |
ResourceAttributeKey
A ResourceAttribute Key defines an attribute that can be assigned to Entities for the purpose of attribute based access control (ABAC).| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string | ||
| organization_id | string | ||
| display_name | string | ||
| description | string | ||
| type | ResourceAttributeKeyType | ||
| created_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_date | google.protobuf.Timestamp | ||
| modified_by_user_id | string | ||
| archived_date | google.protobuf.Timestamp | ||
| is_archived | bool | Whether or not the key is archived. This is inferred from whether archived_date is set. |
UnarchiveResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value_id | string |
UnarchiveResourceAttributeEnumValueResponse
This message has no fields.UnarchiveResourceAttributeKeyRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string |
UnarchiveResourceAttributeKeyResponse
This message has no fields.UnarchiveResourceAttributeRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_id | string |
UnarchiveResourceAttributeResponse
This message has no fields.UpdateResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value_id | string | ||
| display_name | string | ||
| description | string | ||
| update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are description and archived_date. |
UpdateResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_enum_value | ResourceAttributeEnumValue |
UpdateResourceAttributeKeyRequest
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key_id | string | ||
| display_name | string | ||
| description | string | ||
| update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are description and archived_date. |
UpdateResourceAttributeKeyResponse
| Field | Type | Label | Description |
|---|---|---|---|
| resource_attribute_key | ResourceAttributeKey |
Enums
Allowed constant values used in message fields.ResourceAttributeEntityType
| Name | Number | Description |
|---|---|---|
| RESOURCE_ATTRIBUTE_ENTITY_TYPE_UNSPECIFIED | 0 | |
| RESOURCE_ATTRIBUTE_ENTITY_TYPE_ASSET | 1 | |
| RESOURCE_ATTRIBUTE_ENTITY_TYPE_CHANNEL | 2 | |
| RESOURCE_ATTRIBUTE_ENTITY_TYPE_RUN | 3 |
ResourceAttributeKeyType
Values become selectable enumerable options.| Name | Number | Description |
|---|---|---|
| RESOURCE_ATTRIBUTE_KEY_TYPE_UNSPECIFIED | 0 | |
| RESOURCE_ATTRIBUTE_KEY_TYPE_ENUM | 1 | |
| RESOURCE_ATTRIBUTE_KEY_TYPE_BOOLEAN | 2 | |
| RESOURCE_ATTRIBUTE_KEY_TYPE_NUMBER | 3 | |
| RESOURCE_ATTRIBUTE_KEY_TYPE_SET_OF_ENUM | 4 |