metadata

sift/metadata/v1/metadata.proto

Services

RPC methods exposed by this API.

MetadataService

Method	Request	Response	Description
CreateMetadataKey	CreateMetadataKeyRequest	CreateMetadataKeyResponse	Create a metadata key.
CreateMetadataValue	CreateMetadataValueRequest	CreateMetadataValueResponse	Create a metadata value.
ListMetadataKeys	ListMetadataKeysRequest	ListMetadataKeysResponse	List metadata keys.
ListMetadataValues	ListMetadataValuesRequest	ListMetadataValuesResponse	List metadata values.
ArchiveMetadataKeys	ArchiveMetadataKeysRequest	ArchiveMetadataKeysResponse	Archive metadata keys.
ArchiveMetadataValues	ArchiveMetadataValuesRequest	ArchiveMetadataValuesResponse	Archive metadata values.
UnarchiveMetadataKeys	UnarchiveMetadataKeysRequest	UnarchiveMetadataKeysResponse	Unarchive metadata keys.
UnarchiveMetadataValues	UnarchiveMetadataValuesRequest	UnarchiveMetadataValuesResponse	Unarchive metadata values.
DeleteMetadataKeys	DeleteMetadataKeysRequest	DeleteMetadataKeysResponse	Delete metadata keys.
DeleteMetadataValues	DeleteMetadataValuesRequest	DeleteMetadataValuesResponse	Delete metadata values.
ListMetadataUsage	ListMetadataUsageRequest	ListMetadataUsageResponse	List metadata key usage.

Messages

Data models used across requests/responses.

ArchiveMetadataKeysRequest

Field	Type	Label	Description
metadata_keys	MetadataKey	repeated

ArchiveMetadataKeysResponse

This message has no fields.

ArchiveMetadataValuesRequest

Field	Type	Label	Description
metadata_values	MetadataValue	repeated

ArchiveMetadataValuesResponse

This message has no fields.

CreateMetadataKeyRequest

The request of a call to MetadataService_CreateMetadataKey to create a metadata key.

Field	Type	Label	Description
metadata_key	MetadataKey

CreateMetadataKeyResponse

The response of a call to MetadataService_CreateMetadataKey to create a metadata key.

Field	Type	Label	Description
metadata_key	MetadataKey

CreateMetadataValueRequest

The request of a call to MetadataService_CreateMetadataValue to create a metadata value.

Field	Type	Label	Description
metadata_value	MetadataValue

CreateMetadataValueResponse

The response of a call to MetadataService_CreateMetadataValue to create a metadata value.

Field	Type	Label	Description
metadata_value	MetadataValue

DeleteMetadataKeysRequest

Field	Type	Label	Description
metadata_keys	MetadataKey	repeated

DeleteMetadataKeysResponse

This message has no fields.

DeleteMetadataValuesRequest

Field	Type	Label	Description
metadata_values	MetadataValue	repeated

DeleteMetadataValuesResponse

This message has no fields.

ListMetadataKeysRequest

The request for a call to MetadataService_ListMetadataKeys to retrieve metadata keys.

Field	Type	Label	Description
page_size	uint32		The maximum number of metadata keys to return. The service may return fewer than this value. If unspecified, at most 50 metadata keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string		A page token, received from a previous ListMetadataKeys call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMetadataKeys must match the call that provided the page token. Optional.
filter	string		A Common Expression Language (CEL) filter string. Available fields to filter by are: name, archived_date, and is_archived. 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 metadata keys. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date and name. 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”

ListMetadataKeysResponse

The response of a call to MetadataService_ListMetadataKeysResponse.

Field	Type	Label	Description
metadata_keys	MetadataKey	repeated
next_page_token	string

ListMetadataUsageRequest

Field	Type	Label	Description
page_size	uint32		The maximum number of metadata key usages to return. The service may return fewer than this value. If unspecified, at most 50 metadata key usages will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string		A page token, received from a previous ListMetadataUsage call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMetadataUsage must match the call that provided the page token. Optional.
filter	string		A Common Expression Language (CEL) filter string. Available fields to filter by are: entity_name, entity_type, key_name,value_string, value_number, and value_boolean. 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 metadata key usages. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date, entity_id and entity_type. 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”

ListMetadataUsageResponse

Field	Type	Label	Description
metadata_usages	MetadataUsage	repeated
next_page_token	string

ListMetadataValuesRequest

Field	Type	Label	Description
page_size	uint32		The maximum number of metadata values to return. The service may return fewer than this value. If unspecified, at most 50 metadata values will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string		A page token, received from a previous ListMetadataValues call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMetadataValues must match the call that provided the page token. Optional.
filter	string		A Common Expression Language (CEL) filter string. Available fields to filter by are: value_string, value_number, value_boolean, archived_date, and is_archived. 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 metadata keys. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date and name. 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”
metadata_key_name	string		The name of the metadata key to list values for.

ListMetadataValuesResponse

Field	Type	Label	Description
metadata_values	MetadataValue	repeated
next_page_token	string

MetadataKey

Field	Type	Label	Description
name	string
type	MetadataKeyType
archived_date	google.protobuf.Timestamp
is_archived	bool		Whether the metadata key is archived. This is inferred from whether archived_date is set.

The filter field type this key maps to, so a client can build a CEL filter against it (metadata["<name>"]) and resolve its operators and functions from FilterGrammarService. Derived from type. |

MetadataRelationValue

Field	Type	Label	Description
resource_type	string
resource_id	string

MetadataUsage

Field	Type	Label	Description
entity_id	string		The ID of the entity. For example assetId, runId, reportId, etc.
entity_type	string		The type of the entity. For example asset, run, report, etc.
value	MetadataValue		The value of the metadata key on this entity.

MetadataValue

Field	Type	Label	Description
key	MetadataKey
oneof value. string_value	string
oneof value. number_value	double
oneof value. boolean_value	bool
oneof value. relation_value	MetadataRelationValue
archived_date	google.protobuf.Timestamp
is_archived	bool		Whether the metadata value is archived. This is inferred from whether archived_date is set.

UnarchiveMetadataKeysRequest

Field	Type	Label	Description
metadata_keys	MetadataKey	repeated
unarchive_values	bool

UnarchiveMetadataKeysResponse

This message has no fields.

UnarchiveMetadataValuesRequest

Field	Type	Label	Description
metadata_values	MetadataValue	repeated

UnarchiveMetadataValuesResponse

This message has no fields.

Enums

Allowed constant values used in message fields.

MetadataKeyType

Metadata key type.

Name	Number	Description
METADATA_KEY_TYPE_UNSPECIFIED	0
METADATA_KEY_TYPE_STRING	1	string
METADATA_KEY_TYPE_NUMBER	2	number
METADATA_KEY_TYPE_BOOLEAN	3	boolean
METADATA_KEY_TYPE_RELATION	4	relation — references another resource by UUID (e.g. folder membership)