resource_ref
Protocol buffer definition for resource_ref
sift/common/type/v1/resource_ref.proto
FindResourceBy
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | Find by the resource's global id, e.g. asset_id, run_id, report_id. | |
| client_key | string | Find by the resource's client_key, if available. | |
| name | string | Find by the resource's name. If multiple resources are found with the same name, an error will be returned. | |
| organization_id | string | When finding by client_key or name, the organization_id should also be specified. Only required if the user belongs to more than one organization. |
ResourceRef
ResourceRef is meant to be embedded as a field in other resources. It's used by one resource to point to another resource.
In a request, use the find_by field to select a resource to point to.
In a response, the fields marked google.api.field_behavior = OUTPUT_ONLY will be populated by the backend.
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | The global unique id of the resource, e.g. the asset_id, run_id, or report_id. | |
| client_key | string | optional | If a resource has a client_key associated with it, it will be included. |
| name | string | The name of the resource. | |
| find_by | FindResourceBy | Use this field to 'construct' a ResourceRef. You can give just the name, id, or client_key and the backend will find the resource you're referring to. |