user_defined_functions

sift/user_defined_functions/v1/user_defined_functions.proto

Services

RPC methods exposed by this API.

UserDefinedFunctionService

Method	Request	Response	Description
GetUserDefinedFunction	GetUserDefinedFunctionRequest	GetUserDefinedFunctionResponse	Retrieve the latest version of a user defined function
GetUserDefinedFunctionVersion	GetUserDefinedFunctionVersionRequest	GetUserDefinedFunctionVersionResponse	Retrieve a specific version of a user defined function
GetUserDefinedFunctionVersions	GetUserDefinedFunctionVersionsRequest	GetUserDefinedFunctionVersionsResponse	Retrieve versions of user defined functions
GetUserDefinedFunctionDependents	GetUserDefinedFunctionDependentsRequest	GetUserDefinedFunctionDependentsResponse	Retrieve versions of user defined functions
CreateUserDefinedFunction	CreateUserDefinedFunctionRequest	CreateUserDefinedFunctionResponse	Create a user defined function.
ValidateUserDefinedFunction	ValidateUserDefinedFunctionRequest	ValidateUserDefinedFunctionResponse	Validate a potential user defined function
UpdateUserDefinedFunction	UpdateUserDefinedFunctionRequest	UpdateUserDefinedFunctionResponse	Update a user defined function.
CheckUpdatableFields	CheckUpdatableFieldsRequest	CheckUpdatableFieldsResponse	Check if given update paths are allowed to update for the user defined function.
ListUserDefinedFunctions	ListUserDefinedFunctionsRequest	ListUserDefinedFunctionsResponse	Retrieve the latest versions of user defined functions based on an optional filter.
ListUserDefinedFunctionVersions	ListUserDefinedFunctionVersionsRequest	ListUserDefinedFunctionVersionsResponse	List versions of a particular user defined functions with an optional filter.

Messages

Data models used across requests/responses.

CheckUpdatableFieldsRequest

Field	Type	Label	Description
user_defined_function_id	string
update_mask	google.protobuf.FieldMask

CheckUpdatableFieldsResponse

Field	Type	Label	Description
allowed_fields	google.protobuf.FieldMask
disallowed_fields	CheckUpdatableFieldsResponse.DisallowedFieldsEntry	repeated	Disallowed Fields will contain the update fields as the key and the reason for rejection as the value.

CheckUpdatableFieldsResponse.DisallowedFieldsEntry

Field	Type	Label	Description
key	string
value	string

CreateUserDefinedFunctionRequest

Field	Type	Label	Description
name	string
description	string	optional
expression	string
function_inputs	sift.common.type.v1.FunctionInput	repeated
user_notes	string	optional
metadata	sift.metadata.v1.MetadataValue	repeated

CreateUserDefinedFunctionResponse

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction

GetUserDefinedFunctionDependentsRequest

The request for a call to UserDefinedFunctionService_GetUserDefinedFunctionDependents to retrieve versions of user defined functions.

Field	Type	Label	Description
page_size	uint32
oneof user_defined_function. user_defined_function_id	string
oneof user_defined_function. user_defined_function_name	string
oneof user_defined_function. user_defined_function_version_id	string

GetUserDefinedFunctionDependentsResponse

Field	Type	Label	Description
user_defined_functions	sift.common.type.v1.UserDefinedFunction	repeated
next_page_token_user_defined_function	string
calculated_channels	sift.calculated_channels.v2.CalculatedChannel	repeated
next_page_token_calculated_channel	string
rules	sift.rules.v1.Rule	repeated
next_page_token_rule	string

GetUserDefinedFunctionRequest

The request for a call to UserDefinedFunctionService_GetUserDefinedFunction to retrieve the latest version of a user defined function. If user_defined_function_id is provided then all other arguments will be ignored. The argument user_defined_function_id should not be used together with name.

Field	Type	Label	Description
user_defined_function_id	string
name	string

GetUserDefinedFunctionResponse

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction

GetUserDefinedFunctionVersionRequest

The request for a call to UserDefinedFunctionService_GetUserDefinedFunctionVersion to retrieve a specific version of a user defined function.

Field	Type	Label	Description
user_defined_function_version_id	string

GetUserDefinedFunctionVersionResponse

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction

GetUserDefinedFunctionVersionsRequest

The request for a call to UserDefinedFunctionService_GetUserDefinedFunctionVersions to retrieve versions of user defined functions.

Field	Type	Label	Description
user_defined_function_version_ids	string	repeated

GetUserDefinedFunctionVersionsResponse

Field	Type	Label	Description
user_defined_functions	sift.common.type.v1.UserDefinedFunction	repeated

ListUserDefinedFunctionVersionsRequest

The request for a call to UserDefinedFunctionService_ListUserDefinedFunctionVersions to retrieve versions of user defined function. If user_defined_function_id is provided then name is ignored.

Field	Type	Label	Description
user_defined_function_id	string
name	string
page_size	uint32		The maximum number of user defined function versions to return. The service may return fewer than this value. If unspecified, at most 50 user defined function versions 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 ListUserDefinedFunctions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserDefinedFunctions 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 user_defined_function_id, name, version, archived_date, and is_archived. For further information about how to use CELs, please refer to this guide.
order_by	string		How to order the retrieved user defined functions. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date, modified_date, name, and version. If left empty, items are ordered by name in ascending order (oldest-first). For more information about the format of this field, read this Example: “version desc,name”.

ListUserDefinedFunctionVersionsResponse

The response of a call to UserDefinedFunctionService_ListUserDefinedFunctionVersions.

Field	Type	Label	Description
user_defined_functions	sift.common.type.v1.UserDefinedFunction	repeated
next_page_token	string

ListUserDefinedFunctionsRequest

The request for a call to UserDefinedFunctionService_ListUserDefinedFunctions to retrieve lateset versions of user defined functions.

Field	Type	Label	Description
page_size	uint32		The maximum number of user defined functions to return. The service may return fewer than this value. If unspecified, at most 50 user defined functions 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 ListUserDefinedFunctions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserDefinedFunctions 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 user_defined_function_id, name, archived_date, and is_archived. For further information about how to use CELs, please refer to this guide.
order_by	string		How to order the retrieved user defined functions. 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,modified_date”.

ListUserDefinedFunctionsResponse

The response of a call to UserDefinedFunctionService_ListUserDefinedFunctions.

Field	Type	Label	Description
user_defined_functions	sift.common.type.v1.UserDefinedFunction	repeated
next_page_token	string

UpdateUserDefinedFunctionRequest

The request for a call to UserDefinedFunctionService_UpdateUserDefinedFunction to update a user defined function. Updating a user defined function creates a new version of the user defined function, leaving the previous untouched. If no update is deemed necessary, then the the current version is returned. If name is changed then only name will be changed. If archive date is changed then only archive date will be changed. To archive user defined function, specify archived_date in the update mask as well as a non-null value for archived_date in the user_defined_function object. To unarchive a user defined function, specify archived_date in the update mask and a null value for archived_date in the user_defined_function object. Alternatively, use is_archived with a boolean value to archive/unarchive.

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction		The user defined function to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are name, archived_date, is_archived, description, expression, function_inputs, and metadata. — name can’t be updated if the function has ever had any dependencies — function_inputs inputs can’t be updated if the function has any dependents (functions or calculated channels with a dependency on this function). — expression can’t be updated if the function has dependents and the expression changes the output type. — metadata updates metadata associated with the function

UpdateUserDefinedFunctionResponse

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction

ValidateUserDefinedFunctionRequest

Field	Type	Label	Description
expression	string
function_inputs	sift.common.type.v1.FunctionInput	repeated

ValidateUserDefinedFunctionResponse

Field	Type	Label	Description
oneof result. error	ValidateUserDefinedFunctionResponse.ErrorValidatingUserDefinedFunctionResult
oneof result. success	ValidateUserDefinedFunctionResponse.SuccessValidatingUserDefinedFunctionResult

ValidateUserDefinedFunctionResponse.ErrorValidatingUserDefinedFunctionResult

Field	Type	Label	Description
error_message	string

ValidateUserDefinedFunctionResponse.SuccessValidatingUserDefinedFunctionResult

Field	Type	Label	Description
user_defined_function	sift.common.type.v1.UserDefinedFunction

Enums

Allowed constant values used in message fields.