assets

Protocol buffer definition for assets

sift/assets/v1/assets.proto

Asset

FieldTypeLabelDescription
asset_idstring
namestring
organization_idstring
created_dategoogle.protobuf.Timestamp
created_by_user_idstring
modified_dategoogle.protobuf.Timestamp
modified_by_user_idstring
tagsstringrepeatedThe names of the tags to associate with this asset.

DeleteAssetRequest

The request for a call to AssetService_DeleteAsset to delete a single existing annotation by its asset_id.

FieldTypeLabelDescription
asset_idstringThe 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.

FieldTypeLabelDescription
asset_idstringThe id of the asset to be retrieved. Required.

GetAssetResponse

FieldTypeLabelDescription
assetAsset

ListAssetsRequest

The request for a call to AssetService_ListAssets.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA 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, and 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_bystringHow to order the retrieved assets. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are 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.

FieldTypeLabelDescription
assetsAssetrepeated
next_page_tokenstring

UpdateAssetRequest

FieldTypeLabelDescription
assetAssetThe asset to update. The asset's asset_id field is used to identify asset run to update and is required.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. Currently, the only field available to be updated is tags.

UpdateAssetResponse

FieldTypeLabelDescription
assetAsset

AssetService

Method NameRequest TypeResponse TypeDescription
DeleteAssetDeleteAssetRequestDeleteAssetResponseDeletes an asset.
GetAssetGetAssetRequestGetAssetResponseRetrieves an asset.
ListAssetsListAssetsRequestListAssetsResponseRetrieves assets using an optional filter.
UpdateAssetUpdateAssetRequestUpdateAssetResponse

On this page