alert.v1

configuration_errors contain any configuration errors reported by the backend

endpoint_errors contain any failed attempts to send alerts

last_modified_at is the time at which the configuration was last modified

last_modified_by is the user who last modified the configuration

settings is the global default settings for various endpoints used in broadcast groups.

Can be overwritten in individual endpoint settings

rules define how we route alerts to broadcast groups

broadcast_groups are groups of endpoints that alerts are sent to

client_id of the Azure environment

tenant_id of the Azure environment

client_secret is a user generated secret key used for auth

auth_uri is the URI used for OAuth

email is a set of email endpoints to send alerts to as part of this group

webhook is a set of webhook endpoints to send alerts to as part of this group

slack is a set of slack endpoints to send alerts to as part of this group

opsgenie is a set of opsgenie endpoints to send alerts to as part of this group

pushover is a set of pushover endpoints to send alerts to as part of this group

pagerduty is a set of pagerduty endpoints to send alerts to as part of this group

victorops is a set of victorops endpoints to send alerts to as part of this group

gchat is a set of google chat endpoints to send alerts to as part of this group

msteams is a set of MS teams endpoints to send alerts to as part of this group

sendgrid is a set of sendgrid endpoints to send alerts to as part of this group

syslog is a set of syslog endpoints to send alerts to as part of this group

snmp is a set of snmp endpoints to send alerts to as part of this group

cue_syslog is a set of cue syslog endpoints to send alerts to as part of this group

cue_snmp is a set of cue snmp endpoints to send alerts to as part of this group

cue_sendgrid is a set of cue sendgrid endpoints to send alerts to as part of this group

zoom is a set of zoom endpoints to send alerts to as part of this group

values is a map of user defined ids to broadcast groups. No restrictions to naming applies

path is the ‘path’ to the invalid config element,

eg: path.userPathName.email_configs[1].to =

the ’to’ field of the second email config of the ‘userPathName’ broadcast_group

error_type is the type of error, this allows custom handling of different error types

error is a user-friendly error message

values is a list of errors

values can contain some additional data which is required by the cue specific provider

community is the community string used for authentication in SNMPv1 and v2c

required if version < 3

username the username for SNMPv3 auth

security_level the security level for SNMPv3

authentication_protocol is the protocol to use for authentication in SNMPv3

required for AUTH_NO_PRIV/AUTH_PRIV security levels

authentication_passphrase is the passphrase to use for authentication in SNMPv3

required for AUTH_NO_PRIV/AUTH_PRIV security levels

privacy_protocol is the protocol to use for privacy in SNMPv3

required for AUTH_PRIV security level

privacy_passphrase is the passphrase to use for privacy in SNMPv3

required for AUTH_PRIV security level

send_resolved send alerts when events are resolved along with when they are triggered

settings_override is the override for the cue snmp global endpoint settings

target is an ipv4 address to send messages to

port is the network port to target

transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

version is the SNMP version, v2c and v3 are supported and can be set with 2 and 3 respectively

auth is the optional authentication settings

data is additional data that maybe required for constructing the message or sending it

send_resolved send alerts when events are resolved along with when they are triggered

to address to send email to

http_override is the override of the global http settings

This overrides the value used in Settings message in the global alert config

values are the elements of the set

api_key is the key used to connect to the sendgrid APIs

from is the sender’s address in the email sent

values are the elements of the set

send_resolved send alerts when events are resolved along with when they are triggered

settings_override is the override for the cue syslog global endpoint settings

values are the elements of the set

network is the network protocol to use, default is “udp”,

options also include: tcp,tcp4,tcp6,udp4,udp6

address is the ip address to send syslog messages to

port is server’s port to connect to

message_format defines the message format to use

append_bom_header if true a BOM( Byte Order Mark ) will be appended to the outgoing message

BOM will tell the server that is receiving the messages, that the format is UTF8.

data is additional data that maybe required for constructing the message or sending it

key identifies which template the configuration is for

template is the string template value to be used

Templates need to be compatible with their respective parsers

Message templates are read and parsed by https://golang.org/pkg/text/template/

Html templates are read and parsed by https://golang.org/pkg/html/template/

Templates must output valid JSON for certain templates

Templates must not fail for any valid input

multi_alert is true if this template uses a multiple alert context and false if a single

alert context is used.

description is a description of the template.

external_documentation is a url to any relevant external documentation, or "" if there is no

relevant documentation.

output_format is the expected output format of this template

Any submitted template will be expected to output text with valid formatting for any input or

may fail validation.

display_name is the name that can be displayed to the user for this particular template type

send_resolved send alerts when events are resolved along with when they are triggered

to address to send email to

Email does not have a http override

Email does not have a settings override

values are the elements of the set

from is the email address to send from

smarthost is the hostname and port of the SMTP server

auth_username the username to use when sending emails

required for all auth methods

auth_password the password to use when sending emails

require_tls always use TLS connections when sending emails

single_alert_per_email configures the Alerter such that each alert generates a separate email

notification, the email will only have a single notification, the format will also be different

azure_o_auth used for auth when using an Azure smtp server

uses auth_username

endpoint_type indicates the type of endpoint which failed,

or unknown if not endpoint-specific (eg: slack, opsgenie)

broadcast_group_name is the name of the broadcast group which was being used,

empty string if not group specific

config_index is the index of the config on the broadcast group or -1 if not applicable

eg: if there are two email config in one broadcast group, then the indices for each are 0 and 1

note that these are done per type, so only counting email/slack/…

error_type is the type of error, this allows custom handling of different error types

error is a user-friendly error message

values is the list of errors

event_types contain the event types

send_resolved send alerts when events are resolved along with when they are triggered

http_override is the override of the global http settings

settings_override is the override for the google chat global endpoint settings

values are the elements of the set

url is the url of the webhook to send alerts to

values is the header values

values is a map of http header names to values

username is the username to use when connecting to the http proxy

password is the password to use when connecting to the http proxy

proxy_url is the url for the http proxy

custom_headers is custom http headers to be used along with the default headers

values is a map where the keys are event type which when active will suppress any events with

event types in the related EventList

severities is a list of severities to filter on,

if an event does not have one of these severities, it will not match

Valid values are DEBUG, INFO, WARNING, ERROR and CRITICAL

devices is a list of device IDs to filter on,

if an event does not belong to one of these devices, it will not match

event_types is a list of event types to filter on,

if an event does not have one of these event types, it will not match

device_tags is a string tag query that is used to match on the event’s device tags

intf_tags is a string tag query that is used to match on the event’s interface tags

rule_ids is a list of rule IDs to filter on,

if an event does not have one of these rule IDs, it will not match

send_resolved send alerts when events are resolved along with when they are triggered

http_override is the override of the global http settings

settings_override is the override for the microsoft teams global endpoint settings

values are the elements of the set

url is the url of the webhook to send alerts to

send_resolved send alerts when events are resolved along with when they are triggered

http_override is the override of the global http settings

settings_override is the override for the opsgenie global endpoint settings

values are the elements of the set

key is the API key to use when talking to the OpsGenie API

url is the url to use when sending alerts to opsgenie

send_resolved send alerts when events are resolved along with when they are triggered

routing_key is the routing key for sending pagerduty alerts

http_override is the override of the global http settings

settings_override is the override for the pagerduty global endpoint settings

values are the elements of the set

url is the url to use when sending alerts to pagerduty

critical priority, default = 2 (Critical)

error priority, default = 3 (Error)

warn priority, default = 4 (Warning)

info priority, default = 6 (Informational)

send_resolved send alerts when events are resolved along with when they are triggered

token is the user’s registered application’s API token, see https://pushover.net/apps

user_key is the user’s user key

http_override is the override of the global http settings

Pushover does not have a settings override

values are the elements of the set

sends_to is the name of the broadcast group top send matching alerts to

match_criteria is the criteria that an alert must match to be sent to the broadcast group

continue_checks if true, causes alerts matching this rule’s criteria to continue

checking against other rules, allowing for additional matches. If false,

alerts matching this rule will not proceed with checking

comment is a comment to include that will be displayed in the alert

values contains the rules

community is the community string used for authentication in SNMPv1 and v2c

required if version < 3

username the username for SNMPv3 auth

security_level the security level for SNMPv3

authentication_protocol is the protocol to use for authentication in SNMPv3

required for AUTH_NO_PRIV/AUTH_PRIV security levels

authentication_passphrase is the passphrase to use for authentication in SNMPv3

required for AUTH_NO_PRIV/AUTH_PRIV security levels

privacy_protocol is the protocol to use for privacy in SNMPv3

required for AUTH_PRIV security level

privacy_passphrase is the passphrase to use for privacy in SNMPv3

required for AUTH_PRIV security level

send_resolved send alerts when events are resolved along with when they are triggered

settings_override is the override for the microsoft teams global endpoint settings

values are the elements of the set

target is an ipv4 address to send messages to

port is the network port to target

transport is the transport protocol to use (“udp” or “tcp”); if unset “udp” will be used

version is the SNMP version, v1, v2c and v3 are supported and can be set

with 1, 2 and 3 respectively

auth is optional authentication settings

engine_id is the engine ID that will be used by the Alerter

This should be a hexadecimal string, colon separators between bytes will be accepted when

writing, but will be absent when reading

optional: if excluded or left blank, this will be automatically generated

send_resolved send alerts when events are resolved along with when they are triggered

to address to send email to

http_override is the override of the global http settings

values are the elements of the set

api_key is the api key to use

from is the email address to send from

email is the global default settings for email

http is the global default settings for http

slack is the global default settings for slack

victorops is the global default settings for victorops

pagerduty is the global default settings for pagerduty

opsgenie is the global default settings for opsgenie

gchat is the global default settings for google chat

msteams is the global default settings for ms teams

inhibition defines the inhibition rules for alerts, allowing events of certain types to be

suppressed while another event type is active

base_url is the root address of your CloudVision app. Used to generate links in notifications.

timezone is used for formatting event times in notifications. E.g. ‘UTC’, ‘US/Pacific’

syslog is the global default settings for syslog

snmp is the global default settings for snmp

sendgrid is the global default settings for sendgrid

cue_syslog is the global default settings for cue syslog

cue_snmp is the global default settings for cue snmp

cue_sendgrid is the global default settings for cue sendgrid

hide_tags is used to by the alerting system to omit tags and other “superfluous”

values from the notifications that are sent out by the system

zoom is the global default settings for zoom

send_resolved send alerts when events are resolved along with when they are triggered

http_override is the override of the global http settings

settings_override is the override for the slack global endpoint settings

values are the elements of the set

url is the url of the slack webhook to use

send_resolved send alerts when events are resolved along with when they are triggered

settings_override is the override for the microsoft teams global endpoint settings

values are the elements of the set

network is the network protocol to use, default is “udp”,

options also include: tcp,tcp4,tcp6,udp4,udp6

address is the network address to send syslog messages to

facility is the syslog facility 0-23 inc. This is the syslog facility as defined in RFC-3164

priorities describes how CVP severity maps to syslog priority

priority is a number between 0-7 inc. as defined in RFC-3164

tag is the syslog TAG as described in RFC-3164, it is the prefix to all syslog messages

per_device allows message to optionally be sent per device,

if an event concerns two devices the behaviour is changed based on this option:

true: two messages are sent, one for each device

false: a single message is sent

use_tls determines if the connection to the server should be secured with TLS

key identifies which template the configuration is for

template is the string template value to be used

Templates need to be compatible with their respective parsers

Message templates are read and parsed by https://golang.org/pkg/text/template/

Html templates are read and parsed by https://golang.org/pkg/html/template/

Templates must output valid JSON for certain templates

Templates must not fail for any valid input

template_type is the enum value to match with the template

send_resolved send alerts when events are resolved along with when they are triggered

routing_key is the PagerDuty integration key

http_override is the override of the global http settings

settings_override is the override for the victorops global endpoint settings

values are the elements of the set

key is the API key to use when talking to the VictorOps API

url is the victorops url to use (without integration or routing key

default: https://alert.victorops.com/integrations/generic/20131114/alert/

send_resolved send alerts when events are resolved along with when they are triggered

url is the url

http_override is the override of the global http settings

simple_output is a boolean flag to control the JSON structure of the webhook body.

When false the output mimics the old alertmanager format.

When true the output is a simple array of json objects which each represent an event.

single_alert is a boolean flag that will cause an individual webhook message to be sent per

alert when true.

Webhook does not have a settings override

values are the elements of the set

send_resolved send alerts when events are resolved along with when they are triggered

http_override is the override of the global http settings

settings_override is the override for the zoom global endpoint settings

values are the elements of the set

url is the zoom incoming webhook URL to send messages to

verification_token is the verification token to authenticate with

CONFIG_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

CONFIG_ERROR_TYPE_INVALID_FORMAT is caused by invalid format for value (eg: url)

CONFIG_ERROR_TYPE_INVALID_SYNTAX is caused by invalid syntax for value (eg: regex)

CONFIG_ERROR_TYPE_TEMPLATE_INVALID is caused by failure to parse a template

CONFIG_ERROR_TYPE_ILLEGAL_VALUE is caused by a value outside of its bounds

CONFIG_ERROR_TYPE_MISSING_REQUIRED is caused by a missing required attribute

CONFIG_ERROR_TYPE_INVALID_TYPE is caused by the wrong type found in backing store

CUE_SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

CUE_SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

CUE_SNMP_AUTH_PROTOCOL_SHA use the sha protocol

CUE_SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

CUE_SNMP_PRIV_PROTOCOL_DES use the des protocol

CUE_SNMP_PRIV_PROTOCOL_AES use the aes protocol

CUE_SYSLOG_MESSAGE_FORMAT_UNSPECIFIED is the unspecified enum value

CUE_SYSLOG_MESSAGE_FORMAT_PLAIN format uses the text format for constructing the syslog message

CUE_SYSLOG_MESSAGE_FORMAT_IDMEF uses IDMEF message format as described here:

https://datatracker.ietf.org/doc/html/rfc4765

ENDPOINT_ERROR_TYPE_UNSPECIFIED is the unspecified enum value

ENDPOINT_ERROR_TYPE_HTTP_POST_ERROR an error in sending HTTP request or reading a HTTP

response

ENDPOINT_ERROR_TYPE_JSON_MARSHAL_ERROR is caused by errors while encoding json

ENDPOINT_ERROR_TYPE_INVALID_CONFIG_ERROR is an error caused by invalid config (missing,

bad format, etc)

ENDPOINT_ERROR_TYPE_TEMPLATE_ERROR is caused by errors while executing templates

ENDPOINT_ERROR_TYPE_BAD_RESPONSE_ERROR is caused by receiving a negative response from an

endpoint indicating that the alert was not sent

ENDPOINT_ERROR_TYPE_SMTP_ERROR is caused by errors with SMTP

ENDPOINT_ERROR_TYPE_CONNECTION_ERROR is caused by errors with a connection

ENDPOINT_ERROR_TYPE_TIMEOUT_ERROR is caused by errors with a connection

ENDPOINT_ERROR_TYPE_RATE_LIMIT_ERROR is caused by an Alerter rate limit being exceeded

ENDPOINT_ERROR_TYPE_ALERT_CAP_ERROR is caused by the number of alerts sent to a sender

exceeding the built-in limit

ENDPOINT_ERROR_TYPE_O_AUTH_ERROR is caused when we failed authenticating using the

OAuth apis

SNMP_AUTH_PROTOCOL_UNSPECIFIED is the unspecified enum value

SNMP_AUTH_PROTOCOL_MD5 use the md5 protocol

SNMP_AUTH_PROTOCOL_SHA use the sha protocol

SNMP_AUTH_PROTOCOL_SHA_224 use the sha224 protocol

SNMP_AUTH_PROTOCOL_SHA_256 use the sha256 protocol

SNMP_AUTH_PROTOCOL_SHA_384 use the sha384 protocol

SNMP_AUTH_PROTOCOL_SHA_512 use the sha512 protocol

SNMP_PRIV_PROTOCOL_UNSPECIFIED is the unspecified enum value

SNMP_PRIV_PROTOCOL_DES use the des protocol

SNMP_PRIV_PROTOCOL_AES use the aes protocol

SNMP_PRIV_PROTOCOL_AES_192 use the aes192 protocol

SNMP_PRIV_PROTOCOL_AES_256 use the aes256 protocol

SNMP_PRIV_PROTOCOL_AES_192C use the aes192c protocol

SNMP_PRIV_PROTOCOL_AES_256C use the aes256c protocol

SNMP_SECURITY_LEVEL_UNSPECIFIED is the unspecified enum value

SNMP_SECURITY_LEVEL_NO_AUTH_NO_PRIV use no security

SNMP_SECURITY_LEVEL_AUTH_NO_PRIV use authentication without privacy

SNMP_SECURITY_LEVEL_AUTH_PRIV use both authentication and privacy

TEMPLATE_OUTPUT_UNSPECIFIED is the unspecfied value.

TEMPLATE_OUTPUT_TEXT indicates the the template outputs plain text.

TEMPLATE_OUTPUT_JSON indicates the the template outputs JSON.

TEMPLATE_OUTPUT_HTML indicates the the template outputs HTML.

This also indicates that “html/templates” will be used instead of “text/templates” so that

html characters are automatically escaped from input.

TEMPLATE_TYPE_UNSPECIFIED is the unspecified enum value

TEMPLATE_TYPE_EMAIL_HTML is the key of the html template for sent emails

TEMPLATE_TYPE_EMAIL_TEXT is the key of the text template for sent emails

TEMPLATE_TYPE_SLACK_MESSAGE is the key of the message template for sent slack messages

TEMPLATE_TYPE_PUSHOVER_MESSAGE is the key of the message template for sent pushover messages

TEMPLATE_TYPE_PAGERDUTY_SUMMARY is the key of the summary template for sent pagerduty messages

TEMPLATE_TYPE_VICTOROPS_DISPLAY_NAME is the key of the display name template for sent victorops

messages

TEMPLATE_TYPE_VICTOROPS_STATE_MESSAGE is the key of the state message template for sent

victorops messages

TEMPLATE_TYPE_GOOGLE_CHAT_MESSAGE is the key of the message template for sent Google chat

messages

TEMPLATE_TYPE_MICROSOFT_TEAMS_MESSAGE is the key of the message template for sent Microsoft

teams messages

TEMPLATE_TYPE_EMAIL_SUBJECT is the key of the subject line template of a sent email

TEMPLATE_TYPE_SYSLOG_MESSAGE is the key of the message template for a syslog message part

TEMPLATE_TYPE_OPSGENIE_MESSAGE is the key of the message template for a opsgenie alert

TEMPLATE_TYPE_ZOOM_MESSAGE is the key of the message template for sent Zoom messages

TEMPLATE_TYPE_EMAIL_SINGLE_HTML is the key of the html template for sent emails when the

single alert per email option is selected

TEMPLATE_TYPE_EMAIL_SINGLE_TEXT is the key of the text template for sent emails when the

single alert per email option is selected

TEMPLATE_TYPE_EMAIL_SINGLE_SUBJECT is the key of the subject line template of a sent email

when the single alert per email option is selected

TEMPLATE_TYPE_WEBHOOK_SINGLE is the key of the template for webhook message body when the

single_alert option is true

TEMPLATE_TYPE_WEBHOOK_MULTIPLE is the key of the template for webhook message body when the

single_alert option is false

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

AlertConfig instance in this response.

AlertConfig carries the value to set into the datastore.

See the documentation on the AlertConfig struct for which fields are required.

Value carries all the values given in the AlertConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each AlertConfig at end.

* Each AlertConfig response is fully-specified (all fields set).

* start: Returns the state of each AlertConfig at start, followed by updates until now.

* Each AlertConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each AlertConfig at start, followed by updates

until end.

* Each AlertConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this AlertConfig’s last modification.

Operation indicates how the AlertConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

Alert instance in this response.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Alert at end.

* Each Alert response is fully-specified (all fields set).

* start: Returns the state of each Alert at start, followed by updates until now.

* Each Alert response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Alert at start, followed by updates

until end.

* Each Alert response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this Alert’s last modification.

Operation indicates how the Alert value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Key uniquely identifies a DefaultTemplate instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

DefaultTemplate instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each DefaultTemplate at end.

* Each DefaultTemplate response is fully-specified (all fields set).

* start: Returns the state of each DefaultTemplate at start, followed by updates until now.

* Each DefaultTemplate response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each DefaultTemplate at start, followed by updates

until end.

* Each DefaultTemplate response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this DefaultTemplate’s last modification.

Operation indicates how the DefaultTemplate value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Time holds the timestamp of the last item included in the metadata calculation.

Operation indicates how the value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Count is the number of items present under the conditions of the request.

This describes the class of delete error.

This indicates the error message from the delete failure.

This is the key of the TemplateConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which TemplateConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted TemplateConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

key contains a list of TemplateConfig keys to delete

Key uniquely identifies a TemplateConfig instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

TemplateConfig instance in this response.

TemplateConfig carries the value to set into the datastore.

See the documentation on the TemplateConfig struct for which fields are required.

Value carries all the values given in the TemplateConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

value contains a list of TemplateConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each TemplateConfig at end.

* Each TemplateConfig response is fully-specified (all fields set).

* start: Returns the state of each TemplateConfig at start, followed by updates until now.

* Each TemplateConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each TemplateConfig at start, followed by updates

until end.

* Each TemplateConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this TemplateConfig’s last modification.

Operation indicates how the TemplateConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.