dtkt.protoform.v1beta1protoform.proto

FieldElement

Message
FieldTypeNumberDescription
titlestring1

No description.

descriptionstring2

No description.

hiddenbool3

No description.

typeOneOf

No description.

confirm
ConfirmElement
4

No description.

input
InputElement
5

No description.

file
FileElement
6

No description.

select
SelectElement
7

No description.

multi_select
MultiSelectElement
8

No description.

dtkt.protoform.v1beta1protoform.proto

ConfirmElement

Message

Confirm element (approve/decline)

FieldTypeNumberDescription
approvestring1

No description.

declinestring2

No description.

default_selectedbool3

No description.

dtkt.protoform.v1beta1protoform.proto

InputElement

Message

Input element with multi-line text option

FieldTypeNumberDescription
multiline_textbool1

No description.

dtkt.protoform.v1beta1protoform.proto

FileElement

Message

File element

FieldTypeNumberDescription
allowed_typesstring[]2

No description.

dtkt.protoform.v1beta1protoform.proto

SelectElement

Message

Select element

FieldTypeNumberDescription
method_namestring1

No description.

field_namestring2

No description.

option_key
ValueAccessor
3

No description.

option_value
ValueAccessor
4

No description.

dtkt.protoform.v1beta1protoform.proto

MultiSelectElement

Message

Multi-select element

FieldTypeNumberDescription
method_namestring1

No description.

field_namestring2

No description.

option_key
ValueAccessor
3

No description.

option_value
ValueAccessor
4

No description.

dtkt.protoform.v1beta1protoform.proto

ValueAccessor

Message

Value accessor

FieldTypeNumberDescription
valueOneOf

No description.

item_indexbool1

No description.

item_valuebool2

No description.

item_fieldstring3

No description.

map_keybool4

No description.

map_valuebool5

No description.

dtkt.protoui.v1beta1protoui.proto

MessageOption

Message

Determines how a Message should be displayed in the UI.

FieldTypeNumberDescription
components
Component[]
1

No description.

dtkt.protoui.v1beta1protoui.proto

FieldOption

Message

Determines how a Field should be displayed in the UI.

FieldTypeNumberDescription
components
Component[]
1

No description.

dtkt.protoui.v1beta1protoui.proto

Data

Message
FieldTypeNumberDescription
dataOneOf

The evaluated context data to pass to the component. If none of the data options are specified, data will be the message or field as is.

textstring1

Evaluate the data as plain text.

exprstring2

Evaluate the data using a CEL expression. The message or field is passed as this to the expression data context.

template
Template
3

Evaluate the data using a template. The message or field is passed as the template data context.

dtkt.protoui.v1beta1protoui.proto

Component

Message

A Block represents a component in the UI that displays data from a message or field.

FieldTypeNumberDescription
idstring1

No description.

componentOneOf

Determine how the data should be displayed. If none of the display options are specified, the data will be displayed using a default renderer based on the data type.

markdown
Markdown
2

Render as markdown. Only valid for string type data.

heading
Heading
3

Render as a heading. Only valid for string type data.

table
Table
4

Render the data as a table. Only valid for repeated Message fields.

list
List
5

Render the data as a list. Only valid for repeated scalar fields.

badge
Badge
6

Render the data as a badge. Only valid for string type data.

progress
Progress
7

Render the data as progress. Only valid for numeric type data.

code_block
CodeBlock
8

Render the data as a code block. Only valid for string type data. Optionally, a language can be specified for syntax highlighting.

card
Card
9

Render the data as a card. Can contain other components.

description_list
DescriptionList
10

Render the data as a description list (key-value pairs).

tree
Tree
11

Render the data as a tree structure. Only valid for hierarchical data.

text
Text
12

Render the data as text with optional styling.

avatar
Avatar
14

Render the data as an avatar.

divider
Divider
15

Render the data as a divider/separator.

secret
Secret
19

Render the data as a secret (masked text with reveal option).

label
Label
20

Render as a label. Only valid for string type data.

description
Description
21

No description.

error
Error
22

No description.

custom
Any
40

Custom component. The data will be passed to the custom component as is.

metadata
Struct
50

Arbitrary metadata that can be used by the UI renderer.

dtkt.protoui.v1beta1protoui.proto

Template

Message
FieldTypeNumberDescription
language
Language
1

No description.

templatestring2

No description.

dtkt.protoui.v1beta1protoui.proto

Markdown

Message

Render as markdown. Supports text, CEL expressions, and templates for generating markdown content. Maps to markdown rendering in @dtkt/mdx The message or field is available as this in expression/template context. Example expr: "# " + this.title + "\n\n" + this.body Example template: Use Go templates with access to message fields

FieldTypeNumberDescription
content
Data
1

The markdown content. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

Table

Message

Table component to display repeated Message fields. Maps to Table in @dtkt/ui/table Use CEL expressions to extract row data from the current message/field. The message or field is available as this in the expression context.

Row data formats:

  • Direct field binding (no rows expression): each item is a proto message, use field in columns
  • List of lists (positional): this.users.map(u, [u.name, u.email, u.active ? "Active" : "Inactive"])
FieldTypeNumberDescription
rowsstring1

CEL expression that evaluates to a list of objects (repeated messages or structured data). Context: this is the message or field being rendered. If not specified, uses the field value directly.

columns
Column[]
2

Columns to be displayed in the table. If not specified, all fields will be displayed.

actions
Action[]
3

Actions that can be performed on the table rows.

dtkt.protoui.v1beta1protoui.proto

Heading

Message

Render as a heading with specified level. Maps to Heading in @dtkt/ui/heading Use CEL expressions to generate heading text. The message or field is available as this in the expression context. Example: this.title or "Section " + string(this.section_num) + ": " + this.name

FieldTypeNumberDescription
contentstring1

CEL expression that evaluates to a string for the heading text. Context: this is the message or field being rendered. If not specified, uses the field value directly.

leveluint322

Heading level (1-6).

dtkt.protoui.v1beta1protoui.proto

List

Message

Render as a list (bulleted or numbered). Maps to HTML list elements (ul/ol) Use CEL expressions to generate a list of items. The message or field is available as this in the expression context. Example: this.tags or this.items.map(i, i.name) or this.permissions.filter(p, p.enabled).map(p, p.label)

FieldTypeNumberDescription
itemsstring1

CEL expression that evaluates to a repeated/list value. Context: this is the message or field being rendered. If not specified, uses the field value directly.

style
Style
2

No description.

dtkt.protoui.v1beta1protoui.proto

Badge

Message

Render as a badge with optional color. Maps to Badge in @dtkt/ui/badge Use CEL expressions to generate badge text. The message or field is available as this in the expression context. Example: this.status or string(this.count) + " items" or this.is_active ? "Active" : "Inactive"

FieldTypeNumberDescription
contentstring1

CEL expression that evaluates to a string for the badge text. Context: this is the message or field being rendered. If not specified, uses the field value directly.

colorstring2

Color name from the UI theme (e.g., "red", "blue", "green", "zinc"). Defaults to "zinc" if not specified.

dtkt.protoui.v1beta1protoui.proto

Progress

Message

Render as a progress bar. Maps to Progress in @dtkt/ui/components/progress Use CEL expressions to calculate progress value (0-100). The message or field is available as this in the expression context. Example: double(this.completed) / double(this.total) * 100.0 or this.progress_percentage

FieldTypeNumberDescription
valuestring1

CEL expression that evaluates to a numeric value representing progress (0-100). Context: this is the message or field being rendered. If not specified, uses the field value directly.

dtkt.protoui.v1beta1protoui.proto

CodeBlock

Message

Render as a code block with optional syntax highlighting. Maps to Code/CodeBlock in @dtkt/ui/text or syntax highlighter components Supports text, CEL expressions, and templates for generating code content. The message or field is available as this in expression/template context. Example expr: this.code or this.function_body Example template: Use Go templates to format code

FieldTypeNumberDescription
content
Data
1

The code content. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

languagestring2

Language for syntax highlighting (e.g., "go", "python", "javascript").

filenamestring3

Optional filename to display.

show_line_numbersbool4

Show line numbers.

highlight_linesstring5

Highlight specific lines (e.g., "1-3,5,7-9").

dtkt.protoui.v1beta1protoui.proto

Card

Message

Render as a card with optional header and footer sections. Maps to Card in @dtkt/ui/card Supports text, CEL expressions, and templates for each section. The message or field is available as this in expression/template context. Example: header: this.title, content: this.body

FieldTypeNumberDescription
header
Data
1

Optional card header. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

content
Data
2

Card content - the main body. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

footer
Data
3

Optional card footer. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

DescriptionList

Message

Render as a description list (key-value pairs). Maps to DescriptionList in @dtkt/ui/description-list Use CEL expressions to generate a list of [term, description] tuples. The message or field is available as this in the expression context. Example: [["Name", this.name], ["Email", this.email], ["Status", this.is_active ? "Active" : "Inactive"]]

FieldTypeNumberDescription
itemsstring1

CEL expression that evaluates to a list of 2-element lists (tuples) where:

  • First element is the term/label (string)
  • Second element is the description/value (string) Context: this is the message or field being rendered. If not specified, uses the field value directly (expects map or message).
dtkt.protoui.v1beta1protoui.proto

Tree

Message

Render as a tree structure with expandable nodes. Maps to Tree in @dtkt/ui/tree Use CEL expressions to construct TreeNode messages from your data. The message or field is available as this in the expression context. Example: this.folders.map(f, dtkt.protoui.v1beta1.Tree.TreeNode{label: dtkt.protoui.v1beta1.Data{text: f.name}, children: f.files.map(file, dtkt.protoui.v1beta1.Tree.TreeNode{label: dtkt.protoui.v1beta1.Data{text: file.name}})})

FieldTypeNumberDescription
nodesstring1

CEL expression that evaluates to a list of TreeNode messages. Context: this is the message or field being rendered. If not specified, uses the field value directly.

dtkt.protoui.v1beta1protoui.proto

Text

Message

Render as styled text with color options. Maps to Text in @dtkt/ui/text Supports text, CEL expressions, and templates for generating content. The message or field is available as this in expression/template context. Example expr: this.message or "Updated: " + string(this.updated_at)

FieldTypeNumberDescription
content
Data
1

The text content. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

color
Color
2

No description.

dtkt.protoui.v1beta1protoui.proto

Avatar

Message

Render as an avatar with image or initials. Maps to Avatar in @dtkt/ui/avatar Use CEL expressions to generate src URL, initials, and alt text. The message or field is available as this in the expression context. Example src: this.avatar_url, initials: this.first_name.substring(0, 1) + this.last_name.substring(0, 1), alt: this.first_name + " " + this.last_name

FieldTypeNumberDescription
srcstring1

Optional CEL expression for the source URL of the avatar image. Context: this is the message or field being rendered.

initialsstring2

Optional CEL expression for initials to display when no image is available. Context: this is the message or field being rendered.

altstring3

Optional CEL expression for alternative text. Context: this is the message or field being rendered.

squarebool4

Whether to render as square instead of circle.

dtkt.protoui.v1beta1protoui.proto

Divider

Message

Render as a horizontal divider/separator. Maps to Divider in @dtkt/ui/divider Simple visual separator with soft styling option.

FieldTypeNumberDescription
softbool1

Whether to use softer border color.

dtkt.protoui.v1beta1protoui.proto

Secret

Message

Render as masked secret text with reveal button. Maps to Secret in @dtkt/ui/secret Use CEL expressions to generate the placeholder text (masked value). The message or field is available as this in the expression context. Example: "*".repeat(size(this.api_key)) or "••••" + this.api_key.substring(size(this.api_key) - 4)

FieldTypeNumberDescription
placeholderstring1

CEL expression for the placeholder text (the masked representation). Context: this is the message or field being rendered. If not specified, masks the field value automatically.

dtkt.protoui.v1beta1protoui.proto

Label

Message

Render as a form label. Maps to Label in @dtkt/ui/components/label or fieldset Example expr: this.field_name or "Enter your " + this.label

FieldTypeNumberDescription
content
Data
1

The label text. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

Description

Message

Render as a form description/help text. Maps to description/help text in form components Example expr: this.help_text or "This field is " + (this.required ? "required" : "optional")

FieldTypeNumberDescription
content
Data
1

The description text. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

Error

Message

Render as a form error message. Maps to error message display in form components Example expr: this.error or this.field_name + " is invalid"

FieldTypeNumberDescription
content
Data
1

The error message. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

Confirm

Message

Confirmation dialog with accept, decline, and cancel options. Maps to dialog/confirmation components with buttons Example expr: accept: "Yes, " + this.action, decline: "No, cancel " + this.action

FieldTypeNumberDescription
accept
Data
1

Accept button text. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

decline
Data
2

Decline button text. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

cancel
Data
3

Cancel button text. Can be plain text, a CEL expression, or a template. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

Input

Message

Input element with multi-line text option Maps to Input or Textarea in @dtkt/ui/input or @dtkt/ui/textarea

FieldTypeNumberDescription
multiline_textbool1

No description.

dtkt.protoui.v1beta1protoui.proto

File

Message

File upload input Maps to file input components

FieldTypeNumberDescription
allowed_typesstring[]2

No description.

dtkt.protoui.v1beta1protoui.proto

Select

Message

Select input with options. Maps to Select or Listbox in @dtkt/ui/select or @dtkt/ui/listbox Use CEL expressions to generate select options. The message or field is available as this in the expression context. Example options: this.available_items

FieldTypeNumberDescription
item_fieldstring1

Field name to be used as the option value.

label_fieldstring2

Field name to be used as the option label.

option_keystring3

CEL expression for option keys. Context: this is the message or field being rendered.

option_valuestring4

CEL expression for option values. Context: this is the message or field being rendered.

dtkt.protoui.v1beta1protoui.proto

MultiSelect

Message

Multi-select input allowing multiple selections. Maps to multi-select or checkbox group components Use CEL expressions to generate select options. The message or field is available as this in the expression context. Example options: this.available_tags

FieldTypeNumberDescription
item_fieldstring1

Field name to be used as the option value.

label_fieldstring2

Field name to be used as the option label.

option_keystring3

CEL expression for option keys. Context: this is the message or field being rendered.

option_valuestring4

CEL expression for option values. Context: this is the message or field being rendered.

dtkt.shared.v1beta1messages.proto

Address

Message

Address contains a supported network and compatible target.

FieldTypeNumberDescription
networkstring1

No description.

targetstring2

No description.

dtkt.shared.v1beta1messages.proto

Package

Message

Package provides an identity and metadata for a DataKit Integration.

FieldTypeNumberDescription
identity
Identity
1

Identity name (camel, snake, or pascal case) and version (semver) of integration.

descriptionstring2

A helpful description of features and capabilities.

iconstring3

An icon image uri (optional).

type
PackageType
4

Source language & SDK of integration (required).

runtimes
Runtime[]
5

Compatible target runtimes of integration (optional; defaults to all runtimes).

platforms
Platform[]
6

Compatible target platforms of integration (optional; defaults to all platforms).

build
BuildConfig
7

Build configuration.

deploy
DeployConfig
8

Deploy configuration.

dtkt.shared.v1beta1messages.proto

Platform

Message

Operating system and CPU architecture pair.

FieldTypeNumberDescription
os
OS
2

No description.

arch
Arch
3

No description.

dtkt.shared.v1beta1messages.proto

Field

Message

Represents a field within a table, query, input/output, etc.

FieldTypeNumberDescription
namestring1

Name of the field.

type
DataType
2

Data type of the field.

descriptionstring3

Description of the field.

nullablebool4

Indicates if the field allows null values (i.e. is not required).

repeatedbool5

Indicates if the field contains repeated values (i.e. an array of the given type).

fields
Field[]
6

Nested fields, if the field is a complex type (i.e. the type represents an object or map type).

element
FieldElement
7

Protoform field element for runtime UI configuration.

dtkt.shared.v1beta1messages.proto

Param

Message

Represents a parameterized value used in a query, input/output, etc.

FieldTypeNumberDescription
field
Field
1

Field describing the param data.

value
Any
2

Value of the parameter, if any.

dtkt.shared.v1beta1messages.proto

StringList

Message

Represents a list of strings as a message.

FieldTypeNumberDescription
valuesstring[]1

No description.

dtkt.shared.v1beta1messages.proto

TypeSchema

Message

TypeSchema provides a resolvable URI, JSON Schema, and a fully qualified Proto Type name.

FieldTypeNumberDescription
uristring1

Resolvable URI of this type.

json_schema
Struct
2

JSON Schema of referenced type; $id field within schema must be prefixed by uri field above.

proto_namestring3

Fully qualified Proto Type name (e.g., "dtkt.email.v1beta1.SendEmailRequest") which resolves to a protobuf message or enum type which must be compatible with above JSON Schema.

mod_time
Timestamp
10

Last modified time.

dtkt.shared.v1beta1messages.proto

DataType

Message

Represents a native data type with json, geo, and metadata details.

FieldTypeNumberDescription
native_typestring1

Name of the native type.

json_type
JSONType
2

Corresponding JSON type representation, if any.

geo_type
GeoType
3

Corresponding Geo type representation, if any.

metadata
Struct
4

Additional metadata, if any.

dtkt.shared.v1beta1messages.proto

OAuthConfig

Message
FieldTypeNumberDescription
client_idstring1

No description.

client_secretstring2

No description.

endpoint
OAuthEndpoint
3

No description.

redirect_urlstring4

Optional redirect URL (can also be supplied per-request).

scopesstring[]5

Requested permissions.

auth_style
AuthStyle
6

Optional: how to auth against token endpoint.

paramsmap<string, string>7

Provider-specific extra params (e.g., access_type=offline, prompt=consent).

dtkt.shared.v1beta1messages.proto

OAuthEndpoint

Message
FieldTypeNumberDescription
auth_urlstring1

No description.

token_urlstring2

No description.

device_auth_urlstring3

No description.

dtkt.shared.v1beta1messages.proto

OAuthCodeRequest

Message
FieldTypeNumberDescription
statestring1

CSRF protection (highly recommended).

redirect_urlstring2

Must match provider registration (may also live in OAuthConfig).

code_challengestring3

PKCE (optional but recommended).

code_challenge_method
CodeChallengeMethod
4

No description.

scopesstring[]5

Optional: override/augment scopes or pass extra params.

paramsmap<string, string>6

No description.

dtkt.shared.v1beta1messages.proto

OAuthTokenRequest

Message
FieldTypeNumberDescription
codestring1

No description.

redirect_urlstring2

No description.

code_verifierstring3

PKCE verifier if PKCE was used.

paramsmap<string, string>10

No description.

dtkt.shared.v1beta1messages.proto

OAuthRefreshRequest

Message
FieldTypeNumberDescription
refresh_tokenstring1

Typically empty: integration uses its stored refresh token. Allow optional override to support migrations or manual repairs.

paramsmap<string, string>10

No description.

dtkt.shared.v1beta1messages.proto

OAuthToken

Message
FieldTypeNumberDescription
access_tokenstring1

No description.

token_typestring2

No description.

refresh_tokenstring3

No description.

expiry
Timestamp
4

No description.

expires_inint645

No description.

dtkt.shared.v1beta1messages.proto

PageToken

Message
FieldTypeNumberDescription
idint641

No description.

time
Timestamp
2

No description.

dtkt.action.v1beta1messages.proto

Action

Message
FieldTypeNumberDescription
namestring1

Resource name: actions/{action_id}

display_namestring2

Human-friendly fields

descriptionstring3

No description.

versionstring4

Versioning & lifecycle

disabledbool5

No description.

deprecation_notestring6

No description.

input
TypeSchema
10

Input/Output schema declarations

output
TypeSchema
11

No description.

labelsmap<string, string>20

Labels/tags for discovery

updated_at
Timestamp
30

When the action definition was last updated.

dtkt.action.v1beta1messages.proto

ListActionsRequest

Message
FieldTypeNumberDescription
page_sizeint321

AIP-158

page_tokenstring2

No description.

filterstring3

AIP-160 (suggested fields: display_name, version, labels.k, disabled)

dtkt.action.v1beta1messages.proto

ListActionsResponse

Message
FieldTypeNumberDescription
actions
Action[]
1

No description.

next_page_tokenstring2

No description.

dtkt.action.v1beta1messages.proto

GetActionRequest

Message
FieldTypeNumberDescription
namestring1

Resource name: actions/{action_id}

dtkt.action.v1beta1messages.proto

GetActionResponse

Message
FieldTypeNumberDescription
action
Action
1

No description.

dtkt.action.v1beta1messages.proto

ExecuteActionRequest

Message
FieldTypeNumberDescription
namestring1

Primary resource name: actions/{action_id} (matches the custom verb binding in services.proto)

input
Struct
10

Input data for the action.

timeout
Duration
20

Execution timeout

dtkt.action.v1beta1messages.proto

ExecuteActionResponse

Message
FieldTypeNumberDescription
namestring1

Echo of the action executed (resource name).

run_idstring2

Server-generated run identifier for tracing.

json
Struct
10

Canonical output for UI/MCP.

proto
Any
11

Optional alternate encoding for SDKs/internal use.

messagestring20

Optional human-readable status.

dtkt.ai.v1beta1messages.proto

EmbeddingModel

Message

Represents an embedding model, including its ID, name, and supported dimensions.

FieldTypeNumberDescription
idstring1

Unique identifier for the embedding model.

namestring2

Name of the embedding model.

min_dimensionsuint323

Minimum number of dimensions supported by the model.

max_dimensionsuint324

Maximum number of dimensions supported by the model.

dtkt.ai.v1beta1messages.proto

EmbeddingInput

Message

Represents an input for generating embeddings.

FieldTypeNumberDescription
idstring1

Unique identifier for the input.

textstring2

Text data to generate embeddings for.

dtkt.ai.v1beta1messages.proto

EmbeddingOutput

Message

Represents the output of an embedding operation.

FieldTypeNumberDescription
input
EmbeddingInput
1

The input data for which the embedding was generated.

vectordouble[]2

The generated embedding vector.

successbool3

Indicates if the embedding generation was successful.

errorstring4

Error message, if any.

dtkt.ai.v1beta1messages.proto

ListEmbeddingModelsRequest

Message

Request to retrieve a list of available embedding models.

dtkt.ai.v1beta1messages.proto

ListEmbeddingModelsResponse

Message

Response containing a list of available embedding models.

FieldTypeNumberDescription
models
EmbeddingModel[]
1

List of embedding models.

dtkt.ai.v1beta1messages.proto

GetEmbeddingModelRequest

Message

Request to retrieve details of a specific embedding model.

FieldTypeNumberDescription
idstring1

ID of the embedding model to retrieve.

dtkt.ai.v1beta1messages.proto

GetEmbeddingModelResponse

Message

Response containing details of a specific embedding model.

FieldTypeNumberDescription
model
EmbeddingModel
1

Details of the requested embedding model.

dtkt.ai.v1beta1messages.proto

CreateEmbeddingsRequest

Message

Request to create embeddings for input text using a specified model.

FieldTypeNumberDescription
model_idstring1

ID of the embedding model to use.

dimensionsuint322

Desired number of dimensions for the embedding.

inputs
EmbeddingInput[]
3

List of text inputs to generate embeddings for.

dtkt.ai.v1beta1messages.proto

CreateEmbeddingsResponse

Message

Response containing the generated embeddings for the input text.

FieldTypeNumberDescription
outputs
EmbeddingOutput[]
1

List of embedding outputs corresponding to the inputs.

dtkt.ai.v1beta1messages.proto

Blob

Message
FieldTypeNumberDescription
media_typestring1

Media Type type/subtype or with parameters type/subtype;parameter=value;parameter2=value2

databytes2

No description.

namestring3

No description.

dtkt.ai.v1beta1messages.proto

Message

Message
FieldTypeNumberDescription
provider_options
Struct
10

No description.

rolestring2

No description.

content
Content[]
3

No description.

dtkt.ai.v1beta1messages.proto

GenerateTextRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateTextResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamTextRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamTextResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateObjectRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateObjectResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamObjectsRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamObjectsResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateImageRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateImageResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateImagesRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateImagesResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateBatchImagesRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateBatchImagesResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateEmbeddingRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateEmbeddingResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateBatchEmbeddingsRequest

Message
FieldTypeNumberDescription
provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateBatchEmbeddingsResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamEmbeddingsRequest

Message
FieldTypeNumberDescription
messages
Message[]
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamEmbeddingsResponse

Message
FieldTypeNumberDescription
provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

TranscribeRequest

Message
FieldTypeNumberDescription
audio
Blob
1

No description.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

TranscribeResponse

Message
FieldTypeNumberDescription
textstring1

No description.

segments
Segment[]
2

No description.

duration
Duration
3

No description.

languagestring4

Detected language; an ISO-639-1 language code

provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateSpeechRequest

Message
FieldTypeNumberDescription
textstring1

No description.

messages
Message[]
2

The input messages / prompts to be synthesized into speech

voicestring3

Provider specific voice identifier

media_typestring4

Output media type, e.g., "audio/mpeg", "audio/wav", "audio/ogg"

speedfloat5

Speech synthesis speed; range and meaning may vary by provider.

languagestring6

The language (input and output); an ISO-639-1 language code or 'auto' to auto-detect. Provider support may vary.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

GenerateSpeechResponse

Message
FieldTypeNumberDescription
audio
Blob
1

No description.

provider_metadata
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamSpeechRequest

Message
FieldTypeNumberDescription
textstring1

No description.

messages
Message[]
2

The input messages / prompts to be synthesized into speech

voicestring3

Provider specific voice identifier

output_media_typestring4

Output media type, e.g., "audio/mpeg", "audio/wav", "audio/ogg"

speedfloat5

Speech synthesis speed; range and meaning may vary by provider.

languagestring6

The language (input and output); an ISO-639-1 language code or 'auto' to auto-detect. Provider support may vary.

provider_options
Struct
10

No description.

dtkt.ai.v1beta1messages.proto

StreamSpeechResponse

Message
FieldTypeNumberDescription
audio
Blob
1

No description.

provider_metadata
Struct
10

No description.

dtkt.base.v1beta1messages.proto

GetPackageRequest

Message
dtkt.base.v1beta1messages.proto

GetPackageResponse

Message
FieldTypeNumberDescription
package
Package
1

Embedded package spec (package.dtkt.yaml).

config_schema
TypeSchema
2

Integration config schema used to validate CheckConfig.

dtkt.base.v1beta1messages.proto

CheckConfigRequest

Message
FieldTypeNumberDescription
connectionstring1

Connection resource of provided config.

config_data
Any
2

Config to validate.

config_hashstring3

Hash of provided config.

config_genuint644

Generation of provided config.

dtkt.base.v1beta1messages.proto

CheckConfigResponse

Message
FieldTypeNumberDescription
validbool1

True if config is valid.

normalized
Struct
2

Normalized/redacted config for UX and diffs (no secrets).

required_scopesstring[]4

Optional hint for missing privileges (e.g., OAuth scopes).

messagestring5

Human-readable summary.

dtkt.base.v1beta1messages.proto

CheckAuthRequest

Message

Request for checking auth (3-legged OAuth over gRPC).

FieldTypeNumberDescription
type
AuthCheck
1

The auth check type.

oauthOneOf

If auth type response is OAuth.

code_request
OAuthCodeRequest
2

When check type is auth code url.

token_request
OAuthTokenRequest
3

When check type is callback.

refresh_request
OAuthRefreshRequest
4

When check type is refresh.

dtkt.base.v1beta1messages.proto

CheckAuthResponse

Message

Response for checking auth.

FieldTypeNumberDescription
type
AuthType
1

The auth type.

successbool2

Indicates if the auth check was successful.

errorstring3

Error message if success is false.

oauthOneOf

Present when type is OAuth.

auth_code_urlstring4

Returned when check is code.

token
OAuthToken
5

Returned when check type is token or refresh.

dtkt.base.v1beta1messages.proto

ListTypesRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

dtkt.base.v1beta1messages.proto

ListTypesResponse

Message
FieldTypeNumberDescription
types
TypeSchema[]
1

Custom types registered to integration.

next_page_tokenstring2

No description.

dtkt.base.v1beta1messages.proto

GetTypeRequest

Message
FieldTypeNumberDescription
namestring1

No description.

dtkt.base.v1beta1messages.proto

GetTypeResponse

Message
FieldTypeNumberDescription
type
TypeSchema
1

No description.

dtkt.blob.v1beta1messages.proto

ListResult

Message
FieldTypeNumberDescription
keystring1

Key for this blob result.

mod_time
Timestamp
2

ModTime is the time the blob was last modified.

sizeint643

Size is the size of the blob's content in bytes.

md5string4

MD5 is an MD5 hash of the blob contents or nil if not available.

is_dirbool5

IsDir indicates that this result represents a "directory" in the hierarchical namespace, ending in ListOptions.Delimiter. Key can be passed as ListOptions.Prefix to list items in the "directory". Fields other than Key and IsDir will not be set if IsDir is true.

dtkt.blob.v1beta1messages.proto

ListBlobsRequest

Message
FieldTypeNumberDescription
prefixstring1

Prefix indicates that only blobs with a key starting with this prefix should be returned.

page_sizeint322

The maximum number of blobs to return. The service may return fewer than this value. If unspecified, at most 50 blobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstring3

A page token, received from a previous ListBlobs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBlobs must match the call that provided the page token.

bucketstring4

Bucket to write blob (may be optional).

dtkt.blob.v1beta1messages.proto

ListBlobsResponse

Message
FieldTypeNumberDescription
results
ListResult[]
1

The results from the specified prefix.

next_page_tokenstring2

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

dtkt.blob.v1beta1messages.proto

GetBlobRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to retrieve attributes.

bucketstring2

Bucket to write blob (may be optional).

dtkt.blob.v1beta1messages.proto

GetBlobResponse

Message
FieldTypeNumberDescription
keystring1

Key of blob of retrieved attributes.

cache_controlstring2

CacheControl specifies caching attributes that services may use when serving the blob. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control

content_dispositionstring3

ContentDisposition specifies whether the blob content is expected to be displayed inline or as an attachment. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

content_encodingstring4

ContentEncoding specifies the encoding used for the blob's content, if any. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding

content_languagestring5

ContentLanguage specifies the language used in the blob's content, if any. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language

content_typestring6

ContentType is the MIME type of the blob. It will not be empty. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type

metadatamap<string, string>7

Metadata holds key/value pairs associated with the blob. Keys are guaranteed to be in lowercase, even if the backend service has case-sensitive keys (although note that Metadata written via this package will always be lowercased). If there are duplicate case-insensitive keys (e.g., "foo" and "FOO"), only one value will be kept, and it is undefined which one.

create_time
Timestamp
8

CreateTime is the time the blob was created, if available. If not available, CreateTime will be the zero time.

mod_time
Timestamp
9

ModTime is the time the blob was last modified.

sizeint6410

Size is the size of the blob's content in bytes.

md5string11

MD5 is an MD5 hash of the blob contents or nil if not available.

etagstring12
dtkt.blob.v1beta1messages.proto

ReadBlobLinesRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to read.

delimiterstring2

Line delimiter; default: \n.

max_sizeint643

Max size (in bytes) of individual line.

bucketstring4

Bucket to read blob (may be optional).

line_format
LineFormat
5

Format of lines to read (default: LINE_FORMAT_RAW if unspecified).

json_array_modebool6

JSON array mode: if true (when line_format is JSON), expects root JSON array; if false, expects newline-delimited JSON (default).

dtkt.blob.v1beta1messages.proto

ReadBlobLinesResponse

Message
FieldTypeNumberDescription
keystring1

Key of blob read.

lineOneOf

No description.

databytes2

Raw line data.

json
Value
3

JSON parsed line data.

dtkt.blob.v1beta1messages.proto

ReadBlobRangeRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to read.

bucketstring2

Bucket to write blob (may be optional).

offsetuint643

Read starting at offset.

lengthint644

Read at most length bytes if greater than 0. If less than 0, reads the whole blob.

dtkt.blob.v1beta1messages.proto

ReadBlobRangeResponse

Message
FieldTypeNumberDescription
keystring1

Key of blob read.

databytes2

Data of blob range.

dtkt.blob.v1beta1messages.proto

WriteBlobRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to write.

bucketstring2

Bucket to write blob (may be optional).

databytes3

Raw blob payload.

content_typestring4

MIME type for the blob payload.

content_languagestring5

Language for the blob payload.

content_encodingstring6

Content encoding for the blob payload.

cache_controlstring7

Cache control directives.

content_dispositionstring8

Content disposition for the blob payload.

metadatamap<string, string>9

Blob metadata (all keys lower-case).

if_matchstring10

Require the blob to match the provided ETag before writing.

if_none_matchstring11

Require the blob to not match the provided ETag before writing.

if_not_existbool12

Require the blob does not already exist before writing.

dtkt.blob.v1beta1messages.proto

WriteBlobResponse

Message
FieldTypeNumberDescription
keystring1

Key of the written blob.

sizeint642

Size of the stored blob.

mod_time
Timestamp
3

Modification time reported by the provider.

etagstring4

ETag assigned by the provider.

dtkt.blob.v1beta1messages.proto

WriteBlobLinesRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to write.

bucketstring2

Bucket to write blob (may be optional).

databytes3

Data of blob line.

dtkt.blob.v1beta1messages.proto

WriteBlobLinesResponse

Message
FieldTypeNumberDescription
results
KeyResult[]
1

No description.

dtkt.blob.v1beta1messages.proto

DeleteBlobRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to delete.

bucketstring2

Bucket to write blob (may be optional).

dtkt.blob.v1beta1messages.proto

DeleteBlobResponse

Message
FieldTypeNumberDescription
deletedbool1

Indicates if the delete operation succeeded.

etagstring2

ETag of the deleted blob if reported.

dtkt.blob.v1beta1messages.proto

CopyBlobRequest

Message
FieldTypeNumberDescription
source_bucketstring1

Source bucket name. If empty, defaults to destination bucket.

source_keystring2

Source key to copy from.

destination_bucketstring3

Destination bucket name

destination_keystring4

Destination key to copy to.

overwritebool5

Overwrite the destination blob when it already exists.

metadatamap<string, string>6

Replacement metadata (optional).

dtkt.blob.v1beta1messages.proto

CopyBlobResponse

Message
FieldTypeNumberDescription
destination_keystring1

Destination key of the copied blob.

sizeint642

Size of the copied blob.

mod_time
Timestamp
3

Modification time reported after copy.

etagstring4

ETag assigned at destination.

dtkt.blob.v1beta1messages.proto

GenerateSignedURLRequest

Message
FieldTypeNumberDescription
keystring1

Key of blob to sign.

bucketstring2

Bucket to write blob (may be optional).

method
SignedURLMethod
3

HTTP method the signed URL will permit.

expires_in
Duration
4

Duration the signed URL remains valid.

content_typestring5

Expected content type when using the signed URL.

query_parametersmap<string, string>6

Additional query parameters enforced by the signed URL.

headersmap<string, string>7

Additional headers enforced by the signed URL.

dtkt.blob.v1beta1messages.proto

GenerateSignedURLResponse

Message
FieldTypeNumberDescription
urlstring1

Fully qualified signed URL.

expires_at
Timestamp
2

Expiration timestamp when the signed URL becomes invalid.

dtkt.catalog.v1beta1messages.proto

Catalog

Message

Represents a catalog, which organizes schemas and tables.

FieldTypeNumberDescription
namestring1

Name of the catalog.

descriptionstring2

Description of the catalog.

metadata
Struct
3

Additional metadata, if any.

dtkt.catalog.v1beta1messages.proto

Schema

Message

Represents a schema, which organizes tables.

FieldTypeNumberDescription
catalog
Catalog
1

Reference to the catalog containing the schema.

namestring2

Name of the schema.

descriptionstring3

Description of the schema.

metadata
Struct
4

Additional metadata, if any.

dtkt.catalog.v1beta1messages.proto

Table

Message

Represents a table within a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the table.

namestring2

Name of the table.

descriptionstring3

Description of the table.

fields
Field[]
4

List of fields contained by the table.

stats
TableStats
5

Statistics about the table (e.g., row count), if any.

metadata
Struct
6

Additional metadata, if any.

dtkt.catalog.v1beta1messages.proto

TableStats

Message

TableStats contains statistics about a table.

FieldTypeNumberDescription
total_rowsint641

The total number of rows in the table.

total_bytesint642

The total size of the table in bytes.

dtkt.catalog.v1beta1messages.proto

Query

Message

Represents a query and its associated details.

FieldTypeNumberDescription
validbool1

Indicates if the query is valid.

errorstring2

Error message, if any.

dialectstring3

The query dialect used.

querystring4

The query string.

fields
Field[]
5

List of fields returned by the query.

params
Param[]
6

Parameters used in the query, if any.

dtkt.catalog.v1beta1messages.proto

GetQueryDialectRequest

Message

Request for retrieving the query dialect.

dtkt.catalog.v1beta1messages.proto

GetQueryDialectResponse

Message

Response containing the query dialect used by the service.

FieldTypeNumberDescription
dialectstring1

The query dialect (e.g., SQL).

dtkt.catalog.v1beta1messages.proto

ListDataTypesRequest

Message

Request for retrieving data types.

dtkt.catalog.v1beta1messages.proto

ListDataTypesResponse

Message

Response containing supported data types.

FieldTypeNumberDescription
types
DataType[]
1

List of supported data types.

dtkt.catalog.v1beta1messages.proto

GetCatalogRequest

Message

Request to retrieve a catalog by name.

FieldTypeNumberDescription
namestring1

Name of the catalog.

metadata
Struct
2

Metadata of the catalog, if any.

dtkt.catalog.v1beta1messages.proto

GetCatalogResponse

Message

Response containing catalog details.

FieldTypeNumberDescription
catalog
Catalog
1

The requested catalog.

dtkt.catalog.v1beta1messages.proto

ListSchemasRequest

Message

Request message for retrieving all schemas.

FieldTypeNumberDescription
catalog
Catalog
1

The catalog request containing catalog information.

dtkt.catalog.v1beta1messages.proto

ListSchemasResponse

Message

Response message for getting schemas.

FieldTypeNumberDescription
schema
Schema
1

The retrieved schema.

dtkt.catalog.v1beta1messages.proto

GetSchemaRequest

Message

Request message for retrieving a specific schema.

FieldTypeNumberDescription
catalog
Catalog
1

The catalog request containing catalog information.

namestring2

The name of the schema to retrieve.

metadata
Struct
3

Metadata of the schema, if any.

dtkt.catalog.v1beta1messages.proto

GetSchemaResponse

Message

Response message for getting a schema.

FieldTypeNumberDescription
schema
Schema
1

The retrieved schema.

dtkt.catalog.v1beta1messages.proto

CreateSchemaRequest

Message

Request message for creating a schema.

FieldTypeNumberDescription
catalog
Catalog
1

Reference to the catalog where the schema will be created.

namestring2

Name of the new schema.

descriptionstring3

Description of the new schema.

metadata
Struct
4

Metadata of the schema, if any.

dtkt.catalog.v1beta1messages.proto

CreateSchemaResponse

Message

Response message for creating a schema.

FieldTypeNumberDescription
schema
Schema
1

The created schema.

createdbool2

Indicates if the schema was successfully created.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

UpdateSchemaRequest

Message

Request message for updating a schema.

FieldTypeNumberDescription
catalog
Catalog
1

Reference to the catalog containing the schema.

namestring2

Name of the schema to update.

descriptionstring3

New description of the schema.

metadata
Struct
4

Metadata of the schema, if any.

dtkt.catalog.v1beta1messages.proto

UpdateSchemaResponse

Message

Response message for updating a schema.

FieldTypeNumberDescription
schema
Schema
1

The updated schema.

updatedbool2

Indicates if the schema was successfully updated.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

DeleteSchemaRequest

Message

Request message for deleting a schema.

FieldTypeNumberDescription
catalog
Catalog
1

Reference to the catalog containing the schema.

namestring2

Name of the schema to delete.

dtkt.catalog.v1beta1messages.proto

DeleteSchemaResponse

Message

Response message for deleting a schema.

FieldTypeNumberDescription
schema
Schema
1

The deleted schema.

deletedbool2

Indicates if the schema was successfully deleted.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

ListTablesRequest

Message

Request message for getting tables in a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the tables.

dtkt.catalog.v1beta1messages.proto

ListTablesResponse

Message

Response message for getting tables.

FieldTypeNumberDescription
table
Table
1

The retrieved table.

dtkt.catalog.v1beta1messages.proto

GetTableRequest

Message

Request message for getting a specific table in a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the table.

namestring2

Name of the table to retrieve.

metadata
Struct
3

Metadata of the table, if any.

dtkt.catalog.v1beta1messages.proto

GetTableResponse

Message

Response message for getting a specific table.

FieldTypeNumberDescription
table
Table
1

The retrieved table.

dtkt.catalog.v1beta1messages.proto

CreateTableRequest

Message

Request message for creating a table in a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema where the table will be created.

namestring2

Name of the new table.

descriptionstring3

Description of the new table.

fields
Field[]
4

Fields of the new table.

metadata
Struct
5

Metadata of the table, if any.

dtkt.catalog.v1beta1messages.proto

CreateTableResponse

Message

Response message for creating a table.

FieldTypeNumberDescription
table
Table
1

The created table.

createdbool2

Indicates if the table was successfully created.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

UpdateTableRequest

Message

Request message for updating a table in a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the table.

namestring2

Name of the table to update.

descriptionstring3

New description of the table.

fields
Field[]
4

Fields of the table.

metadata
Struct
5

Metadata of the table, if any.

dtkt.catalog.v1beta1messages.proto

UpdateTableResponse

Message

Response message for updating a table.

FieldTypeNumberDescription
table
Table
1

The updated table.

updatedbool2

Indicates if the table was successfully updated.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

DeleteTableRequest

Message

Request message for deleting a table in a schema.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the table.

namestring2

Name of the table to delete.

dtkt.catalog.v1beta1messages.proto

DeleteTableResponse

Message

Response message for deleting a table.

FieldTypeNumberDescription
table
Table
1

The deleted table.

deletedbool2

Indicates if the table was successfully deleted.

errorstring3

Error message, if any.

dtkt.catalog.v1beta1messages.proto

WriteTablesRequest

Message

Request message for writing to a table.

FieldTypeNumberDescription
table
Table
1

Reference to the table where row will be written.

row
Struct
2

Row to write to the table.

dtkt.catalog.v1beta1messages.proto

WriteTableResponse

Message

Response message for rows written to a table.

FieldTypeNumberDescription
table
Table
1

Reference to the table where rows were written.

rows_writtenint642

Number of rows successfully written.

dtkt.catalog.v1beta1messages.proto

WriteTablesResponse

Message

Response message for writing rows to multiple tables.

FieldTypeNumberDescription
tables
WriteTableResponse[]
1

Results for each table written.

dtkt.catalog.v1beta1messages.proto

ReadTableRequest

Message

Request message for reading rows from a table.

FieldTypeNumberDescription
schema
Schema
1

Reference to the schema containing the table.

namestring2

Name of the table to read from.

offsetint643

Offset for reading rows.

selected_fieldsstring[]4

Selected fields to read from the table.

dtkt.catalog.v1beta1messages.proto

ReadTableResponse

Message

Response message for reading rows from a table.

FieldTypeNumberDescription
table
Table
1

Reference to the table from which rows were read.

row
Struct
2

A row read from the table.

dtkt.catalog.v1beta1messages.proto

ValidateQueryRequest

Message

Request to validate a query.

FieldTypeNumberDescription
querystring1

The query to validate.

accessible
CatalogPermission[]
2

Accessible catalogs for validation.

params
Param[]
3

Parameters used in the query.

dtkt.catalog.v1beta1messages.proto

ValidateQueryResponse

Message

Response for query validation.

FieldTypeNumberDescription
query
Query
1

Validated query details.

accessed
CatalogPermission[]
2

Permissions accessed by the query.

dtkt.catalog.v1beta1messages.proto

GetQueryResultsRequest

Message

Request to retrieve query results.

FieldTypeNumberDescription
querystring1

The query to execute.

params
Param[]
2

Parameters used in the query.

page_sizeint323

Number of rows per page.

pagestring4

Token for the desired page.

dtkt.catalog.v1beta1messages.proto

GetQueryResultsResponse

Message

Response containing query results.

FieldTypeNumberDescription
query
Query
1

Details of the executed query.

results_page
QueryResultsPage
2

Results page containing rows.

dtkt.catalog.v1beta1messages.proto

StreamQueryResultsRequest

Message

Request to stream query results.

FieldTypeNumberDescription
querystring1

The query to execute.

params
Param[]
2

Parameters used in the query.

dtkt.catalog.v1beta1messages.proto

StreamQueryResultsResponse

Message

Response containing streamed query results.

FieldTypeNumberDescription
query
Query
1

Details of the executed query.

row
Struct
2

A row of query results.

dtkt.catalog.v1beta1messages.proto

ColumnPermission

Message

Represents permissions for a column.

FieldTypeNumberDescription
namestring1

Name of the column.

aliasstring2

Alias for the column.

typestring3

Data type of the column.

dtkt.catalog.v1beta1messages.proto

TablePermission

Message

Represents permissions for a table.

FieldTypeNumberDescription
namestring1

Name of the table.

aliasstring2

Alias for the table.

columns
ColumnPermission[]
3

Column-level permissions.

dtkt.catalog.v1beta1messages.proto

SchemaPermission

Message

Represents permissions for a schema.

FieldTypeNumberDescription
namestring1

Name of the schema.

aliasstring2

Alias for the schema.

tables
TablePermission[]
3

Table-level permissions.

dtkt.catalog.v1beta1messages.proto

CatalogPermission

Message

Represents permissions for a catalog.

FieldTypeNumberDescription
namestring1

Name of the catalog.

aliasstring2

Alias for the catalog.

schemas
SchemaPermission[]
3

Schema-level permissions.

dtkt.catalog.v1beta1messages.proto

QueryResultsPage

Message

Represents a page of query results.

FieldTypeNumberDescription
prev_pagestring1

Token for the previous page of results.

next_pagestring2

Token for the next page of results.

total_pagesuint643

Total number of pages available.

total_rowsuint644

Total number of rows available.

rows_countuint645

Number of rows in the current page.

rows
Struct[]
6

Rows in the current page.

dtkt.catalog.v1beta2type.proto

Type

Message

Type encodes a catalog implementation's native data type with a corresponding kind and additional JSON, Geospatial, and type parameters.

FieldTypeNumberDescription
namestring1

Name of the implementation's native type: (e.g. VARCHAR, BIGINT, etc.).

kind
TypeKind
2

Kind of the type as defined in this package.

json_type
JSONType
3

Corresponding JSON type representation, if any.

geo_type
GeoType
4

Corresponding Geo type representation, if any.

parametersstring[]10

Type parameters, if any: e.g. (parametric types such as VARCHAR(10), DECIMAL(22, 5), etc.)

dtkt.catalog.v1beta2type.proto

Field

Message

Field encodes a named type (see above) definition of a value found in the context of a table read/write or query param/result.

FieldTypeNumberDescription
namestring1

Name of the field.

type
Type
2

Type of the field.

descriptionstring3

Description of the field.

nullablebool4

Indicates if the field allows null values (i.e. a corresponding value is allowed to be null in the context of a table or query).

repeatedbool5

Indicates if the field contains repeated values (i.e. value's kind is expected to be a ListValue with each value conforming to this field's type.

fields
Field[]
6

Fields are nested named type definitions if this field type's kind corresponds with either an object or a JSON value.

element
FieldElement
7

Protoform field element for runtime dynamic form UI.

dtkt.catalog.v1beta2catalog.proto

Catalog

Message

Represents a catalog resource specifying a query dialect, supported data types and additional metadata (if any).

FieldTypeNumberDescription
namestring1

Catalog resource name, format: catalogs/{catalog} (e.g. catalogs/google-project-id, catalogs/postgres_database, etc.)

catalog_idstring2

Catalog identifier.

descriptionstring3

Description of the catalog.

query_dialectstring4

Supported query dialect (e.g., Trino, GoogleSQL, Postgres, etc.).

data_types
Type[]
5

List of supported data types.

metadatamap<string, string>10

Additional metadata, if any.

dtkt.catalog.v1beta2catalog.proto

CreateCatalogRequest

Message

Create catalog request.

FieldTypeNumberDescription
catalog_idstring2

Catalog identifier, e.g. final segment in resource name: catalogs/{catalog}

catalog
Catalog
3

Catalog to create.

dtkt.catalog.v1beta2catalog.proto

CreateCatalogResponse

Message

Create catalog response.

FieldTypeNumberDescription
catalog
Catalog
1

Catalog created.

dtkt.catalog.v1beta2catalog.proto

GetCatalogRequest

Message

Request to retrieve a catalog by name.

FieldTypeNumberDescription
namestring1

Catalog resource to retreve.

dtkt.catalog.v1beta2catalog.proto

GetCatalogResponse

Message

Response containing catalog details.

FieldTypeNumberDescription
catalog
Catalog
1

The requested catalog.

dtkt.catalog.v1beta2catalog.proto

ListCatalogsRequest

Message

List catalogs request.

FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

filterstring4

No description.

dtkt.catalog.v1beta2catalog.proto

ListCatalogsResponse

Message

List catalogs response.

FieldTypeNumberDescription
catalogs
Catalog[]
1

No description.

next_page_tokenstring2

No description.

dtkt.catalog.v1beta2catalog.proto

UpdateCatalogRequest

Message

Update catalog request.

FieldTypeNumberDescription
catalog
Catalog
1

Catalog with updated fields

update_mask
FieldMask
2

Fields to update.

dtkt.catalog.v1beta2catalog.proto

UpdateCatalogResponse

Message

Update catalog response.

FieldTypeNumberDescription
catalog
Catalog
1

The updated catalog.

dtkt.catalog.v1beta2catalog.proto

DeleteCatalogRequest

Message

Delete catalog request.

FieldTypeNumberDescription
namestring1

Name of catalog to delete.

forcebool2

If set to true, any schemas in this catalog will also be deleted. (Otherwise, the request will only work if the catalog has no schemas.)

dtkt.catalog.v1beta2catalog.proto

DeleteCatalogResponse

Message

Delete catalog response.

dtkt.catalog.v1beta2value.proto

Value

Message

Value represents a wide range of native and well-known protobuf types (except signed and unsigned fixed length encodings) with additional nullable semantics intended to provide maximum adaptability and representation for native types found in OLTP databases as well as OLAP data warehouses/query engines.

FieldTypeNumberDescription
kindOneOf

No description.

bool_value
BoolValue
1

No description.

bytes_value
BytesValue
2

No description.

double_value
DoubleValue
3

No description.

enum_value
EnumValue
4

No description.

float_value
FloatValue
5

No description.

int32_value
Int32Value
6

No description.

int64_value
Int64Value
7

No description.

string_value
StringValue
8

No description.

uint32_value
UInt32Value
9

No description.

uint64_value
UInt64Value
10

No description.

json_value
Value
11

No description.

object_value
Any
12

No description.

duration_value
Duration
13

No description.

timestamp_value
Timestamp
14

No description.

list_value
ListValue
15

No description.

dtkt.catalog.v1beta2value.proto

ListValue

Message

List of values for repeated fields.

FieldTypeNumberDescription
values
Value[]
1

No description.

dtkt.catalog.v1beta2value.proto

Row

Message

Row represents a list of values with each value's type defined by a field of the same index in the context of a table read/write operation or a query input param or result operation.

FieldTypeNumberDescription
values
Value[]
1

No description.

dtkt.catalog.v1beta2value.proto

DoubleValue

Message
FieldTypeNumberDescription
valuedouble1

The double value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

FloatValue

Message

Nullable wrapper message for float.

FieldTypeNumberDescription
valuefloat1

The float value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

Int64Value

Message

Nullable wrapper message for int64.

FieldTypeNumberDescription
valueint641

The int64 value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

UInt64Value

Message

Nullable wrapper message for uint64.

FieldTypeNumberDescription
valueuint641

The uint64 value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

Int32Value

Message

Nullable wrapper message for int32.

FieldTypeNumberDescription
valueint321

The int32 value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

UInt32Value

Message

Nullable wrapper message for uint32.

FieldTypeNumberDescription
valueuint321

The uint32 value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

BoolValue

Message

Nullable wrapper message for bool.

FieldTypeNumberDescription
valuebool1

The bool value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

StringValue

Message

Nullable wrapper message for string.

FieldTypeNumberDescription
valuestring1

The string value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

BytesValue

Message

Nullable wrapper message for bytes.

FieldTypeNumberDescription
valuebytes1

The bytes value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2value.proto

EnumValue

Message

Nullable wrapper message for ENUM values.

FieldTypeNumberDescription
valuestring1

The string representation of the ENUM value.

validbool2

Valid is true if value is not NULL.

dtkt.catalog.v1beta2query.proto

Query

Message

Represents a query and its associated details.

FieldTypeNumberDescription
validbool1

Indicates if the query is valid.

errorstring2

Error message, if any.

dialectstring3

The query dialect used.

querystring4

The query string.

params
Param[]
5

Parameters used in the query, if any.

fields
Field[]
6

List of fields returned by the query.

dtkt.catalog.v1beta2query.proto

ValidateQueryRequest

Message

Request to validate a query.

FieldTypeNumberDescription
querystring1

The query to validate.

params
Param[]
2

Parameters used in the query.

accessible
CatalogPermission[]
3

Accessible catalogs for validation.

dtkt.catalog.v1beta2query.proto

ValidateQueryResponse

Message

Response for query validation.

FieldTypeNumberDescription
query
Query
1

Validated query details.

accessed
CatalogPermission[]
2

Permissions accessed by the query.

dtkt.catalog.v1beta2query.proto

ListQueryResultsRequest

Message

Request to retrieve query results.

FieldTypeNumberDescription
querystring1

The query to execute.

page_sizeint322

Number of rows per page.

page_tokenstring3

Token for the desired page (empty for first page).

params
Param[]
10

Parameters used in the query.

dtkt.catalog.v1beta2query.proto

ListQueryResultsResponse

Message

Response containing query results.

FieldTypeNumberDescription
query
Query
1

Details of the executed query.

rows
Row[]
2

A list of query result rows with each row conforming to the fields defined in query.

next_page_tokenstring10

Next page token (empty for last page)

dtkt.catalog.v1beta2query.proto

StreamQueryResultsRequest

Message

Request to stream query results.

FieldTypeNumberDescription
querystring1

The query to execute.

params
Param[]
2

Parameters used in the query.

dtkt.catalog.v1beta2query.proto

StreamQueryResultsResponse

Message

Response containing streamed query results.

FieldTypeNumberDescription
query
Query
1

Details of the executed query.

row
Row
2

A single query result row conforming to the fields defined in query.

dtkt.catalog.v1beta2query.proto

Param

Message

Represents a parameterized value used in a query, input/output, etc.

FieldTypeNumberDescription
field
Field
1

Field describing the param data.

value
Value
2

Value of the parameter, if any.

dtkt.catalog.v1beta2query.proto

CatalogPermission

Message

Represents permissions for a catalog.

FieldTypeNumberDescription
namestring1

Name of the catalog.

aliasstring2

Alias for the catalog.

schemas
SchemaPermission[]
3

Schema-level permissions.

dtkt.catalog.v1beta2query.proto

SchemaPermission

Message

Represents permissions for a schema.

FieldTypeNumberDescription
namestring1

Name of the schema.

aliasstring2

Alias for the schema.

tables
TablePermission[]
3

Table-level permissions.

dtkt.catalog.v1beta2query.proto

TablePermission

Message

Represents permissions for a table.

FieldTypeNumberDescription
namestring1

Name of the table.

aliasstring2

Alias for the table.

columns
ColumnPermission[]
3

Column-level permissions.

dtkt.catalog.v1beta2query.proto

ColumnPermission

Message

Represents permissions for a column.

FieldTypeNumberDescription
namestring1

Name of the column.

aliasstring2

Alias for the column.

typestring3

Data type of the column.

dtkt.catalog.v1beta2schema.proto

Schema

Message

Schema resource containing tables.

FieldTypeNumberDescription
namestring1

Schema resource name, format: catalogs/{catalog}/schemas/{schema}.

schema_idstring2

Schema identifier.

descriptionstring3

Description of the schema.

metadatamap<string, string>4

Additional metadata, if any.

dtkt.catalog.v1beta2schema.proto

ListSchemasRequest

Message

Request message for listing schemas.

FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

No description.

filterstring4

No description.

dtkt.catalog.v1beta2schema.proto

ListSchemasResponse

Message

Response message for listing schemas.

FieldTypeNumberDescription
schemas
Schema[]
1

No description.

next_page_tokenstring2

No description.

dtkt.catalog.v1beta2schema.proto

GetSchemaRequest

Message

Get schema request.

FieldTypeNumberDescription
namestring1

Schema resource name to retrieve.

metadatamap<string, string>2

Metadata of the schema, if any.

dtkt.catalog.v1beta2schema.proto

GetSchemaResponse

Message

Get schema response.

FieldTypeNumberDescription
schema
Schema
1

The retrieved schema.

dtkt.catalog.v1beta2schema.proto

CreateSchemaRequest

Message

Create schema request.

FieldTypeNumberDescription
parentstring1

Parent catalog resource name.

schema_idstring2

Schema identifier, e.g. final segment in resource name: .../schemas/{schema}

schema
Schema
3

Schema to create.

dtkt.catalog.v1beta2schema.proto

CreateSchemaResponse

Message

Create schema response.

FieldTypeNumberDescription
schema
Schema
1

Schema created.

dtkt.catalog.v1beta2schema.proto

UpdateSchemaRequest

Message

Update schema request.

FieldTypeNumberDescription
schema
Schema
1

Schema with updated fields

update_mask
FieldMask
2

Fields to update.

dtkt.catalog.v1beta2schema.proto

UpdateSchemaResponse

Message

Update schema response.

FieldTypeNumberDescription
schema
Schema
1

The updated schema.

dtkt.catalog.v1beta2schema.proto

DeleteSchemaRequest

Message

Request message for deleting a schema.

FieldTypeNumberDescription
namestring1

Name of schema to delete.

forcebool2

If set to true, any tables in this schema will also be deleted. (Otherwise, the request will only work if the schema has no tables.)

dtkt.catalog.v1beta2schema.proto

DeleteSchemaResponse

Message

Response message for deleting a schema.

dtkt.catalog.v1beta2table.proto

Table

Message

Represents a table within a table.

FieldTypeNumberDescription
namestring1

Table resource name, format: catalogs/{catalog}/schemas/{schema}/tables/{table}.

table_idstring2

Table identifier.

descriptionstring3

Description of the table.

fields
Field[]
34

List of fields defined by the table.

stats
TableStats
5

Statistics about the table (e.g., row count), if any.

metadatamap<string, string>10

Additional metadata, if any.

dtkt.catalog.v1beta2table.proto

TableStats

Message

TableStats contains statistics about a table.

FieldTypeNumberDescription
total_rowsint641

The total number of rows in the table.

total_bytesint642

The total size of the table in bytes.

dtkt.catalog.v1beta2table.proto

ListTablesRequest

Message

Request message for listing Tables.

FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

No description.

filterstring4

No description.

dtkt.catalog.v1beta2table.proto

ListTablesResponse

Message

Response message for listing Tables.

FieldTypeNumberDescription
tables
Table[]
1

No description.

next_page_tokenstring2

No description.

dtkt.catalog.v1beta2table.proto

GetTableRequest

Message

Get Table request.

FieldTypeNumberDescription
namestring1

Table resource name to retrieve.

metadatamap<string, string>2

Metadata of the Table, if any.

dtkt.catalog.v1beta2table.proto

GetTableResponse

Message

Get Table response.

FieldTypeNumberDescription
table
Table
1

The retrieved Table.

dtkt.catalog.v1beta2table.proto

CreateTableRequest

Message

Create Table request.

FieldTypeNumberDescription
parentstring1

Parent catalog resource name.

table_idstring2

Table identifier, e.g. final segment in resource name: .../tables/{table}

table
Table
3

Table to create.

dtkt.catalog.v1beta2table.proto

CreateTableResponse

Message

Create Table response.

FieldTypeNumberDescription
table
Table
1

Table created.

dtkt.catalog.v1beta2table.proto

UpdateTableRequest

Message

Update Table request.

FieldTypeNumberDescription
table
Table
1

Table with updated fields

update_mask
FieldMask
2

Fields to update.

dtkt.catalog.v1beta2table.proto

UpdateTableResponse

Message

Update Table response.

FieldTypeNumberDescription
table
Table
1

The updated Table.

dtkt.catalog.v1beta2table.proto

DeleteTableRequest

Message

Request message for deleting a table.

FieldTypeNumberDescription
namestring1

Name of table to delete.

dtkt.catalog.v1beta2table.proto

DeleteTableResponse

Message

Response message for deleting a table.

dtkt.catalog.v1beta2table.proto

WriteRowsRequest

Message

Request message for writing to a table.

FieldTypeNumberDescription
tablestring1

Table resource name to write row.

row
Row
2

A single row to be written to table and conforming to the description found in value.proto.

dtkt.catalog.v1beta2table.proto

WriteRowsResponse

Message

Response message for rows written to a table.

FieldTypeNumberDescription
table_rows_writtenmap<string, int64>1

Map of table resource name to total rows written.

dtkt.catalog.v1beta2table.proto

ReadRowsRequest

Message

Request message for reading rows from a table.

FieldTypeNumberDescription
tablestring1

Table resource name to read row.

offsetint642

Offset for reading rows.

selected_fieldsstring[]3

Selected fields to read from the table.

dtkt.catalog.v1beta2table.proto

ReadRowsResponse

Message

Response message for reading rows from a table.

FieldTypeNumberDescription
tablestring1

Table resource name to read row.

rows
Row[]
6

A list of rows read from table with each row representing a subset of a table's fields and each value conforming to the description found in value.proto.

dtkt.command.v1beta1messages.proto

SSHConfig

Message

Configuration for remote SSH execution.

FieldTypeNumberDescription
addressstring1

Hostname or IP address and port of the SSH server

userstring2

Username for SSH authentication

authOneOf

Authentication method If not provided, uses SSH agent by default (matches SSH CLI behavior)

private_key
PrivateKeyAuth
3

Private key authentication

identity_file
IdentityFileAuth
4

Identity file authentication

passwordstring5

Password authentication (not recommended - use key-based auth)

host_key_verificationOneOf

Host key verification method If unset, defaults to Trust On First Use (TOFU) using ~/.ssh/known_hosts_tofu

tofu_file_pathstring6

Trust On First Use: Accept any key on first connection, store it, then verify against stored key on subsequent connections. Specifies custom path for storing trusted keys.

known_hosts
KnownHosts
7

Verify against known_hosts files (uses default locations if empty)

fingerprintstring8

Verify against specific fingerprint (SHA256 or MD5 format) Examples: "SHA256:abc123..." or "MD5:12:34:56:..." Get fingerprint: ssh-keyscan -p <port> <host> 2>/dev/null | ssh-keygen -lf -

insecure_skip_verifybool9

Skip verification (INSECURE)

proxy_commandstring10

ProxyCommand to tunnel SSH connection through another command Example: cloudflared access ssh --hostname %h Supports variable expansion: %h=hostname, %p=port, %r=remote-user Takes precedence over config_file_path ProxyCommand if both are set

config_file_pathstring11

Path to SSH config file for default settings If unset, defaults to ~/.ssh/config Explicit settings above take precedence over config file values

dtkt.command.v1beta1messages.proto

CommandDoc

Message

Describes a command.

FieldTypeNumberDescription
usagestring1

No description.

shortstring2

No description.

longstring3

No description.

examplesstring[]4

No description.

flags
FlagDoc[]
5

No description.

inherited_flags
FlagDoc[]
6

No description.

dtkt.command.v1beta1messages.proto

FlagDoc

Message

Describes a command flag.

FieldTypeNumberDescription
namestring1

No description.

shorthandstring2

No description.

usagestring3

No description.

default_valuestring4

No description.

dtkt.command.v1beta1messages.proto

Command

Message
FieldTypeNumberDescription
namestring1

No description.

descriptionstring2

No description.

commands
CommandDoc[]
3

No description.

dtkt.command.v1beta1messages.proto

ListCommandsResponse

Message
FieldTypeNumberDescription
commands
Command[]
1

No description.

dtkt.command.v1beta1messages.proto

GetCommandRequest

Message
FieldTypeNumberDescription
namestring1

No description.

dtkt.command.v1beta1messages.proto

GetCommandResponse

Message
FieldTypeNumberDescription
command
Command[]
1

No description.

dtkt.command.v1beta1messages.proto

ExecutableCommand

Message

A command to execute.

FieldTypeNumberDescription
commandstring1

Command executable.

argsstring[]2

No description.

workdirstring3

No description.

envmap<string, string>4

No description.

timeout
Duration
5

No description.

expects_stdinbool6

Indicates whether this command expects stdin input. When false, stdin is not opened (command has no stdin). When true, stdin is opened and remains available for streaming input until EOF is explicitly sent. Default: false (most commands don't need stdin)

dtkt.command.v1beta1messages.proto

ShellCommand

Message

A shell command to execute.

FieldTypeNumberDescription
commandstring1

The shell command (supports pipes and redirects).

workdirstring3

No description.

envmap<string, string>4

No description.

timeout
Duration
5

No description.

expects_stdinbool6

Indicates whether this command expects stdin input. When false, stdin is not opened (command has no stdin). When true, stdin is opened and remains available for streaming input until EOF is explicitly sent. Default: false (most commands don't need stdin)

dtkt.command.v1beta1messages.proto

CommandInput

Message

A single stdin chunk or signal for streaming commands.

FieldTypeNumberDescription
stdinbytes1

No description.

eofbool2

No description.

signal
Signal
3

No description.

dtkt.command.v1beta1messages.proto

CommandOutput

Message

stdout and stderr chunks

FieldTypeNumberDescription
stdoutbytes1

No description.

stderrbytes2

No description.

dtkt.command.v1beta1messages.proto

CommandResult

Message

The result of a command execution.

FieldTypeNumberDescription
exit_codeint321

No description.

reason
Reason
2

No description.

duration
Duration
3

No description.

dtkt.command.v1beta1messages.proto

BatchResult

Message
FieldTypeNumberDescription
output
CommandOutput
1

No description.

result
CommandResult
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteCommandRequest

Message

The request for executing a command.

FieldTypeNumberDescription
command
ExecutableCommand
1

The command to execute

input
CommandInput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteCommandResponse

Message

The response for executing a command.

FieldTypeNumberDescription
result
CommandResult
1

No description.

output
CommandOutput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteCommandsRequest

Message

The request for executing a stream of commands.

FieldTypeNumberDescription
command
ExecutableCommand
1

Command to execute

dtkt.command.v1beta1messages.proto

ExecuteCommandsResponse

Message

The response for executing a stream of commands.

FieldTypeNumberDescription
result
CommandResult
1

No description.

output
CommandOutput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteStreamedCommandRequest

Message

The request for streaming a single command.

FieldTypeNumberDescription
command
ExecutableCommand
1

No description.

input
CommandInput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteStreamedCommandResponse

Message

The response for streaming a single command.

FieldTypeNumberDescription
output
CommandOutput
1

No description.

result
CommandResult
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteBatchCommandsRequest

Message

The request for executing a batch of commands.

FieldTypeNumberDescription
commands
ExecutableCommand[]
1

No description.

dtkt.command.v1beta1messages.proto

ExecuteBatchCommandsResponse

Message

The response for executing a batch of commands.

FieldTypeNumberDescription
results
BatchResult[]
1

No description.

dtkt.command.v1beta1messages.proto

ExecuteShellCommandRequest

Message

The request for executing a shell command.

FieldTypeNumberDescription
command
ShellCommand
1

The shell command to execute

dtkt.command.v1beta1messages.proto

ExecuteShellCommandResponse

Message

The response for executing a shell command.

FieldTypeNumberDescription
result
CommandResult
1

No description.

output
CommandOutput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteShellCommandsRequest

Message

The request for executing a stream of shell commands.

FieldTypeNumberDescription
command
ShellCommand
1

Shell command to execute

dtkt.command.v1beta1messages.proto

ExecuteShellCommandsResponse

Message

The response for executing a stream of shell commands.

FieldTypeNumberDescription
result
CommandResult
1

No description.

output
CommandOutput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteStreamedShellCommandRequest

Message

The request for streaming a single shell command.

FieldTypeNumberDescription
command
ShellCommand
1

No description.

input
CommandInput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteStreamedShellCommandResponse

Message

The response for streaming a single shell command.

FieldTypeNumberDescription
result
CommandResult
1

No description.

output
CommandOutput
2

No description.

dtkt.command.v1beta1messages.proto

ExecuteBatchShellCommandsRequest

Message

The request for executing a batch of shell commands.

FieldTypeNumberDescription
commands
ShellCommand[]
1

No description.

dtkt.command.v1beta1messages.proto

ExecuteBatchShellCommandsResponse

Message

The response for executing a batch of shell commands.

FieldTypeNumberDescription
results
BatchResult[]
1

No description.

dtkt.command.v1beta1messages.proto

TerminalSessionRequest

Message

The request for a terminal session and streaming in input.

dtkt.command.v1beta1messages.proto

TerminalSessionResponse

Message

The response for a terminal session.

FieldTypeNumberDescription
output
CommandOutput
1

No description.

dtkt.flow.v1beta1type.proto

Bool

Message
FieldTypeNumberDescription
defaultbool1

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Bytes

Message
FieldTypeNumberDescription
defaultbytes1

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Double

Message
FieldTypeNumberDescription
defaultdouble1

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Float

Message
FieldTypeNumberDescription
defaultfloat1

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Int64

Message
FieldTypeNumberDescription
defaultint641

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Uint64

Message
FieldTypeNumberDescription
defaultuint641

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Int32

Message
FieldTypeNumberDescription
defaultint321

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

Uint32

Message
FieldTypeNumberDescription
defaultuint321

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

String

Message
FieldTypeNumberDescription
defaultstring1

No description.

nullablebool2

No description.

dtkt.flow.v1beta1type.proto

List

Message
FieldTypeNumberDescription
itemsstring1

Type of list items: scalar type, nested list/map, or message type

nullablebool2

No description.

default
ListValue
3

No description.

dtkt.flow.v1beta1type.proto

Map

Message
FieldTypeNumberDescription
keystring1

Key type: bool, int32, int64, uint32, uint64, or string (default)

valuestring2

Value type: scalar type, nested list/map, or message type

nullablebool3

No description.

default
Struct
4

No description.

dtkt.flow.v1beta1type.proto

Message

Message

Proto message type

FieldTypeNumberDescription
typestring1

Fully qualified message name: "google.protobuf.Struct", "google.protobuf.Timestamp", etc.

nullablebool2

No description.

default
Struct
3

No description.

dtkt.flow.v1beta1spec.proto

Flow

Message
FieldTypeNumberDescription
namestring1

No description.

descriptionstring2

No description.

connections
Connection[]
3

No description.

inputs
Input[]
4

No description.

vars
Var[]
5

No description.

actions
Action[]
7

No description.

outputs
Output[]
9

No description.

streams
Stream[]
10

No description.

dtkt.flow.v1beta1spec.proto

Connection

Message
FieldTypeNumberDescription
idstring1

No description.

servicesstring[]2

No description.

package
Identity
3

No description.

dtkt.flow.v1beta1spec.proto

Input

Message
FieldTypeNumberDescription
idstring1

No description.

typeOneOf

No description.

bool
Bool
3

No description.

bytes
Bytes
4

No description.

double
Double
5

No description.

float
Float
6

No description.

int64
Int64
7

No description.

uint64
Uint64
8

No description.

int32
Int32
9

No description.

uint32
Uint32
10

No description.

string
String
11

No description.

list
List
12

No description.

map
Map
13

No description.

message
Message
14

No description.

cachebool20

No description.

dtkt.flow.v1beta1spec.proto

Var

Message

Var is an intermediate value in a Flow used to transform and/or memoize the result of a computation for reuse.

FieldTypeNumberDescription
idstring1

No description.

cachebool2

When cache is true var always returns its first non-null memoized value.

typeOneOf

No description.

valuestring3

Given expression evaluates to var's memoized value, example: "= inputs.foo.getValue()"

switch
Switch
4

Given switch statement's first matching case (otherwise default) evaluates to var's memoized value.

dtkt.flow.v1beta1spec.proto

Action

Message
FieldTypeNumberDescription
idstring1

No description.

run_ifstring2

No description.

on_errorstring3

No description.

cachebool10

When cache is true action always returns its first non-null memoized value.

typeOneOf

No description.

call
MethodCall
4

No description.

user
UserAction
5

No description.

dtkt.flow.v1beta1spec.proto

Output

Message
FieldTypeNumberDescription
idstring1

No description.

valuestring2

No description.

dtkt.flow.v1beta1spec.proto

Stream

Message
FieldTypeNumberDescription
idstring1

No description.

start_ifstring10

Start stream when expression evaluates to true; optional.

stop_ifstring11

Stop stream when expression evaluates to true; optional.

typeOneOf

No description.

call
MethodCall
2

No description.

generate
Ticker
3

No description.

dtkt.flow.v1beta1spec.proto

MethodCall

Message
FieldTypeNumberDescription
connectionstring1

No description.

methodstring2

No description.

request
Value
3

No description.

responsestring4

No description.

dtkt.flow.v1beta1spec.proto

UserAction

Message
FieldTypeNumberDescription
inputs
Input[]
1

No description.

dtkt.flow.v1beta1spec.proto

Switch

Message
FieldTypeNumberDescription
valuestring1

No description.

case
Case[]
2

No description.

defaultstring3

No description.

dtkt.flow.v1beta1spec.proto

Ticker

Message
FieldTypeNumberDescription
every
Duration
1

No description.

initial
Duration
2

No description.

valuestring3

No description.

dtkt.flow.v1beta1eval.proto

Runtime

Message
dtkt.flow.v1beta1eval.proto

Graph

Message
FieldTypeNumberDescription
nodes
Node[]
1

No description.

edges
Edge[]
2

No description.

dtkt.flow.v1beta1eval.proto

Groups

Message
FieldTypeNumberDescription
groups
Group[]
1

No description.

dtkt.flow.v1beta1eval.proto

Edge

Message
FieldTypeNumberDescription
sourcestring1

No description.

targetstring2

No description.

dtkt.flow.v1beta1eval.proto

Node

Message
FieldTypeNumberDescription
idstring1

No description.

state
State
2

No description.

call_countuint644

No description.

prev_value
Value
5

No description.

curr_value
Value
6

No description.

typeOneOf

No description.

connection
Connection
7

No description.

input
Input
8

No description.

var
Var
9

No description.

action
Action
11

No description.

output
Output
13

No description.

stream
Stream
14

No description.

dtkt.core.v1messages.proto

Automation

Message

Automation is a runnable instance of a Flow with a tagged spec version and runtime configuration.

FieldTypeNumberDescription
namestring1

Automation resource name is one of:

  • Cloud: organizations/{organization}/automations/{automation}
  • Local: users/{user}/automations/{automation}
uidstring2

Server-assigned unique ID (UUID).

flowstring3

Name of flow resource to resolve spec.

etagstring4

Checksum of flow spec must match when resolving spec (concurrency control).

exec
ExecutionMetadata
5

Execution metadata of resolved Flow spec (versioned).

connections
map<string, ConnectionMetadata>
6

Connections configuration as map of connection node id to connection resource name and context (control plane). Examples:

inputs
map<string, Any>
7

Initial inputs configuration as map of input node id to valid data of input node's declared type (well-known type wrappers used for scalar values). Format:

timeout
Duration
8

Execution is stopped if total time exceeds given duration. Default: 0; no timeout

batchstring9

Server-assigned batch name if created within a batch (optional).

create_time
Timestamp
20

Automation create time.

update_time
Timestamp
21

Automation update time.

dtkt.core.v1messages.proto

Flow

Message

Flow is a versioned workflow spec with parsed graph representation.

FieldTypeNumberDescription
namestring1

Flow resource name is one of:

  • Cloud: organizations/{organization}/flows/{flow}
  • Local: users/{user}/flows/{flow}
uidstring2

Server-assigned unique ID (UUID).

spec_uristring3

Spec source URI (optional).

spec_etagstring4

Spec source checksum for concurrency control.

spec
SpecMetadata
5

Resolved flow spec (versioned).

graph
GraphMetadata
6

Parsed flow graph (versioned).

create_time
Timestamp
20

Flow create time.

update_time
Timestamp
21

Flow update time.

dtkt.core.v1messages.proto

Connection

Message

Connection combines necessary components of a configured client to one of:

  • Deployment server with first-class configuration support from DataKit
  • Any reachable gRPC server with DIY configuration, one of:
    • Custom proto file descriptors as a URI resolving to source .proto files
    • Custom proto file descriptors using gRPC reflection (must be enabled on server)
FieldTypeNumberDescription
namestring1

Connection resource name is one of:

  • Cloud: organizations/{organization}/connections/{connection}
  • Local: users/{user}/connections/{connection}
uidstring2

Server-assigned unique ID (UUID).

typeOneOf

No description.

deploymentstring3

Name of a deployment resource.

custom_protosstring4

Custom proto descriptors URI.

custom_grpcbool5

Custom using gRPC reflection.

address
Address
6

Address of gRPC server.

config_data
Any
10

Config data compatible with integration config schema.

config_hashstring11

Hash of config data.

config_genuint6412

Generation of config data.

config_uristring13

Config source uri (optional).

headersmap<string, string>14

Headers applied when dialing connection.

create_time
Timestamp
20

Connection create time.

update_time
Timestamp
21

Connection update time.

dtkt.core.v1messages.proto

Deployment

Message

Deployment is a runnable instance of an Integration with a tagged build artifact and runtime configuration.

FieldTypeNumberDescription
namestring1

Deployment resource name is one of:

  • Cloud: organizations/{organization}/integrations/{integration}/deployments/{deployment}
  • Local: users/{user}/integrations/{integration}/deployments/{deployment}
uidstring2

Server-assigned unique ID (UUID).

address
Address
3

Bind address of deployment.

build_uristring4

URI of build artifact.

build_etagstring5

Checksum of build artifact for concurrency control.

envmap<string, string>6

Env vars applied at runtime.

portsmap<string, string>7

Port mappings applied at runtime.

create_time
Timestamp
20

Deployment create time.

update_time
Timestamp
21

Deployment update time.

dtkt.core.v1messages.proto

Integration

Message

Integration describes a software package which uses the DataKit SDK making it natively compatible with DataKit's build and run tooling & infrastructure.

FieldTypeNumberDescription
namestring1

Integration resource name, one of:

  • Cloud: organizations/{organization}/integrations/{integration}
  • Local: users/{user}/integrations/{integration}
uidstring2

Server-assigned unique ID (UUID).

spec_uristring3

Package spec URI.

spec_etagstring4

Package spec checksum for concurrency control.

spec
SpecMetadata
5

Versioned package spec.

cloud
CloudMetadata
6

Cloud metadata (only present when running on cloud network).

build
BuildMetadata
7

Build metadata (only present when developing locally).

create_time
Timestamp
20

Integration create time.

update_time
Timestamp
21

Integration update time.

dtkt.core.v1messages.proto

Service

Message

Service message for documentation and reflection indexing.

FieldTypeNumberDescription
namestring1

No description.

descriptionstring2

No description.

methods
Method[]
3

No description.

parentstring20

Parent resource name, one of:

  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
dtkt.core.v1messages.proto

Method

Message

Method message for documentation and reflection indexing.

FieldTypeNumberDescription
namestring1

No description.

descriptionstring2

No description.

requeststring3

No description.

responsestring4

No description.

request_streamingbool5

No description.

response_streamingbool6

No description.

parentstring20

Parent resource name, one of:

  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
dtkt.core.v1messages.proto

Type

Message

Type message for documentation and reflection indexing.

FieldTypeNumberDescription
namestring1

Type name

schema
TypeSchema
2

Type schema

system_typebool3

True if this is a system type (has no parent)

parentstring4

Parent resource name, one of:

  • System (no parent): nil | ""
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
dtkt.core.v1messages.proto

Resource

Message

Resource combines any data-plane message with context enabling auditing, tracing, and observability across network boundaries.

FieldTypeNumberDescription
message
Any
1

No description.

context
Context
2

No description.

dtkt.core.v1messages.proto

Context

Message

Context provides the name and address of a control plane and an optional connection resource name used for data plane resource tracing.

FieldTypeNumberDescription
namestring1

No description.

addressstring2

No description.

connectionstring3

No description.

dtkt.core.v1messages.proto

CloudMetadata

Message
FieldTypeNumberDescription
bind_configbytes1

Cloud network bind configuration.

dtkt.core.v1messages.proto

BuildMetadata

Message
FieldTypeNumberDescription
runtime
Runtime
1

Target runtime of build artifact.

platform
Platform
2

Target platform of build artifact.

envmap<string, string>3

Env vars.

source_uristring4

URI of build source.

target_uristring5

URI of build target artifact.

target_etagstring10

Checksum of build target artifact (present if build is successful).

dtkt.core.v1messages.proto

DialMetadata

Message
FieldTypeNumberDescription
state
State
1

Connection dial state.

messagestring2

Connection dial message.

time
Timestamp
3

Connection dial time.

dtkt.core.v1messages.proto

BuildOperationMetadata

Message
FieldTypeNumberDescription
state
State
1

Build state.

messagestring2

Build status message.

start_time
Timestamp
20

Build start time.

finish_time
Timestamp
21

Build finish time.

dtkt.core.v1messages.proto

RunOperationMetadata

Message
FieldTypeNumberDescription
state
State
1

Run state.

messagestring2

Run status message.

start_time
Timestamp
20

Run start time.

stop_time
Timestamp
21

Run stop time.

dtkt.core.v1messages.proto

BatchRunOperationMetadata

Message
FieldTypeNumberDescription
failed_requests
map<int32, Status>
1

No description.

dtkt.core.v1messages.proto

GetAutomationRequest

Message
FieldTypeNumberDescription
namestring1

Name of Automation resource to get.

dtkt.core.v1messages.proto

GetAutomationResponse

Message
FieldTypeNumberDescription
automation
Automation
1

No description.

dtkt.core.v1messages.proto

CreateAutomationRequest

Message
FieldTypeNumberDescription
parentstring1

Parent resource name. Format is one of:

  • users/{user}
  • organizations/{organization}
automation_idstring2

No description.

automation
Automation
3

No description.

dtkt.core.v1messages.proto

CreateAutomationResponse

Message
FieldTypeNumberDescription
automation
Automation
1

No description.

dtkt.core.v1messages.proto

BatchCreateAutomationsRequest

Message
FieldTypeNumberDescription
parentstring1

Parent resource name shared by all automations this batch. Format is one of:

  • users/{user}
  • organizations/{organization}
requests
CreateAutomationRequest[]
2

No description.

dtkt.core.v1messages.proto

BatchCreateAutomationsResponse

Message
FieldTypeNumberDescription
automations
Automation[]
1

No description.

dtkt.core.v1messages.proto

ListAutomationsRequest

Message
FieldTypeNumberDescription
parentstring1

Parent: organizations/{organization} or users/{user}

page_sizeint322

No description.

page_tokenstring3

No description.

filterstring4

No description.

dtkt.core.v1messages.proto

ListAutomationsResponse

Message
FieldTypeNumberDescription
automations
Automation[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

SendAutomationEvent

Message
FieldTypeNumberDescription
typeOneOf

No description.

inputs_event
InputsEvent
1

No description.

user_response_event
UserResponseEvent
2

No description.

dtkt.core.v1messages.proto

ReceiveAutomationEvent

Message
FieldTypeNumberDescription
typeOneOf

No description.

outputs_event
OutputsEvent
1

No description.

user_request_event
UserRequestEvent
2

No description.

dtkt.core.v1messages.proto

SendAutomationEventRequest

Message
FieldTypeNumberDescription
namestring1

Name of Automation resource to send event.

event
SendAutomationEvent
2

Event to send.

dtkt.core.v1messages.proto

ReceiveAutomationEventsRequest

Message
FieldTypeNumberDescription
namestring1

Name of Automation resource to receive events.

dtkt.core.v1messages.proto

ReceiveAutomationEventsResponse

Message
FieldTypeNumberDescription
event
ReceiveAutomationEvent
2

No description.

dtkt.core.v1messages.proto

StreamAutomationEventsRequest

Message
FieldTypeNumberDescription
namestring1

Name of Automation resource to send event.

event
SendAutomationEvent
2

No description.

dtkt.core.v1messages.proto

StreamAutomationEventsResponse

Message
FieldTypeNumberDescription
event
ReceiveAutomationEvent
1

No description.

dtkt.core.v1messages.proto

ListConnectionsRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

Parent: organizations/{organization} or users/{user}

filterstring4

No description.

integrationstring5

No description.

dtkt.core.v1messages.proto

ListConnectionsResponse

Message
FieldTypeNumberDescription
connections
Connection[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

GetConnectionRequest

Message
FieldTypeNumberDescription
namestring1

No description.

dtkt.core.v1messages.proto

GetConnectionResponse

Message
FieldTypeNumberDescription
connection
Connection
1

No description.

dtkt.core.v1messages.proto

CreateConnectionRequest

Message
FieldTypeNumberDescription
parentstring1

No description.

connection_idstring2

No description.

connection
Connection
3

No description.

dtkt.core.v1messages.proto

CreateConnectionResponse

Message
FieldTypeNumberDescription
connection
Connection
1

No description.

dtkt.core.v1messages.proto

UpdateConnectionRequest

Message
FieldTypeNumberDescription
connection
Connection
1

The connection with updated fields. Must include name.

update_mask
FieldMask
2

Fields to update (e.g., "config_data,integration").

dtkt.core.v1messages.proto

UpdateConnectionResponse

Message
FieldTypeNumberDescription
connection
Connection
1

No description.

dtkt.core.v1messages.proto

DeleteConnectionRequest

Message
FieldTypeNumberDescription
namestring1

Name of connection to delete.

dtkt.core.v1messages.proto

DeleteConnectionResponse

Message
dtkt.core.v1messages.proto

DialConnectionRequest

Message
FieldTypeNumberDescription
targetOneOf

No description.

namestring1

Name of connection to dial.

addr
Address
2

Address of connection to dial.

dtkt.core.v1messages.proto

DialConnectionResponse

Message
FieldTypeNumberDescription
dial
DialMetadata
1

No description.

dtkt.core.v1messages.proto

StoreDescriptorsRequest

Message
FieldTypeNumberDescription
parentstring1

Name of parent resource.

descriptors
FileDescriptorSet
2

Proto descriptor file set to store.

dtkt.core.v1messages.proto

StoreDescriptorsResponse

Message
dtkt.core.v1messages.proto

LoadDescriptorsRequest

Message
FieldTypeNumberDescription
parentstring1

Name of parent resource.

dtkt.core.v1messages.proto

LoadDescriptorsResponse

Message
FieldTypeNumberDescription
descriptors
FileDescriptorSet
1

Proto descriptor file set.

dtkt.core.v1messages.proto

ListDeploymentsRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

Parent: organizations/{organization}/integrations/{integration} or users/{user}/integrations/{integration}

filterstring4

No description.

dtkt.core.v1messages.proto

ListDeploymentsResponse

Message
FieldTypeNumberDescription
deployments
Deployment[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

GetDeploymentRequest

Message
FieldTypeNumberDescription
namestring1

No description.

dtkt.core.v1messages.proto

GetDeploymentResponse

Message
FieldTypeNumberDescription
deployment
Deployment
1

No description.

dtkt.core.v1messages.proto

CreateDeploymentRequest

Message
FieldTypeNumberDescription
deployment_idstring1

No description.

deployment
Deployment
2

Deployment to create (name ignored; server sets it).

parentstring3

Parent: organizations/{organization}/connections/{connection} or users/{user}/connections/{connection}

dtkt.core.v1messages.proto

CreateDeploymentResponse

Message
FieldTypeNumberDescription
deployment
Deployment
1

No description.

dtkt.core.v1messages.proto

UpdateDeploymentRequest

Message
FieldTypeNumberDescription
deployment
Deployment
1

Deployment with updated fields. Must include name.

update_mask
FieldMask
2

Fields to update (e.g., "config,address").

dtkt.core.v1messages.proto

UpdateDeploymentResponse

Message
FieldTypeNumberDescription
deployment
Deployment
1

No description.

dtkt.core.v1messages.proto

DeleteDeploymentRequest

Message
FieldTypeNumberDescription
namestring1

No description.

dtkt.core.v1messages.proto

DeleteDeploymentResponse

Message
dtkt.core.v1messages.proto

RunDeploymentRequest

Message
FieldTypeNumberDescription
namestring1

Name of deployment resource to run.

build_etagstring2

Build etag must match parent integration resource.

dtkt.core.v1messages.proto

RunDeploymentResponse

Message
FieldTypeNumberDescription
deployment
Deployment
1

No description.

dtkt.core.v1messages.proto

ListFlowsRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

Parent: organizations/{organization} or users/{user}

filterstring4

No description.

dtkt.core.v1messages.proto

ListFlowsResponse

Message
FieldTypeNumberDescription
flows
Flow[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

GetFlowRequest

Message
FieldTypeNumberDescription
namestring1

Flow resource name, one of:

  • organizations/{organization}/flows/{flow}
  • users/{user}/flows/{flow}
dtkt.core.v1messages.proto

GetFlowResponse

Message
FieldTypeNumberDescription
flow
Flow
1

No description.

dtkt.core.v1messages.proto

CreateFlowRequest

Message
FieldTypeNumberDescription
flow_idstring1

Flow resource identifier.

flow
Flow
2

Flow to create.

parentstring3

Parent resource name, one of:

  • organizations/{organization}
  • users/{user}
dtkt.core.v1messages.proto

CreateFlowResponse

Message
FieldTypeNumberDescription
flow
Flow
1

No description.

dtkt.core.v1messages.proto

UpdateFlowRequest

Message
FieldTypeNumberDescription
flow
Flow
1

No description.

update_mask
FieldMask
2

Fields to update (e.g., "spec").

dtkt.core.v1messages.proto

UpdateFlowResponse

Message
FieldTypeNumberDescription
flow
Flow
1

No description.

dtkt.core.v1messages.proto

DeleteFlowRequest

Message
FieldTypeNumberDescription
namestring1

Name of flow to delete.

dtkt.core.v1messages.proto

DeleteFlowResponse

Message
dtkt.core.v1messages.proto

ListIntegrationsRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

Parent: organizations/{organization} or users/{user}

filterstring4

No description.

dtkt.core.v1messages.proto

ListIntegrationsResponse

Message
FieldTypeNumberDescription
integrations
Integration[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

GetIntegrationRequest

Message
FieldTypeNumberDescription
namestring1

Name of integration: organizations/{organization}/spaces/{space}/integrations/{integration}

dtkt.core.v1messages.proto

GetIntegrationResponse

Message
FieldTypeNumberDescription
integration
Integration
1

No description.

dtkt.core.v1messages.proto

CreateIntegrationRequest

Message
FieldTypeNumberDescription
integration_idstring1

Client-provided ID for integration resource.

integration
Integration
2

Integration to create.

parentstring3

Parent: organizations/{organization} or users/{user}

dtkt.core.v1messages.proto

CreateIntegrationResponse

Message
FieldTypeNumberDescription
integration
Integration
1

No description.

dtkt.core.v1messages.proto

BuildIntegrationRequest

Message
FieldTypeNumberDescription
namestring1

Integration name to build.

etagstring2

Integration etag must match integration resource.

dtkt.core.v1messages.proto

BuildIntegrationResponse

Message
FieldTypeNumberDescription
integration
Integration
1

No description.

dtkt.core.v1messages.proto

UpdateIntegrationRequest

Message
FieldTypeNumberDescription
integration
Integration
1

Integration with updated fields. Must include name.

update_mask
FieldMask
2

Fields to update (e.g., "config,spec").

dtkt.core.v1messages.proto

UpdateIntegrationResponse

Message
FieldTypeNumberDescription
integration
Integration
1

No description.

dtkt.core.v1messages.proto

DeleteIntegrationRequest

Message
FieldTypeNumberDescription
namestring1

Integration name to delete.

dtkt.core.v1messages.proto

DeleteIntegrationResponse

Message
dtkt.core.v1messages.proto

GetTypeRequest

Message
FieldTypeNumberDescription
namestring1

Type name, e.g.: "dtkt.shared.v1beta1.Package"

parentstring3

Parent resource name, one of:

  • System (no parent): nil | ""
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
dtkt.core.v1messages.proto

GetTypeResponse

Message
FieldTypeNumberDescription
type
Type
1

No description.

dtkt.core.v1messages.proto

ListTypesRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring3

Parent resource name, one of:

  • System (no parent): nil | ""
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
filterstring4

No description.

dtkt.core.v1messages.proto

ListTypesResponse

Message
FieldTypeNumberDescription
types
Type[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

GetMethodRequest

Message
FieldTypeNumberDescription
namestring1

Name of the method to get.

parentstring20

Parent resource name, one of:

  • Return first match: nil
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
dtkt.core.v1messages.proto

GetMethodResponse

Message
FieldTypeNumberDescription
method
Method
1

No description.

dtkt.core.v1messages.proto

GetServiceRequest

Message
FieldTypeNumberDescription
namestring1

Name of the service to get.

parentstring20

Parent resource name, one of:

  • Return first match: nil
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
dtkt.core.v1messages.proto

GetServiceResponse

Message
FieldTypeNumberDescription
service
Service
1

No description.

dtkt.core.v1messages.proto

ListServicesRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

parentstring20

Parent resource name, one of (blank will return all):

  • Return all: nil
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
filterstring21

No description.

dtkt.core.v1messages.proto

ListServicesResponse

Message
FieldTypeNumberDescription
services
Service[]
1

No description.

next_page_tokenstring2

No description.

dtkt.core.v1messages.proto

ListMethodsRequest

Message
FieldTypeNumberDescription
page_sizeint321

No description.

page_tokenstring2

No description.

servicestring10

Service name to filter methods.

parentstring20

Parent resource name, one of (blank will return all):

  • Return all: nil
  • Connection: e.g. "users/foo/connections/foobar"
  • Deployment: e.g. "users/foo/integrations/bar/deployments/default"
  • Integration (aggregates deployments): e.g. "users/foo/integrations/bar"
filterstring21

No description.

dtkt.core.v1messages.proto

ListMethodsResponse

Message
FieldTypeNumberDescription
methods
Method[]
1

No description.

next_page_tokenstring2

No description.

dtkt.email.v1beta1messages.proto

EmailAddress

Message
FieldTypeNumberDescription
addressstring1

The email address.

namestring2

The name associated with the email address.

dtkt.email.v1beta1messages.proto

EmailSendStatus

Message
FieldTypeNumberDescription
idstring1

No description.

successbool2

No description.

errorstring3

No description.

dtkt.email.v1beta1messages.proto

Email

Message

Represents an email message.

FieldTypeNumberDescription
from
EmailAddress
1

No description.

reply_to
EmailAddress
2

No description.

to
EmailAddress[]
3

No description.

cc
EmailAddress[]
4

No description.

bcc
EmailAddress[]
5

No description.

return_path
EmailAddress
6

No description.

subjectstring7

No description.

text_bodystring8

No description.

html_bodystring9

No description.

dtkt.email.v1beta1messages.proto

EmailTemplate

Message

Represents an email template.

FieldTypeNumberDescription
idstring1

No description.

language
TemplateLanguage
2

No description.

subjectstring3

No description.

text_bodystring4

No description.

html_bodystring5

No description.

dtkt.email.v1beta1messages.proto

EmailWithTemplate

Message

Represents an email message.

FieldTypeNumberDescription
from
EmailAddress
1

No description.

reply_to
EmailAddress
2

No description.

to
EmailAddress[]
3

No description.

cc
EmailAddress[]
4

No description.

bcc
EmailAddress[]
5

No description.

return_path
EmailAddress
6

No description.

template_idstring7

No description.

template_paramsmap<string, string>8

No description.

dtkt.email.v1beta1messages.proto

SendEmailRequest

Message

Represents an email sending request.

FieldTypeNumberDescription
email
Email
1

The email to be sent.

dtkt.email.v1beta1messages.proto

SendEmailResponse

Message

Represents an email sending response.

FieldTypeNumberDescription
send_status
EmailSendStatus
1

The email sending status.

dtkt.email.v1beta1messages.proto

SendEmailsRequest

Message

Represents a stream of email sending requests.

FieldTypeNumberDescription
email
Email
1

The email to be sent.

dtkt.email.v1beta1messages.proto

SendEmailsResponse

Message

Represents a stream of email sending responses.

FieldTypeNumberDescription
send_status
EmailSendStatus
1

The email sending status.

dtkt.email.v1beta1messages.proto

SendBatchEmailRequest

Message

Represents a batch email sending request.

FieldTypeNumberDescription
emails
Email[]
1

The list of emails to be sent.

dtkt.email.v1beta1messages.proto

SendBatchEmailResponse

Message

Represents a batch email sending response.

FieldTypeNumberDescription
send_status
EmailSendStatus[]
1

The list of email sending statuses.

dtkt.email.v1beta1messages.proto

SendEmailWithTemplateRequest

Message

Represents an email sending request sent with a template.

FieldTypeNumberDescription
email
EmailWithTemplate
1

The email to be sent.

dtkt.email.v1beta1messages.proto

SendEmailWithTemplateResponse

Message

Represents an email sending response sent with a template.

FieldTypeNumberDescription
send_status
EmailSendStatus
1

The email sending status.

dtkt.email.v1beta1messages.proto

SendEmailsWithTemplateRequest

Message

Represents a stream of email sending requests sent with a template.

FieldTypeNumberDescription
email
EmailWithTemplate
1

The email to be sent.

dtkt.email.v1beta1messages.proto

SendEmailsWithTemplateResponse

Message

Represents a stream of email sending responses sent with a template.

FieldTypeNumberDescription
send_status
EmailSendStatus
1

The email sending status.

dtkt.email.v1beta1messages.proto

SendBatchEmailWithTemplateRequest

Message

Represents a batch email sending request sent with a template.

FieldTypeNumberDescription
emails
EmailWithTemplate[]
1

The list of emails to be sent.

dtkt.email.v1beta1messages.proto

SendBatchEmailWithTemplateResponse

Message

Represents a batch email sending response sent with a template.

FieldTypeNumberDescription
send_status
EmailSendStatus[]
1

The list of email sending statuses.

dtkt.email.v1beta1messages.proto

GetEmailTemplateRequest

Message

Represents a request to get an email template by ID.

FieldTypeNumberDescription
idstring1

No description.

dtkt.email.v1beta1messages.proto

GetEmailTemplateResponse

Message

Represents a response to get an email template by ID.

FieldTypeNumberDescription
template
EmailTemplate
1

No description.

dtkt.email.v1beta1messages.proto

ListEmailTemplatesRequest

Message

Represents a request to list email templates.

FieldTypeNumberDescription
page_sizeint321

The maximum number of email templates to return. The service may return fewer than this value. If unspecified, at most 50 templates will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstring2

A page token, received from a previous ListEmailTemplates call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEmailTemplates must match the call that provided the page token.

dtkt.email.v1beta1messages.proto

ListEmailTemplatesResponse

Message

Represents a response to list email templates.

FieldTypeNumberDescription
templates
EmailTemplate[]
1

No description.

next_page_tokenstring2

No description.

dtkt.email.v1beta1messages.proto

CreateEmailTemplateRequest

Message

Represents a request to create an email template.

FieldTypeNumberDescription
template
EmailTemplate
1

No description.

dtkt.email.v1beta1messages.proto

CreateEmailTemplateResponse

Message

Represents a response to create an email template.

FieldTypeNumberDescription
template
EmailTemplate
1

No description.

dtkt.email.v1beta1messages.proto

UpdateEmailTemplateRequest

Message

Represents a request to update an email template.

FieldTypeNumberDescription
idstring1

No description.

template
EmailTemplate
2

No description.

dtkt.email.v1beta1messages.proto

UpdateEmailTemplateResponse

Message

Represents a response to update an email template.

FieldTypeNumberDescription
template
EmailTemplate
1

No description.

dtkt.email.v1beta1messages.proto

DeleteEmailTemplateRequest

Message

Represents a request to delete an email template.

FieldTypeNumberDescription
idstring1

No description.

dtkt.email.v1beta1messages.proto

DeleteEmailTemplateResponse

Message

Represents a response to delete an email template.

FieldTypeNumberDescription
idstring1

No description.

dtkt.email.v1beta1messages.proto

ReceivedEmail

Message

Represents a received Email

FieldTypeNumberDescription
idstring1

No description.

atstring2

No description.

email
Email
3

No description.

dtkt.event.v1beta1messages.proto

Event

Message

Represents an event type deliverable by an EventSource.

FieldTypeNumberDescription
typestring1

Type of the event.

descriptionstring2

Description of the event.

action_type
ActionType
3

Type of action associated with event.

payload_schema
TypeSchema
4

Schema describing the payload of the event.

payload
Any
5

Payload when event is delivered.

dtkt.event.v1beta1messages.proto

EventSource

Message

Represents an event source supported by the service.

FieldTypeNumberDescription
strategy
EventSourceStrategy
1

The strategy used by the event source.

namestring2

Name of the event source.

descriptionstring3

Description of the event source.

config_schema
TypeSchema
4

Schema for configuring the event source.

requires_creationbool5

Specifies if creation is required before using the event source.

config
Any
6

Configuration of the event source, if any (only available when requires_creation is true and it has been created).

pull_freq
Duration
7

Pull frequency of the event source, if any (only available when strategy is PULL, requires_creation is true, and it has been created).

push_urlstring8

Push URL of the event source, if any (only available when strategy is PUSH, requires_creation is true, and it has been created).

dtkt.event.v1beta1messages.proto

ListEventsRequest

Message

Request for retrieving events.

dtkt.event.v1beta1messages.proto

ListEventsResponse

Message

Response containing a list of events.

FieldTypeNumberDescription
events
Event[]
1

List of available events.

dtkt.event.v1beta1messages.proto

ListEventSourcesRequest

Message

Request for retrieving event source types supported by this service.

FieldTypeNumberDescription
strategy
EventSourceStrategy
1

The strategy used by the event source.

configuredbool2

Indicates whether to list only configured event sources.

dtkt.event.v1beta1messages.proto

ListEventSourcesResponse

Message

List of event sources supported by or configured for this service.

FieldTypeNumberDescription
event_sources
EventSource[]
1

List of event sources.

dtkt.event.v1beta1messages.proto

StreamPullEventsRequest

Message

Request to pull events from a PULL event source.

FieldTypeNumberDescription
event_source
EventSource
1

Pull event source.

config
Any
2

Configuration of the event source.

pull_freq
Duration
3

Pull frequency of the event source.

dtkt.event.v1beta1messages.proto

StreamPullEventsResponse

Message

Response for pulling events.

FieldTypeNumberDescription
event_source
EventSource
1

Pull event source from request.

event
Event
2

Event delivered by source.

dtkt.event.v1beta1messages.proto

StreamPushEventsRequest

Message

Request to validate an event from a PUSH event source.

FieldTypeNumberDescription
event_source
EventSource
1

Push event source.

headers
map<string, StringList>
2

Headers of the event.

bodybytes3

Body of the event.

dtkt.event.v1beta1messages.proto

StreamPushEventsResponse

Message

Response of a valid event from a PUSH event source.

FieldTypeNumberDescription
event_source
EventSource
1

Push event source.

event
Event
2

Event delivered.

dtkt.event.v1beta1messages.proto

CreateEventSourceRequest

Message

Request to create a new event source.

FieldTypeNumberDescription
event_source
EventSource
1

Event source to create.

config
Any
2

Configuration of the event source.

pull_freq
Duration
3

Pull frequency of the event source, if any (only supported when strategy is PULL).

push_urlstring4

Push URL of the event source, if any (only supported when strategy is PUSH).

dtkt.event.v1beta1messages.proto

CreateEventSourceResponse

Message

Response for creating an event source.

FieldTypeNumberDescription
createdbool1

Indicates if the creation was successful.

errorstring2

Error message, if any.

event_source
EventSource
3

The created event source.

dtkt.event.v1beta1messages.proto

UpdateEventSourceRequest

Message

Request to update an event source.

FieldTypeNumberDescription
event_source
EventSource
1

Event source to update.

config
Any
2

Configuration of the event source.

pull_freq
Duration
3

Pull frequency of the event source, if any (only supported when strategy is PULL).

push_urlstring4

Push URL of the event source, if any (only supported when strategy is PUSH).

dtkt.event.v1beta1messages.proto

UpdateEventSourceResponse

Message

Response for updating an event source.

FieldTypeNumberDescription
updatedbool1

Indicates if the update was successful.

errorstring2

Error message, if any.

event_source
EventSource
3

The updated event source.

dtkt.event.v1beta1messages.proto

DeleteEventSourceRequest

Message

Request to delete an event source.

FieldTypeNumberDescription
event_source
EventSource
1

The event source to delete.

dtkt.event.v1beta1messages.proto

DeleteEventSourceResponse

Message

Response for deleting an event source.

FieldTypeNumberDescription
deletedbool1

Indicates if the deletion was successful.

errorstring2

Error message, if any.

event_source
EventSource
3

The deleted event source.

dtkt.geo.v1beta1messages.proto

GeoSource

Message
FieldTypeNumberDescription
idstring1

No description.

geo_fieldsstring[]2

No description.

prop_fields
PropertyField[]
3

No description.

update_freq
Duration
4

No description.

sourceOneOf

No description.

table
Table
5

No description.

query
Query
6

No description.

dtkt.geo.v1beta1messages.proto

PropertyField

Message
FieldTypeNumberDescription
namestring1

No description.

type
PropertyType
2

No description.

dtkt.geo.v1beta1messages.proto

Bounds

Message
FieldTypeNumberDescription
type
BoundsType
1

No description.

geom
Geometry
2

No description.

centroidbool3

No description.

dtkt.geo.v1beta1messages.proto

ListGeoSourcesRequest

Message
FieldTypeNumberDescription
scopeOneOf

No description.

catalog
Catalog
1

No description.

schema
Schema
2

No description.

dtkt.geo.v1beta1messages.proto

ListGeoSourcesResponse

Message
FieldTypeNumberDescription
geo_source
GeoSource
1

No description.

dtkt.geo.v1beta1messages.proto

StreamGeoJsonRequest

Message
FieldTypeNumberDescription
source
GeoSource
1

No description.

bounds
Bounds
2

No description.

geo_fieldstring3

No description.

prop_fieldsstring[]4

No description.

dtkt.geo.v1beta1messages.proto

StreamGeoJsonResponse

Message
FieldTypeNumberDescription
result
GeoJSON
1

No description.

dtkt.geojson.v1beta1messages.proto

GeoJSON

Message

GeoJSON Root object union

FieldTypeNumberDescription
geojsonOneOf

No description.

geometry
Geometry
1

No description.

feature
Feature
2

No description.

feature_collection
FeatureCollection
3

No description.

dtkt.geojson.v1beta1messages.proto

Geometry

Message

Union type for Geometry using oneof

FieldTypeNumberDescription
geometryOneOf

No description.

point
Point
1

No description.

multi_point
MultiPoint
2

No description.

line_string
LineString
3

No description.

multi_line_string
MultiLineString
4

No description.

polygon
Polygon
5

No description.

multi_polygon
MultiPolygon
6

No description.

geometry_collection
GeometryCollection
7

No description.

dtkt.geojson.v1beta1messages.proto

Feature

Message
FieldTypeNumberDescription
typestring1

No description.

geometry
Geometry
2

No description.

properties
Struct
3

No description.

idOneOf

No description.

id_strstring4

No description.

id_numint645

No description.

bbox
BBox
6

No description.

dtkt.geojson.v1beta1messages.proto

FeatureCollection

Message
FieldTypeNumberDescription
typestring1

No description.

features
Feature[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

BBox

Message

Represents a GeoJSON Bounding Box

FieldTypeNumberDescription
coordinatesdouble[]1

No description.

dtkt.geojson.v1beta1messages.proto

Position

Message

Represents a GeoJSON Position (array of numbers: length 2 or 3)

FieldTypeNumberDescription
valuesdouble[]1

No description.

dtkt.geojson.v1beta1messages.proto

Point

Message

GeoJSON Geometry types

FieldTypeNumberDescription
typestring1

No description.

coordinates
Position
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

MultiPoint

Message
FieldTypeNumberDescription
typestring1

No description.

coordinates
Position[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

LineString

Message
FieldTypeNumberDescription
typestring1

No description.

coordinates
Position[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

MultiLineString

Message
FieldTypeNumberDescription
typestring1

No description.

coordinates
LineStringCoords[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

Polygon

Message
FieldTypeNumberDescription
typestring1

No description.

coordinates
LinearRing[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

MultiPolygon

Message
FieldTypeNumberDescription
typestring1

No description.

coordinates
PolygonCoords[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

GeometryCollection

Message
FieldTypeNumberDescription
typestring1

No description.

geometries
Geometry[]
2

No description.

bbox
BBox
3

No description.

dtkt.geojson.v1beta1messages.proto

LineStringCoords

Message

Helper types for nested coordinates

FieldTypeNumberDescription
positions
Position[]
1

No description.

dtkt.geojson.v1beta1messages.proto

LinearRing

Message
FieldTypeNumberDescription
positions
Position[]
1

No description.

dtkt.geojson.v1beta1messages.proto

PolygonCoords

Message
FieldTypeNumberDescription
linear_rings
LinearRing[]
1

No description.

dtkt.protocoap.v1beta1protocoap.proto

Resource

Message
FieldTypeNumberDescription
namestring1

No description.

oscorebool2

No description.

observablebool3

No description.

notify_confirmbool4

No description.

max_ageint325

No description.

dtkt.protocoap.v1beta1protocoap.proto

ServiceOption

Message
FieldTypeNumberDescription
oscorebool1

No description.

resources
Resource[]
2

No description.

dtkt.protocoap.v1beta1protocoap.proto

MethodOption

Message
FieldTypeNumberDescription
confirmbool1

No description.

resourcestring2

No description.

method
RequestMethod
3

No description.

dtkt.protostore.v1beta1protostore.proto

Field

Message
FieldTypeNumberDescription
namestring1

No description.

optionalbool2

No description.

nillablebool3

No description.

uniquebool4

No description.

sensitivebool5

No description.

immutablebool6

No description.

skipbool7

No description.

primarybool8

No description.

dtkt.protostore.v1beta1protostore.proto

Edge

Message
FieldTypeNumberDescription
uniquebool1

No description.

refstring2

No description.

requiredbool3

No description.

fieldstring4

No description.

dtkt.replication.v1beta1messages.proto

Source

Message

Represents a configured replication Source.

FieldTypeNumberDescription
service
ServiceType
1

Replication service of Source.

destination_idstring2

Unique identifier of Destination.

config_idstring3

Unique identifier of source config from replication service.

idstring4

Unique identifier returned by Source.

namestring5

Name returned by Source.

config
Struct
6

Config for Source.

sync_status
SyncStatus
7

Sync status of the Source.

sync_errorstring8

Sync error message when sync status is failed.

dtkt.replication.v1beta1messages.proto

SourceConfig

Message

Represents a supported replication source config.

FieldTypeNumberDescription
service
ServiceType
1

Replication service of source config.

idstring2

Unique identifier for source config.

namestring3

Name of source config.

descriptionstring4

Description of source config.

icon_urlstring5

Icon URL of source config.

categorystring6

Category of source config.

config_schemastring7

Schema for source config.

dtkt.replication.v1beta1messages.proto

CheckSourceAuthRequest

Message

Request for checking source auth.

FieldTypeNumberDescription
service
ServiceType
1

Replication service the Source.

config_idstring2

Unique identifier of source config from replication service.

type
AuthCheck
3

The auth check type.

oauthOneOf

If auth type response is OAuth.

code_request
OAuthCodeRequest
4

When check type is auth code url.

token_request
OAuthTokenRequest
5

When check type is callback.

refresh_request
OAuthRefreshRequest
6

When check type is refresh.

dtkt.replication.v1beta1messages.proto

CheckSourceAuthResponse

Message

Response for checking source auth.

FieldTypeNumberDescription
type
AuthType
1

The auth type of this source.

successbool2

Indicates if the auth check was successful.

errorstring3

Error message if success is false.

oauthOneOf

Present when type is OAuth.

auth_code_urlstring4

Returned when check is code.

token
OAuthToken
5

Returned when check type is token or refresh.

config_data
Struct
6

Data for source config.

dtkt.replication.v1beta1messages.proto

ListSourceConfigsRequest

Message

Request to retrieve a list of supported replication Sources.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

dtkt.replication.v1beta1messages.proto

ListSourceConfigsResponse

Message

Response to retrieve a list of supported replication Sources.

FieldTypeNumberDescription
source_configs
SourceConfig[]
1

No description.

dtkt.replication.v1beta1messages.proto

GetSourceRequest

Message

Request for replication Source of given provider.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of source config from replication service.

idstring3

Unique identifier of Source.

dtkt.replication.v1beta1messages.proto

GetSourceResponse

Message

Response for replication Source of given provider.

FieldTypeNumberDescription
source
Source
1

No description.

dtkt.replication.v1beta1messages.proto

CreateSourceRequest

Message

Request to create configured Source.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of source config from replication service.

namestring3

Name assigned to Source being created.

config
Struct
4

Config assigned to Source being created.

dtkt.replication.v1beta1messages.proto

CreateSourceResponse

Message

Response from create configured Source.

FieldTypeNumberDescription
createdbool1

Indicates whether Source was successfully created.

errorstring2

An error message if created is false.

source
Source
3

The returned Source if created is true.

dtkt.replication.v1beta1messages.proto

UpdateSourceRequest

Message

Request to update configured Source.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of source config from replication service.

idstring3

Unique identifier of Source.

config
Struct
4

Source config overrides.

dtkt.replication.v1beta1messages.proto

UpdateSourceResponse

Message

Response from update configured Source.

FieldTypeNumberDescription
updatedbool1

Indicates whether Source was successfully updated.

errorstring2

An error message if updated is false.

source
Source
3

The returned Source if updated is true.

dtkt.replication.v1beta1messages.proto

DeleteSourceRequest

Message

Request to delete configured Source.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of source config from replication service.

idstring3

Unique identifier of Source.

dtkt.replication.v1beta1messages.proto

DeleteSourceResponse

Message

Response for delete configured Source.

FieldTypeNumberDescription
deletedbool1

Indicates whether Source was successfully deleted.

errorstring2

An error message if deleted is false.

dtkt.replication.v1beta1messages.proto

StartSyncRequest

Message
FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

destination_idstring2

Unique identifier of Destination.

source_config_idstring3

Unique identifier of source config from replication service.

source_idstring4

Unique identifier of Source.

dtkt.replication.v1beta1messages.proto

StartSyncResponse

Message
FieldTypeNumberDescription
source
Source
1

The returned Source.

dtkt.replication.v1beta1messages.proto

StopSyncRequest

Message
FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

destination_idstring2

Unique identifier of Destination.

source_config_idstring3

Unique identifier of source config from replication service.

source_idstring4

Unique identifier of Source.

dtkt.replication.v1beta1messages.proto

StopSyncResponse

Message
FieldTypeNumberDescription
source
Source
1

The returned Source.

dtkt.replication.v1beta1messages.proto

Destination

Message

Represents a replication Destination.

FieldTypeNumberDescription
service
ServiceType
1

Replication service of this Destination.

config_idstring2

Unique identifier of destination config from replication service.

idstring3

Unique identifier of Destination.

namestring4

Name assigned to Destination.

config
Struct
5

Config for Destination.

dtkt.replication.v1beta1messages.proto

DestinationConfig

Message

Represents a supported destination config.

FieldTypeNumberDescription
service
ServiceType
1

Replication service of destination config.

idstring2

Unique identifier for destination config.

namestring3

Name of destination config.

descriptionstring4

Description of destination config.

icon_urlstring5

Icon URL of destination config.

categorystring6

Category of destination config.

config_schemastring7

Schema for destination config.

dtkt.replication.v1beta1messages.proto

ListDestinationConfigsRequest

Message

Request to retrieve a list of supported destinations.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

dtkt.replication.v1beta1messages.proto

ListDestinationConfigsResponse

Message

List of Destinations.

FieldTypeNumberDescription
destination_configs
DestinationConfig[]
1

No description.

dtkt.replication.v1beta1messages.proto

GetDestinationRequest

Message

Request for replication Destination of given provider.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of destination config from replication service.

idstring3

Unique identifier of Destination.

dtkt.replication.v1beta1messages.proto

GetDestinationResponse

Message

Response for replication Destination of given provider.

FieldTypeNumberDescription
destination
Destination
1

No description.

dtkt.replication.v1beta1messages.proto

CreateDestinationRequest

Message

Request to create configured destination.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of destination config from replication service.

namestring3

Name assigned to Destination.

config
Struct
4

Destination config overrides.

dtkt.replication.v1beta1messages.proto

CreateDestinationResponse

Message

Response from create configured destination.

FieldTypeNumberDescription
createdbool1

Indicates whether destination was successfully created.

errorstring2

An error message if created is false.

destination
Destination
3

The returned destination if created is true.

dtkt.replication.v1beta1messages.proto

UpdateDestinationRequest

Message

Request to update configured destination.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of destination config from replication service.

idstring3

Unique identifier of Destination.

config
Struct
4

Destination config overrides.

dtkt.replication.v1beta1messages.proto

UpdateDestinationResponse

Message

Response from update configured destination.

FieldTypeNumberDescription
updatedbool1

Indicates whether destination was successfully updated.

errorstring2

An error message if updated is false.

destination
Destination
3

The returned destination if updated is true.

dtkt.replication.v1beta1messages.proto

DeleteDestinationRequest

Message

Request to delete configured destination.

FieldTypeNumberDescription
service_config
ServiceConfig
1

The configured replication service.

config_idstring2

Unique identifier of destination config from replication service.

idstring3

Unique identifier of Destination.

dtkt.replication.v1beta1messages.proto

DeleteDestinationResponse

Message

Response for delete configured destination.

FieldTypeNumberDescription
deletedbool1

Indicates whether destination was successfully deleted.

errorstring2

An error message if deleted is false.

dtkt.replication.v1beta1messages.proto

ServiceConfig

Message

Supported service config.

FieldTypeNumberDescription
service
ServiceType
1

No description.

configOneOf

No description.

fivetran_config
FivetranConfig
2

No description.

dtkt.replication.v1beta1messages.proto

FivetranConfig

Message

Represents Fivetran replication service config.

FieldTypeNumberDescription
api_keystring1

No description.

api_secretstring2

No description.

webhook_secretstring3

No description.

configOneOf

No description.

source_config
FivetranSourceConfig
4

No description.

destination_config
FivetranDestinationConfig
5

No description.

dtkt.replication.v1beta1messages.proto

FivetranSourceConfig

Message
FieldTypeNumberDescription
group_idstring1

The unique identifier for the group within the Fivetran system

pausedbool2

Specifies whether the connector is paused.

pause_after_trialbool3

Specifies whether the connector should be paused after the free trial period has ended.

sync_frequencyint324

The connector sync frequency in minutes.

daily_sync_timestring5

The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time.

schedule_typestring6

The connector schedule configuration type. Supported values: auto, manual.

run_setup_testsbool7

Specifies whether setup tests should be run automatically.

dtkt.replication.v1beta1messages.proto

FivetranDestinationConfig

Message
FieldTypeNumberDescription
regionstring1

Data processing location. This is where Fivetran will operate and run computation on data.

time_zone_offsetstring2

Determines the time zone for the Fivetran sync schedule.

daylight_saving_time_enabledbool3

Shift my UTC offset with daylight savings time (US Only)

run_setup_testsbool4

Specifies whether setup tests should be run automatically.