assets
Protocol buffer definition for assets
sift/assets/v1/assets.proto
Asset
| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string | ||
| name | string | ||
| organization_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_date | google.protobuf.Timestamp | ||
| modified_by_user_id | string | ||
| tags | string | repeated | The names of the tags associated with this asset. |
| metadata | sift.metadata.v1.MetadataValue | repeated | The metadata values associated with this asset. |
DeleteAssetRequest
The request for a call to AssetService_DeleteAsset to delete a single existing annotation by its asset_id.
| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string | The id of the asset to be deleted. Required. |
DeleteAssetResponse
The response of a call to AssetService_DeleteAsset.
GetAssetRequest
The request for a call to AssetService_GetAsset to retrieve a single existing asset by its asset_id.
| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string | The id of the asset to be retrieved. Required. |
GetAssetResponse
| Field | Type | Label | Description |
|---|---|---|---|
| asset | Asset |
ListAssetsRequest
The request for a call to AssetService_ListAssets.
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListAssets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssets must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are asset_id, created_by_user_id, modified_by_user_id, created_date, modified_date, name, tag_id, tag_name, and metadata. Metadata can be used in filters by using metadata.{metadata_key_name} as the field name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| order_by | string | How to order the retrieved assets. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date and modified_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date" |
ListAssetsResponse
The result of a call to AssetService_ListAssets.
UpdateAssetRequest
The request for a call to AssetService_UpdateAsset to update a single existing asset.
| Field | Type | Label | Description |
|---|---|---|---|
| asset | Asset | The asset to update. The asset's asset_id field is used to identify asset run to update and is required. | |
| update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are tags and metadata. |
UpdateAssetResponse
The response of a call to AssetService_UpdateAsset.
| Field | Type | Label | Description |
|---|---|---|---|
| asset | Asset |
AssetService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| DeleteAsset | DeleteAssetRequest | DeleteAssetResponse | Deletes an asset. |
| GetAsset | GetAssetRequest | GetAssetResponse | Retrieves an asset. |
| ListAssets | ListAssetsRequest | ListAssetsResponse | Retrieves assets using an optional filter. |
| UpdateAsset | UpdateAssetRequest | UpdateAssetResponse |