dtkt.protoform.v1beta1protoform.protoFieldElement
Message| Field | Type | Number | Description |
|---|---|---|---|
| title | string | 1 | No description. |
| description | string | 2 | No description. |
| typeOneOf | No description. | ||
| confirm | ConfirmElement dtkt.protoform.v1beta1.ConfirmElement | 4 | No description. |
| input | InputElement dtkt.protoform.v1beta1.InputElement | 5 | No description. |
| file | FileElement dtkt.protoform.v1beta1.FileElement | 6 | No description. |
| select | SelectElement dtkt.protoform.v1beta1.SelectElement | 7 | No description. |
| multi_select | MultiSelectElement dtkt.protoform.v1beta1.MultiSelectElement | 8 | No description. |
dtkt.protoform.v1beta1protoform.protoConfirmElement
MessageConfirm element (approve/decline)
dtkt.protoform.v1beta1protoform.protoInputElement
MessageInput element with multi-line text option
| Field | Type | Number | Description |
|---|---|---|---|
| multiline_text | bool | 1 | No description. |
dtkt.protoform.v1beta1protoform.protoFileElement
MessageFile element
| Field | Type | Number | Description |
|---|---|---|---|
| allowed_types | string[] | 2 | No description. |
dtkt.protoform.v1beta1protoform.protoSelectElement
MessageSelect element
| Field | Type | Number | Description |
|---|---|---|---|
| method_name | string | 1 | No description. |
| field_name | string | 2 | No description. |
| option_key | ValueAccessor dtkt.protoform.v1beta1.ValueAccessor | 3 | No description. |
| option_value | ValueAccessor dtkt.protoform.v1beta1.ValueAccessor | 4 | No description. |
dtkt.protoform.v1beta1protoform.protoMultiSelectElement
MessageMulti-select element
| Field | Type | Number | Description |
|---|---|---|---|
| method_name | string | 1 | No description. |
| field_name | string | 2 | No description. |
| option_key | ValueAccessor dtkt.protoform.v1beta1.ValueAccessor | 3 | No description. |
| option_value | ValueAccessor dtkt.protoform.v1beta1.ValueAccessor | 4 | No description. |
dtkt.protoform.v1beta1protoform.protoValueAccessor
MessageValue accessor
dtkt.protoui.v1beta1protoui.protoMessageOption
MessageDetermines how a Message should be displayed in the UI.
| Field | Type | Number | Description |
|---|---|---|---|
| components | Component[] dtkt.protoui.v1beta1.Component[] | 1 | No description. |
dtkt.protoui.v1beta1protoui.protoFieldOption
MessageDetermines how a Field should be displayed in the UI.
| Field | Type | Number | Description |
|---|---|---|---|
| components | Component[] dtkt.protoui.v1beta1.Component[] | 1 | No description. |
dtkt.protoui.v1beta1protoui.protoData
Message| Field | Type | Number | Description |
|---|---|---|---|
| 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. | ||
| text | string | 1 | Evaluate the data as plain text. |
| expr | string | 2 | Evaluate the data using a CEL expression. The message or field is passed as |
| template | Template dtkt.protoui.v1beta1.Template | 3 | Evaluate the data using a template. The message or field is passed as the template data context. |
dtkt.protoui.v1beta1protoui.protoComponent
MessageA Block represents a component in the UI that displays data from a message or field.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | 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 dtkt.protoui.v1beta1.Markdown | 2 | Render as markdown. Only valid for string type data. |
| heading | Heading dtkt.protoui.v1beta1.Heading | 3 | Render as a heading. Only valid for string type data. |
| table | Table dtkt.protoui.v1beta1.Table | 4 | Render the data as a table. Only valid for repeated Message fields. |
| list | List dtkt.protoui.v1beta1.List | 5 | Render the data as a list. Only valid for repeated scalar fields. |
| badge | Badge dtkt.protoui.v1beta1.Badge | 6 | Render the data as a badge. Only valid for string type data. |
| progress | Progress dtkt.protoui.v1beta1.Progress | 7 | Render the data as progress. Only valid for numeric type data. |
| code_block | CodeBlock dtkt.protoui.v1beta1.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 dtkt.protoui.v1beta1.Card | 9 | Render the data as a card. Can contain other components. |
| description_list | DescriptionList dtkt.protoui.v1beta1.DescriptionList | 10 | Render the data as a description list (key-value pairs). |
| tree | Tree dtkt.protoui.v1beta1.Tree | 11 | Render the data as a tree structure. Only valid for hierarchical data. |
| text | Text dtkt.protoui.v1beta1.Text | 12 | Render the data as text with optional styling. |
| avatar | Avatar dtkt.protoui.v1beta1.Avatar | 14 | Render the data as an avatar. |
| divider | Divider dtkt.protoui.v1beta1.Divider | 15 | Render the data as a divider/separator. |
| secret | Secret dtkt.protoui.v1beta1.Secret | 19 | Render the data as a secret (masked text with reveal option). |
| label | Label dtkt.protoui.v1beta1.Label | 20 | Render as a label. Only valid for string type data. |
| description | Description dtkt.protoui.v1beta1.Description | 21 | No description. |
| error | Error dtkt.protoui.v1beta1.Error | 22 | No description. |
| custom | Any google.protobuf.Any | 40 | Custom component. The data will be passed to the custom component as is. |
| metadata | Struct google.protobuf.Struct | 50 | Arbitrary metadata that can be used by the UI renderer. |
dtkt.protoui.v1beta1protoui.protoTemplate
Message| Field | Type | Number | Description |
|---|---|---|---|
| language | Language dtkt.protoui.v1beta1.Template.Language | 1 | No description. |
| template | string | 2 | No description. |
dtkt.protoui.v1beta1protoui.protoMarkdown
MessageRender 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
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The markdown content. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoTable
MessageTable 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
fieldin columns - List of lists (positional):
this.users.map(u, [u.name, u.email, u.active ? "Active" : "Inactive"])
| Field | Type | Number | Description |
|---|---|---|---|
| rows | string | 1 | CEL expression that evaluates to a list of objects (repeated messages or structured data).
Context: |
| columns | Column[] dtkt.protoui.v1beta1.Table.Column[] | 2 | Columns to be displayed in the table. If not specified, all fields will be displayed. |
| actions | Action[] dtkt.protoui.v1beta1.Table.Action[] | 3 | Actions that can be performed on the table rows. |
dtkt.protoui.v1beta1protoui.protoHeading
MessageRender 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
dtkt.protoui.v1beta1protoui.protoList
MessageRender 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)
| Field | Type | Number | Description |
|---|---|---|---|
| items | string | 1 | CEL expression that evaluates to a repeated/list value.
Context: |
| style | Style dtkt.protoui.v1beta1.List.Style | 2 | No description. |
dtkt.protoui.v1beta1protoui.protoBadge
MessageRender 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"
| Field | Type | Number | Description |
|---|---|---|---|
| content | string | 1 | CEL expression that evaluates to a string for the badge text.
Context: |
| color | string | 2 | Color name from the UI theme (e.g., "red", "blue", "green", "zinc"). Defaults to "zinc" if not specified. |
dtkt.protoui.v1beta1protoui.protoProgress
MessageRender 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
| Field | Type | Number | Description |
|---|---|---|---|
| value | string | 1 | CEL expression that evaluates to a numeric value representing progress (0-100).
Context: |
dtkt.protoui.v1beta1protoui.protoCodeBlock
MessageRender 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
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The code content. Can be plain text, a CEL expression, or a template.
Context: |
| language | string | 2 | Language for syntax highlighting (e.g., "go", "python", "javascript"). |
| filename | string | 3 | Optional filename to display. |
| show_line_numbers | bool | 4 | Show line numbers. |
| highlight_lines | string | 5 | Highlight specific lines (e.g., "1-3,5,7-9"). |
dtkt.protoui.v1beta1protoui.protoCard
MessageRender 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
| Field | Type | Number | Description |
|---|---|---|---|
| header | Data dtkt.protoui.v1beta1.Data | 1 | Optional card header. Can be plain text, a CEL expression, or a template.
Context: |
| content | Data dtkt.protoui.v1beta1.Data | 2 | Card content - the main body. Can be plain text, a CEL expression, or a template.
Context: |
| footer | Data dtkt.protoui.v1beta1.Data | 3 | Optional card footer. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoDescriptionList
MessageRender 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"]]
| Field | Type | Number | Description |
|---|---|---|---|
| items | string | 1 | CEL expression that evaluates to a list of 2-element lists (tuples) where:
|
dtkt.protoui.v1beta1protoui.protoTree
MessageRender 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}})})
| Field | Type | Number | Description |
|---|---|---|---|
| nodes | string | 1 | CEL expression that evaluates to a list of TreeNode messages.
Context: |
dtkt.protoui.v1beta1protoui.protoText
MessageRender 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)
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The text content. Can be plain text, a CEL expression, or a template.
Context: |
| color | Color dtkt.protoui.v1beta1.Text.Color | 2 | No description. |
dtkt.protoui.v1beta1protoui.protoAvatar
MessageRender 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
| Field | Type | Number | Description |
|---|---|---|---|
| src | string | 1 | Optional CEL expression for the source URL of the avatar image.
Context: |
| initials | string | 2 | Optional CEL expression for initials to display when no image is available.
Context: |
| alt | string | 3 | Optional CEL expression for alternative text.
Context: |
| square | bool | 4 | Whether to render as square instead of circle. |
dtkt.protoui.v1beta1protoui.protoDivider
MessageRender as a horizontal divider/separator. Maps to Divider in @dtkt/ui/divider Simple visual separator with soft styling option.
| Field | Type | Number | Description |
|---|---|---|---|
| soft | bool | 1 | Whether to use softer border color. |
dtkt.protoui.v1beta1protoui.protoSecret
MessageRender 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)
| Field | Type | Number | Description |
|---|---|---|---|
| placeholder | string | 1 | CEL expression for the placeholder text (the masked representation).
Context: |
dtkt.protoui.v1beta1protoui.protoLabel
MessageRender as a form label.
Maps to Label in @dtkt/ui/components/label or fieldset
Example expr: this.field_name or "Enter your " + this.label
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The label text. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoDescription
MessageRender 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")
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The description text. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoError
MessageRender as a form error message.
Maps to error message display in form components
Example expr: this.error or this.field_name + " is invalid"
| Field | Type | Number | Description |
|---|---|---|---|
| content | Data dtkt.protoui.v1beta1.Data | 1 | The error message. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoConfirm
MessageConfirmation 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
| Field | Type | Number | Description |
|---|---|---|---|
| accept | Data dtkt.protoui.v1beta1.Data | 1 | Accept button text. Can be plain text, a CEL expression, or a template.
Context: |
| decline | Data dtkt.protoui.v1beta1.Data | 2 | Decline button text. Can be plain text, a CEL expression, or a template.
Context: |
| cancel | Data dtkt.protoui.v1beta1.Data | 3 | Cancel button text. Can be plain text, a CEL expression, or a template.
Context: |
dtkt.protoui.v1beta1protoui.protoInput
MessageInput element with multi-line text option Maps to Input or Textarea in @dtkt/ui/input or @dtkt/ui/textarea
| Field | Type | Number | Description |
|---|---|---|---|
| multiline_text | bool | 1 | No description. |
dtkt.protoui.v1beta1protoui.protoFile
MessageFile upload input Maps to file input components
| Field | Type | Number | Description |
|---|---|---|---|
| allowed_types | string[] | 2 | No description. |
dtkt.protoui.v1beta1protoui.protoSelect
MessageSelect 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
| Field | Type | Number | Description |
|---|---|---|---|
| item_field | string | 1 | Field name to be used as the option value. |
| label_field | string | 2 | Field name to be used as the option label. |
| option_key | string | 3 | CEL expression for option keys.
Context: |
| option_value | string | 4 | CEL expression for option values.
Context: |
dtkt.protoui.v1beta1protoui.protoMultiSelect
MessageMulti-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
| Field | Type | Number | Description |
|---|---|---|---|
| item_field | string | 1 | Field name to be used as the option value. |
| label_field | string | 2 | Field name to be used as the option label. |
| option_key | string | 3 | CEL expression for option keys.
Context: |
| option_value | string | 4 | CEL expression for option values.
Context: |
dtkt.action.v1beta1messages.protoAction
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Resource name: |
| display_name | string | 2 | Human-friendly fields |
| description | string | 3 | No description. |
| version | string | 4 | Versioning & lifecycle |
| disabled | bool | 5 | No description. |
| deprecation_note | string | 6 | No description. |
| input | TypeSchema dtkt.shared.v1beta1.TypeSchema | 10 | Input/Output schema declarations |
| output | TypeSchema dtkt.shared.v1beta1.TypeSchema | 11 | No description. |
| labels | map<string, string> | 20 | Labels/tags for discovery |
| updated_at | Timestamp google.protobuf.Timestamp | 30 | When the action definition was last updated. |
dtkt.action.v1beta1messages.protoListActionsRequest
Messagedtkt.action.v1beta1messages.protoListActionsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| actions | Action[] dtkt.action.v1beta1.Action[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.action.v1beta1messages.protoGetActionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Resource name: |
dtkt.action.v1beta1messages.protoGetActionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| action | Action dtkt.action.v1beta1.Action | 1 | No description. |
dtkt.action.v1beta1messages.protoExecuteActionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Primary resource name: |
| input | Struct google.protobuf.Struct | 10 | Input data for the action. |
| timeout | Duration google.protobuf.Duration | 20 | Execution timeout |
dtkt.action.v1beta1messages.protoExecuteActionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Echo of the action executed (resource name). |
| run_id | string | 2 | Server-generated run identifier for tracing. |
| json | Struct google.protobuf.Struct | 10 | Canonical output for UI/MCP. |
| proto | Any google.protobuf.Any | 11 | Optional alternate encoding for SDKs/internal use. |
| message | string | 20 | Optional human-readable status. |
dtkt.ai.v1beta1messages.protoEmbeddingModel
MessageRepresents an embedding model, including its ID, name, and supported dimensions.
dtkt.ai.v1beta1messages.protoEmbeddingInput
MessageRepresents an input for generating embeddings.
dtkt.ai.v1beta1messages.protoEmbeddingOutput
MessageRepresents the output of an embedding operation.
| Field | Type | Number | Description |
|---|---|---|---|
| input | EmbeddingInput dtkt.ai.v1beta1.EmbeddingInput | 1 | The input data for which the embedding was generated. |
| vector | double[] | 2 | The generated embedding vector. |
| success | bool | 3 | Indicates if the embedding generation was successful. |
| error | string | 4 | Error message, if any. |
dtkt.ai.v1beta1messages.protoListEmbeddingModelsRequest
MessageRequest to retrieve a list of available embedding models.
dtkt.ai.v1beta1messages.protoListEmbeddingModelsResponse
MessageResponse containing a list of available embedding models.
| Field | Type | Number | Description |
|---|---|---|---|
| models | EmbeddingModel[] dtkt.ai.v1beta1.EmbeddingModel[] | 1 | List of embedding models. |
dtkt.ai.v1beta1messages.protoGetEmbeddingModelRequest
MessageRequest to retrieve details of a specific embedding model.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | ID of the embedding model to retrieve. |
dtkt.ai.v1beta1messages.protoGetEmbeddingModelResponse
MessageResponse containing details of a specific embedding model.
| Field | Type | Number | Description |
|---|---|---|---|
| model | EmbeddingModel dtkt.ai.v1beta1.EmbeddingModel | 1 | Details of the requested embedding model. |
dtkt.ai.v1beta1messages.protoCreateEmbeddingsRequest
MessageRequest to create embeddings for input text using a specified model.
| Field | Type | Number | Description |
|---|---|---|---|
| model_id | string | 1 | ID of the embedding model to use. |
| dimensions | uint32 | 2 | Desired number of dimensions for the embedding. |
| inputs | EmbeddingInput[] dtkt.ai.v1beta1.EmbeddingInput[] | 3 | List of text inputs to generate embeddings for. |
dtkt.ai.v1beta1messages.protoCreateEmbeddingsResponse
MessageResponse containing the generated embeddings for the input text.
| Field | Type | Number | Description |
|---|---|---|---|
| outputs | EmbeddingOutput[] dtkt.ai.v1beta1.EmbeddingOutput[] | 1 | List of embedding outputs corresponding to the inputs. |
dtkt.ai.v1beta1messages.protoBlob
Messagedtkt.ai.v1beta1messages.protoMessage
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
| role | string | 2 | No description. |
| content | Content[] dtkt.ai.v1beta1.Message.Content[] | 3 | No description. |
dtkt.ai.v1beta1messages.protoGenerateTextRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateTextResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamTextRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamTextResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateObjectRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateObjectResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamObjectsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamObjectsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateImageRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateImageResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateImagesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateImagesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateBatchImagesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateBatchImagesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateEmbeddingRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateEmbeddingResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateBatchEmbeddingsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateBatchEmbeddingsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamEmbeddingsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| messages | Message[] dtkt.ai.v1beta1.Message[] | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamEmbeddingsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoTranscribeRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| audio | Blob dtkt.ai.v1beta1.Blob | 1 | No description. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoTranscribeResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| text | string | 1 | No description. |
| segments | Segment[] dtkt.ai.v1beta1.TranscribeResponse.Segment[] | 2 | No description. |
| duration | Duration google.protobuf.Duration | 3 | No description. |
| language | string | 4 | Detected language; an ISO-639-1 language code |
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateSpeechRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| text | string | 1 | No description. |
| messages | Message[] dtkt.ai.v1beta1.Message[] | 2 | The input messages / prompts to be synthesized into speech |
| voice | string | 3 | Provider specific voice identifier |
| media_type | string | 4 | Output media type, e.g., "audio/mpeg", "audio/wav", "audio/ogg" |
| speed | float | 5 | Speech synthesis speed; range and meaning may vary by provider. |
| language | string | 6 | The language (input and output); an ISO-639-1 language code or 'auto' to auto-detect. Provider support may vary. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoGenerateSpeechResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| audio | Blob dtkt.ai.v1beta1.Blob | 1 | No description. |
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamSpeechRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| text | string | 1 | No description. |
| messages | Message[] dtkt.ai.v1beta1.Message[] | 2 | The input messages / prompts to be synthesized into speech |
| voice | string | 3 | Provider specific voice identifier |
| output_media_type | string | 4 | Output media type, e.g., "audio/mpeg", "audio/wav", "audio/ogg" |
| speed | float | 5 | Speech synthesis speed; range and meaning may vary by provider. |
| language | string | 6 | The language (input and output); an ISO-639-1 language code or 'auto' to auto-detect. Provider support may vary. |
| provider_options | Struct google.protobuf.Struct | 10 | No description. |
dtkt.ai.v1beta1messages.protoStreamSpeechResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| audio | Blob dtkt.ai.v1beta1.Blob | 1 | No description. |
| provider_metadata | Struct google.protobuf.Struct | 10 | No description. |
dtkt.base.v1beta1messages.protoGetPackageRequest
Messagedtkt.base.v1beta1messages.protoGetPackageResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| package | Package dtkt.shared.v1beta1.Package | 1 | Embedded package spec (package.dtkt.yaml). |
| config_schema | TypeSchema dtkt.shared.v1beta1.TypeSchema | 2 | Integration config schema used to validate CheckConfig. |
dtkt.base.v1beta1messages.protoCheckConfigRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | string | 1 | Connection resource of provided config. |
| config_data | Any google.protobuf.Any | 2 | Config to validate. |
| config_hash | string | 3 | Hash of provided config. |
| config_gen | uint64 | 4 | Generation of provided config. |
dtkt.base.v1beta1messages.protoCheckConfigResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| valid | bool | 1 | True if config is valid. |
| normalized | Struct google.protobuf.Struct | 2 | Normalized/redacted config for UX and diffs (no secrets). |
| required_scopes | string[] | 4 | Optional hint for missing privileges (e.g., OAuth scopes). |
| message | string | 5 | Human-readable summary. |
dtkt.base.v1beta1messages.protoCheckAuthRequest
MessageRequest for checking auth (3-legged OAuth over gRPC).
| Field | Type | Number | Description |
|---|---|---|---|
| type | AuthCheck dtkt.shared.v1beta1.AuthCheck | 1 | The auth check type. |
| oauthOneOf | If auth type response is OAuth. | ||
| code_request | OAuthCodeRequest dtkt.shared.v1beta1.OAuthCodeRequest | 2 | When check type is auth code url. |
| token_request | OAuthTokenRequest dtkt.shared.v1beta1.OAuthTokenRequest | 3 | When check type is callback. |
| refresh_request | OAuthRefreshRequest dtkt.shared.v1beta1.OAuthRefreshRequest | 4 | When check type is refresh. |
dtkt.base.v1beta1messages.protoCheckAuthResponse
MessageResponse for checking auth.
| Field | Type | Number | Description |
|---|---|---|---|
| type | AuthType dtkt.shared.v1beta1.AuthType | 1 | The auth type. |
| success | bool | 2 | Indicates if the auth check was successful. |
| error | string | 3 | Error message if success is false. |
| oauthOneOf | Present when type is OAuth. | ||
| auth_code_url | string | 4 | Returned when check is code. |
| token | OAuthToken dtkt.shared.v1beta1.OAuthToken | 5 | Returned when check type is token or refresh. |
dtkt.base.v1beta1messages.protoListTypesRequest
Messagedtkt.base.v1beta1messages.protoListTypesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| types | TypeSchema[] dtkt.shared.v1beta1.TypeSchema[] | 1 | Custom types registered to integration. |
| next_page_token | string | 2 | No description. |
dtkt.base.v1beta1messages.protoGetTypeRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
dtkt.base.v1beta1messages.protoGetTypeResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | TypeSchema dtkt.shared.v1beta1.TypeSchema | 1 | No description. |
dtkt.blob.v1beta1messages.protoListResult
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key for this blob result. |
| mod_time | Timestamp google.protobuf.Timestamp | 2 | ModTime is the time the blob was last modified. |
| size | int64 | 3 | Size is the size of the blob's content in bytes. |
| md5 | string | 4 | MD5 is an MD5 hash of the blob contents or nil if not available. |
| is_dir | bool | 5 | 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.protoListBlobsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| prefix | string | 1 | Prefix indicates that only blobs with a key starting with this prefix should be returned. |
| page_size | int32 | 2 | 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_token | string | 3 | A page token, received from a previous When paginating, all other parameters provided to |
| bucket | string | 4 | Bucket to write blob (may be optional). |
dtkt.blob.v1beta1messages.protoListBlobsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| results | ListResult[] dtkt.blob.v1beta1.ListResult[] | 1 | The results from the specified prefix. |
| next_page_token | string | 2 | A token that can be sent as |
dtkt.blob.v1beta1messages.protoGetBlobRequest
Messagedtkt.blob.v1beta1messages.protoGetBlobResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of blob of retrieved attributes. |
| cache_control | string | 2 | 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_disposition | string | 3 | 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_encoding | string | 4 | 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_language | string | 5 | 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_type | string | 6 | 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 |
| metadata | map<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 google.protobuf.Timestamp | 8 | CreateTime is the time the blob was created, if available. If not available, CreateTime will be the zero time. |
| mod_time | Timestamp google.protobuf.Timestamp | 9 | ModTime is the time the blob was last modified. |
| size | int64 | 10 | Size is the size of the blob's content in bytes. |
| md5 | string | 11 | MD5 is an MD5 hash of the blob contents or nil if not available. |
| etag | string | 12 | ETag for the blob; see https://en.wikipedia.org/wiki/HTTP_ETag. |
dtkt.blob.v1beta1messages.protoReadBlobLinesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of blob to read. |
| delimiter | string | 2 | Line delimiter; default: \n. |
| max_size | int64 | 3 | Max size (in bytes) of individual line. |
| bucket | string | 4 | Bucket to read blob (may be optional). |
| line_format | LineFormat dtkt.blob.v1beta1.LineFormat | 5 | Format of lines to read (default: LINE_FORMAT_RAW if unspecified). |
| json_array_mode | bool | 6 | JSON array mode: if true (when line_format is JSON), expects root JSON array; if false, expects newline-delimited JSON (default). |
dtkt.blob.v1beta1messages.protoReadBlobLinesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of blob read. |
| lineOneOf | No description. | ||
| data | bytes | 2 | Raw line data. |
| json | Value google.protobuf.Value | 3 | JSON parsed line data. |
dtkt.blob.v1beta1messages.protoReadBlobRangeRequest
Messagedtkt.blob.v1beta1messages.protoReadBlobRangeResponse
Messagedtkt.blob.v1beta1messages.protoWriteBlobRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of blob to write. |
| bucket | string | 2 | Bucket to write blob (may be optional). |
| data | bytes | 3 | Raw blob payload. |
| content_type | string | 4 | MIME type for the blob payload. |
| content_language | string | 5 | Language for the blob payload. |
| content_encoding | string | 6 | Content encoding for the blob payload. |
| cache_control | string | 7 | Cache control directives. |
| content_disposition | string | 8 | Content disposition for the blob payload. |
| metadata | map<string, string> | 9 | Blob metadata (all keys lower-case). |
| if_match | string | 10 | Require the blob to match the provided ETag before writing. |
| if_none_match | string | 11 | Require the blob to not match the provided ETag before writing. |
| if_not_exist | bool | 12 | Require the blob does not already exist before writing. |
dtkt.blob.v1beta1messages.protoWriteBlobResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of the written blob. |
| size | int64 | 2 | Size of the stored blob. |
| mod_time | Timestamp google.protobuf.Timestamp | 3 | Modification time reported by the provider. |
| etag | string | 4 | ETag assigned by the provider. |
dtkt.blob.v1beta1messages.protoWriteBlobLinesRequest
Messagedtkt.blob.v1beta1messages.protoWriteBlobLinesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| results | KeyResult[] dtkt.blob.v1beta1.WriteBlobLinesResponse.KeyResult[] | 1 | No description. |
dtkt.blob.v1beta1messages.protoDeleteBlobRequest
Messagedtkt.blob.v1beta1messages.protoDeleteBlobResponse
Messagedtkt.blob.v1beta1messages.protoCopyBlobRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| source_bucket | string | 1 | Source bucket name. If empty, defaults to destination bucket. |
| source_key | string | 2 | Source key to copy from. |
| destination_bucket | string | 3 | Destination bucket name |
| destination_key | string | 4 | Destination key to copy to. |
| overwrite | bool | 5 | Overwrite the destination blob when it already exists. |
| metadata | map<string, string> | 6 | Replacement metadata (optional). |
dtkt.blob.v1beta1messages.protoCopyBlobResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| destination_key | string | 1 | Destination key of the copied blob. |
| size | int64 | 2 | Size of the copied blob. |
| mod_time | Timestamp google.protobuf.Timestamp | 3 | Modification time reported after copy. |
| etag | string | 4 | ETag assigned at destination. |
dtkt.blob.v1beta1messages.protoGenerateSignedURLRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key of blob to sign. |
| bucket | string | 2 | Bucket to write blob (may be optional). |
| method | SignedURLMethod dtkt.blob.v1beta1.SignedURLMethod | 3 | HTTP method the signed URL will permit. |
| expires_in | Duration google.protobuf.Duration | 4 | Duration the signed URL remains valid. |
| content_type | string | 5 | Expected content type when using the signed URL. |
| query_parameters | map<string, string> | 6 | Additional query parameters enforced by the signed URL. |
| headers | map<string, string> | 7 | Additional headers enforced by the signed URL. |
dtkt.blob.v1beta1messages.protoGenerateSignedURLResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| url | string | 1 | Fully qualified signed URL. |
| expires_at | Timestamp google.protobuf.Timestamp | 2 | Expiration timestamp when the signed URL becomes invalid. |
dtkt.catalog.v1beta1messages.protoCatalog
MessageRepresents a catalog, which organizes schemas and tables.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the catalog. |
| description | string | 2 | Description of the catalog. |
| metadata | Struct google.protobuf.Struct | 3 | Additional metadata, if any. |
dtkt.catalog.v1beta1messages.protoSchema
MessageRepresents a schema, which organizes tables.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | Reference to the catalog containing the schema. |
| name | string | 2 | Name of the schema. |
| description | string | 3 | Description of the schema. |
| metadata | Struct google.protobuf.Struct | 4 | Additional metadata, if any. |
dtkt.catalog.v1beta1messages.protoTable
MessageRepresents a table within a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the table. |
| name | string | 2 | Name of the table. |
| description | string | 3 | Description of the table. |
| fields | Field[] dtkt.shared.v1beta1.Field[] | 4 | List of fields contained by the table. |
| stats | TableStats dtkt.catalog.v1beta1.TableStats | 5 | Statistics about the table (e.g., row count), if any. |
| metadata | Struct google.protobuf.Struct | 6 | Additional metadata, if any. |
dtkt.catalog.v1beta1messages.protoTableStats
MessageTableStats contains statistics about a table.
dtkt.catalog.v1beta1messages.protoQuery
MessageRepresents a query and its associated details.
| Field | Type | Number | Description |
|---|---|---|---|
| valid | bool | 1 | Indicates if the query is valid. |
| error | string | 2 | Error message, if any. |
| dialect | string | 3 | The query dialect used. |
| query | string | 4 | The query string. |
| fields | Field[] dtkt.shared.v1beta1.Field[] | 5 | List of fields returned by the query. |
| params | Param[] dtkt.shared.v1beta1.Param[] | 6 | Parameters used in the query, if any. |
dtkt.catalog.v1beta1messages.protoGetQueryDialectRequest
MessageRequest for retrieving the query dialect.
dtkt.catalog.v1beta1messages.protoGetQueryDialectResponse
MessageResponse containing the query dialect used by the service.
| Field | Type | Number | Description |
|---|---|---|---|
| dialect | string | 1 | The query dialect (e.g., SQL). |
dtkt.catalog.v1beta1messages.protoListDataTypesRequest
MessageRequest for retrieving data types.
dtkt.catalog.v1beta1messages.protoListDataTypesResponse
MessageResponse containing supported data types.
| Field | Type | Number | Description |
|---|---|---|---|
| types | DataType[] dtkt.shared.v1beta1.DataType[] | 1 | List of supported data types. |
dtkt.catalog.v1beta1messages.protoGetCatalogRequest
MessageRequest to retrieve a catalog by name.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the catalog. |
| metadata | Struct google.protobuf.Struct | 2 | Metadata of the catalog, if any. |
dtkt.catalog.v1beta1messages.protoGetCatalogResponse
MessageResponse containing catalog details.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | The requested catalog. |
dtkt.catalog.v1beta1messages.protoListSchemasRequest
MessageRequest message for retrieving all schemas.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | The catalog request containing catalog information. |
dtkt.catalog.v1beta1messages.protoListSchemasResponse
MessageResponse message for getting schemas.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | The retrieved schema. |
dtkt.catalog.v1beta1messages.protoGetSchemaRequest
MessageRequest message for retrieving a specific schema.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | The catalog request containing catalog information. |
| name | string | 2 | The name of the schema to retrieve. |
| metadata | Struct google.protobuf.Struct | 3 | Metadata of the schema, if any. |
dtkt.catalog.v1beta1messages.protoGetSchemaResponse
MessageResponse message for getting a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | The retrieved schema. |
dtkt.catalog.v1beta1messages.protoCreateSchemaRequest
MessageRequest message for creating a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | Reference to the catalog where the schema will be created. |
| name | string | 2 | Name of the new schema. |
| description | string | 3 | Description of the new schema. |
| metadata | Struct google.protobuf.Struct | 4 | Metadata of the schema, if any. |
dtkt.catalog.v1beta1messages.protoCreateSchemaResponse
MessageResponse message for creating a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | The created schema. |
| created | bool | 2 | Indicates if the schema was successfully created. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoUpdateSchemaRequest
MessageRequest message for updating a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | Reference to the catalog containing the schema. |
| name | string | 2 | Name of the schema to update. |
| description | string | 3 | New description of the schema. |
| metadata | Struct google.protobuf.Struct | 4 | Metadata of the schema, if any. |
dtkt.catalog.v1beta1messages.protoUpdateSchemaResponse
MessageResponse message for updating a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | The updated schema. |
| updated | bool | 2 | Indicates if the schema was successfully updated. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoDeleteSchemaRequest
MessageRequest message for deleting a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | Reference to the catalog containing the schema. |
| name | string | 2 | Name of the schema to delete. |
dtkt.catalog.v1beta1messages.protoDeleteSchemaResponse
MessageResponse message for deleting a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | The deleted schema. |
| deleted | bool | 2 | Indicates if the schema was successfully deleted. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoListTablesRequest
MessageRequest message for getting tables in a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the tables. |
dtkt.catalog.v1beta1messages.protoListTablesResponse
MessageResponse message for getting tables.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | The retrieved table. |
dtkt.catalog.v1beta1messages.protoGetTableRequest
MessageRequest message for getting a specific table in a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the table. |
| name | string | 2 | Name of the table to retrieve. |
| metadata | Struct google.protobuf.Struct | 3 | Metadata of the table, if any. |
dtkt.catalog.v1beta1messages.protoGetTableResponse
MessageResponse message for getting a specific table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | The retrieved table. |
dtkt.catalog.v1beta1messages.protoCreateTableRequest
MessageRequest message for creating a table in a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema where the table will be created. |
| name | string | 2 | Name of the new table. |
| description | string | 3 | Description of the new table. |
| fields | Field[] dtkt.shared.v1beta1.Field[] | 4 | Fields of the new table. |
| metadata | Struct google.protobuf.Struct | 5 | Metadata of the table, if any. |
dtkt.catalog.v1beta1messages.protoCreateTableResponse
MessageResponse message for creating a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | The created table. |
| created | bool | 2 | Indicates if the table was successfully created. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoUpdateTableRequest
MessageRequest message for updating a table in a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the table. |
| name | string | 2 | Name of the table to update. |
| description | string | 3 | New description of the table. |
| fields | Field[] dtkt.shared.v1beta1.Field[] | 4 | Fields of the table. |
| metadata | Struct google.protobuf.Struct | 5 | Metadata of the table, if any. |
dtkt.catalog.v1beta1messages.protoUpdateTableResponse
MessageResponse message for updating a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | The updated table. |
| updated | bool | 2 | Indicates if the table was successfully updated. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoDeleteTableRequest
MessageRequest message for deleting a table in a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the table. |
| name | string | 2 | Name of the table to delete. |
dtkt.catalog.v1beta1messages.protoDeleteTableResponse
MessageResponse message for deleting a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | The deleted table. |
| deleted | bool | 2 | Indicates if the table was successfully deleted. |
| error | string | 3 | Error message, if any. |
dtkt.catalog.v1beta1messages.protoWriteTablesRequest
MessageRequest message for writing to a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | Reference to the table where row will be written. |
| row | Struct google.protobuf.Struct | 2 | Row to write to the table. |
dtkt.catalog.v1beta1messages.protoWriteTableResponse
MessageResponse message for rows written to a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | Reference to the table where rows were written. |
| rows_written | int64 | 2 | Number of rows successfully written. |
dtkt.catalog.v1beta1messages.protoWriteTablesResponse
MessageResponse message for writing rows to multiple tables.
| Field | Type | Number | Description |
|---|---|---|---|
| tables | WriteTableResponse[] dtkt.catalog.v1beta1.WriteTableResponse[] | 1 | Results for each table written. |
dtkt.catalog.v1beta1messages.protoReadTableRequest
MessageRequest message for reading rows from a table.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta1.Schema | 1 | Reference to the schema containing the table. |
| name | string | 2 | Name of the table to read from. |
| offset | int64 | 3 | Offset for reading rows. |
| selected_fields | string[] | 4 | Selected fields to read from the table. |
dtkt.catalog.v1beta1messages.protoReadTableResponse
MessageResponse message for reading rows from a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta1.Table | 1 | Reference to the table from which rows were read. |
| row | Struct google.protobuf.Struct | 2 | A row read from the table. |
dtkt.catalog.v1beta1messages.protoValidateQueryRequest
MessageRequest to validate a query.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to validate. |
| accessible | CatalogPermission[] dtkt.catalog.v1beta1.CatalogPermission[] | 2 | Accessible catalogs for validation. |
| params | Param[] dtkt.shared.v1beta1.Param[] | 3 | Parameters used in the query. |
dtkt.catalog.v1beta1messages.protoValidateQueryResponse
MessageResponse for query validation.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta1.Query | 1 | Validated query details. |
| accessed | CatalogPermission[] dtkt.catalog.v1beta1.CatalogPermission[] | 2 | Permissions accessed by the query. |
dtkt.catalog.v1beta1messages.protoGetQueryResultsRequest
MessageRequest to retrieve query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to execute. |
| params | Param[] dtkt.shared.v1beta1.Param[] | 2 | Parameters used in the query. |
| page_size | int32 | 3 | Number of rows per page. |
| page | string | 4 | Token for the desired page. |
dtkt.catalog.v1beta1messages.protoGetQueryResultsResponse
MessageResponse containing query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta1.Query | 1 | Details of the executed query. |
| results_page | QueryResultsPage dtkt.catalog.v1beta1.QueryResultsPage | 2 | Results page containing rows. |
dtkt.catalog.v1beta1messages.protoStreamQueryResultsRequest
MessageRequest to stream query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to execute. |
| params | Param[] dtkt.shared.v1beta1.Param[] | 2 | Parameters used in the query. |
dtkt.catalog.v1beta1messages.protoStreamQueryResultsResponse
MessageResponse containing streamed query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta1.Query | 1 | Details of the executed query. |
| row | Struct google.protobuf.Struct | 2 | A row of query results. |
dtkt.catalog.v1beta1messages.protoColumnPermission
MessageRepresents permissions for a column.
dtkt.catalog.v1beta1messages.protoTablePermission
MessageRepresents permissions for a table.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the table. |
| alias | string | 2 | Alias for the table. |
| columns | ColumnPermission[] dtkt.catalog.v1beta1.ColumnPermission[] | 3 | Column-level permissions. |
dtkt.catalog.v1beta1messages.protoSchemaPermission
MessageRepresents permissions for a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the schema. |
| alias | string | 2 | Alias for the schema. |
| tables | TablePermission[] dtkt.catalog.v1beta1.TablePermission[] | 3 | Table-level permissions. |
dtkt.catalog.v1beta1messages.protoCatalogPermission
MessageRepresents permissions for a catalog.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the catalog. |
| alias | string | 2 | Alias for the catalog. |
| schemas | SchemaPermission[] dtkt.catalog.v1beta1.SchemaPermission[] | 3 | Schema-level permissions. |
dtkt.catalog.v1beta1messages.protoQueryResultsPage
MessageRepresents a page of query results.
| Field | Type | Number | Description |
|---|---|---|---|
| prev_page | string | 1 | Token for the previous page of results. |
| next_page | string | 2 | Token for the next page of results. |
| total_pages | uint64 | 3 | Total number of pages available. |
| total_rows | uint64 | 4 | Total number of rows available. |
| rows_count | uint64 | 5 | Number of rows in the current page. |
| rows | Struct[] google.protobuf.Struct[] | 6 | Rows in the current page. |
dtkt.catalog.v1beta2type.protoType
MessageType encodes a catalog implementation's native data type with a corresponding kind and additional JSON, Geospatial, and type parameters.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the implementation's native type: (e.g. VARCHAR, BIGINT, etc.). |
| kind | TypeKind dtkt.catalog.v1beta2.TypeKind | 2 | Kind of the type as defined in this package. |
| json_type | JSONType dtkt.catalog.v1beta2.JSONType | 3 | Corresponding JSON type representation, if any. |
| geo_type | GeoType dtkt.catalog.v1beta2.GeoType | 4 | Corresponding Geo type representation, if any. |
| parameters | string[] | 10 | Type parameters, if any: e.g. (parametric types such as VARCHAR(10), DECIMAL(22, 5), etc.) |
dtkt.catalog.v1beta2type.protoField
MessageField encodes a named type (see above) definition of a value found in the context of a table read/write or query param/result.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the field. |
| type | Type dtkt.catalog.v1beta2.Type | 2 | Type of the field. |
| description | string | 3 | Description of the field. |
| nullable | bool | 4 | 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). |
| repeated | bool | 5 | 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[] dtkt.catalog.v1beta2.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 dtkt.protoform.v1beta1.FieldElement | 7 | Protoform field element for runtime dynamic form UI. |
dtkt.catalog.v1beta2catalog.protoCatalog
MessageRepresents a catalog resource specifying a query dialect, supported data types and additional metadata (if any).
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Catalog resource name, format: |
| catalog_id | string | 2 | Catalog identifier. |
| description | string | 3 | Description of the catalog. |
| query_dialect | string | 4 | Supported query dialect (e.g., Trino, GoogleSQL, Postgres, etc.). |
| data_types | Type[] dtkt.catalog.v1beta2.Type[] | 5 | List of supported data types. |
| metadata | map<string, string> | 10 | Additional metadata, if any. |
dtkt.catalog.v1beta2catalog.protoCreateCatalogRequest
MessageCreate catalog request.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog_id | string | 2 | Catalog identifier, e.g. final segment in resource name: |
| catalog | Catalog dtkt.catalog.v1beta2.Catalog | 3 | Catalog to create. |
dtkt.catalog.v1beta2catalog.protoCreateCatalogResponse
MessageCreate catalog response.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta2.Catalog | 1 | Catalog created. |
dtkt.catalog.v1beta2catalog.protoGetCatalogRequest
MessageRequest to retrieve a catalog by name.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Catalog resource to retreve. |
dtkt.catalog.v1beta2catalog.protoGetCatalogResponse
MessageResponse containing catalog details.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta2.Catalog | 1 | The requested catalog. |
dtkt.catalog.v1beta2catalog.protoListCatalogsRequest
MessageList catalogs request.
dtkt.catalog.v1beta2catalog.protoListCatalogsResponse
MessageList catalogs response.
| Field | Type | Number | Description |
|---|---|---|---|
| catalogs | Catalog[] dtkt.catalog.v1beta2.Catalog[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.catalog.v1beta2catalog.protoUpdateCatalogRequest
MessageUpdate catalog request.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta2.Catalog | 1 | Catalog with updated fields |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update. |
dtkt.catalog.v1beta2catalog.protoUpdateCatalogResponse
MessageUpdate catalog response.
| Field | Type | Number | Description |
|---|---|---|---|
| catalog | Catalog dtkt.catalog.v1beta2.Catalog | 1 | The updated catalog. |
dtkt.catalog.v1beta2catalog.protoDeleteCatalogRequest
MessageDelete catalog request.
dtkt.catalog.v1beta2catalog.protoDeleteCatalogResponse
MessageDelete catalog response.
dtkt.catalog.v1beta2value.protoValue
MessageValue 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.
dtkt.catalog.v1beta2value.protoListValue
MessageList of values for repeated fields.
| Field | Type | Number | Description |
|---|---|---|---|
| values | Value[] dtkt.catalog.v1beta2.Value[] | 1 | No description. |
dtkt.catalog.v1beta2value.protoRow
MessageRow 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.
| Field | Type | Number | Description |
|---|---|---|---|
| values | Value[] dtkt.catalog.v1beta2.Value[] | 1 | No description. |
dtkt.catalog.v1beta2value.protoDoubleValue
Messagedtkt.catalog.v1beta2value.protoFloatValue
MessageNullable wrapper message for float.
dtkt.catalog.v1beta2value.protoInt64Value
MessageNullable wrapper message for int64.
dtkt.catalog.v1beta2value.protoUInt64Value
MessageNullable wrapper message for uint64.
dtkt.catalog.v1beta2value.protoInt32Value
MessageNullable wrapper message for int32.
dtkt.catalog.v1beta2value.protoUInt32Value
MessageNullable wrapper message for uint32.
dtkt.catalog.v1beta2value.protoBoolValue
MessageNullable wrapper message for bool.
dtkt.catalog.v1beta2value.protoStringValue
MessageNullable wrapper message for string.
dtkt.catalog.v1beta2value.protoBytesValue
MessageNullable wrapper message for bytes.
dtkt.catalog.v1beta2value.protoEnumValue
MessageNullable wrapper message for ENUM values.
dtkt.catalog.v1beta2query.protoQuery
MessageRepresents a query and its associated details.
| Field | Type | Number | Description |
|---|---|---|---|
| valid | bool | 1 | Indicates if the query is valid. |
| error | string | 2 | Error message, if any. |
| dialect | string | 3 | The query dialect used. |
| query | string | 4 | The query string. |
| params | Param[] dtkt.catalog.v1beta2.Param[] | 5 | Parameters used in the query, if any. |
| fields | Field[] dtkt.catalog.v1beta2.Field[] | 6 | List of fields returned by the query. |
dtkt.catalog.v1beta2query.protoValidateQueryRequest
MessageRequest to validate a query.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to validate. |
| params | Param[] dtkt.catalog.v1beta2.Param[] | 2 | Parameters used in the query. |
| accessible | CatalogPermission[] dtkt.catalog.v1beta2.CatalogPermission[] | 3 | Accessible catalogs for validation. |
dtkt.catalog.v1beta2query.protoValidateQueryResponse
MessageResponse for query validation.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta2.Query | 1 | Validated query details. |
| accessed | CatalogPermission[] dtkt.catalog.v1beta2.CatalogPermission[] | 2 | Permissions accessed by the query. |
dtkt.catalog.v1beta2query.protoListQueryResultsRequest
MessageRequest to retrieve query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to execute. |
| page_size | int32 | 2 | Number of rows per page. |
| page_token | string | 3 | Token for the desired page (empty for first page). |
| params | Param[] dtkt.catalog.v1beta2.Param[] | 10 | Parameters used in the query. |
dtkt.catalog.v1beta2query.protoListQueryResultsResponse
MessageResponse containing query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta2.Query | 1 | Details of the executed query. |
| rows | Row[] dtkt.catalog.v1beta2.Row[] | 2 | A list of query result rows with each row conforming to the fields defined in query. |
| next_page_token | string | 10 | Next page token (empty for last page) |
dtkt.catalog.v1beta2query.protoStreamQueryResultsRequest
MessageRequest to stream query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | string | 1 | The query to execute. |
| params | Param[] dtkt.catalog.v1beta2.Param[] | 2 | Parameters used in the query. |
dtkt.catalog.v1beta2query.protoStreamQueryResultsResponse
MessageResponse containing streamed query results.
| Field | Type | Number | Description |
|---|---|---|---|
| query | Query dtkt.catalog.v1beta2.Query | 1 | Details of the executed query. |
| row | Row dtkt.catalog.v1beta2.Row | 2 | A single query result row conforming to the fields defined in query. |
dtkt.catalog.v1beta2query.protoParam
MessageRepresents a parameterized value used in a query, input/output, etc.
| Field | Type | Number | Description |
|---|---|---|---|
| field | Field dtkt.catalog.v1beta2.Field | 1 | Field describing the param data. |
| value | Value dtkt.catalog.v1beta2.Value | 2 | Value of the parameter, if any. |
dtkt.catalog.v1beta2query.protoCatalogPermission
MessageRepresents permissions for a catalog.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the catalog. |
| alias | string | 2 | Alias for the catalog. |
| schemas | SchemaPermission[] dtkt.catalog.v1beta2.SchemaPermission[] | 3 | Schema-level permissions. |
dtkt.catalog.v1beta2query.protoSchemaPermission
MessageRepresents permissions for a schema.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the schema. |
| alias | string | 2 | Alias for the schema. |
| tables | TablePermission[] dtkt.catalog.v1beta2.TablePermission[] | 3 | Table-level permissions. |
dtkt.catalog.v1beta2query.protoTablePermission
MessageRepresents permissions for a table.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the table. |
| alias | string | 2 | Alias for the table. |
| columns | ColumnPermission[] dtkt.catalog.v1beta2.ColumnPermission[] | 3 | Column-level permissions. |
dtkt.catalog.v1beta2query.protoColumnPermission
MessageRepresents permissions for a column.
dtkt.catalog.v1beta2schema.protoSchema
MessageSchema resource containing tables.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Schema resource name, format: |
| schema_id | string | 2 | Schema identifier. |
| description | string | 3 | Description of the schema. |
| metadata | map<string, string> | 4 | Additional metadata, if any. |
dtkt.catalog.v1beta2schema.protoListSchemasRequest
MessageRequest message for listing schemas.
dtkt.catalog.v1beta2schema.protoListSchemasResponse
MessageResponse message for listing schemas.
| Field | Type | Number | Description |
|---|---|---|---|
| schemas | Schema[] dtkt.catalog.v1beta2.Schema[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.catalog.v1beta2schema.protoGetSchemaRequest
MessageGet schema request.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Schema resource name to retrieve. |
| metadata | map<string, string> | 2 | Metadata of the schema, if any. |
dtkt.catalog.v1beta2schema.protoGetSchemaResponse
MessageGet schema response.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta2.Schema | 1 | The retrieved schema. |
dtkt.catalog.v1beta2schema.protoCreateSchemaRequest
MessageCreate schema request.
| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Parent catalog resource name. |
| schema_id | string | 2 | Schema identifier, e.g. final segment in resource name: |
| schema | Schema dtkt.catalog.v1beta2.Schema | 3 | Schema to create. |
dtkt.catalog.v1beta2schema.protoCreateSchemaResponse
MessageCreate schema response.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta2.Schema | 1 | Schema created. |
dtkt.catalog.v1beta2schema.protoUpdateSchemaRequest
MessageUpdate schema request.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta2.Schema | 1 | Schema with updated fields |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update. |
dtkt.catalog.v1beta2schema.protoUpdateSchemaResponse
MessageUpdate schema response.
| Field | Type | Number | Description |
|---|---|---|---|
| schema | Schema dtkt.catalog.v1beta2.Schema | 1 | The updated schema. |
dtkt.catalog.v1beta2schema.protoDeleteSchemaRequest
MessageRequest message for deleting a schema.
dtkt.catalog.v1beta2schema.protoDeleteSchemaResponse
MessageResponse message for deleting a schema.
dtkt.catalog.v1beta2table.protoTable
MessageRepresents a table within a table.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Table resource name, format: |
| table_id | string | 2 | Table identifier. |
| description | string | 3 | Description of the table. |
| fields | Field[] dtkt.catalog.v1beta2.Field[] | 34 | List of fields defined by the table. |
| stats | TableStats dtkt.catalog.v1beta2.TableStats | 5 | Statistics about the table (e.g., row count), if any. |
| metadata | map<string, string> | 10 | Additional metadata, if any. |
dtkt.catalog.v1beta2table.protoTableStats
MessageTableStats contains statistics about a table.
dtkt.catalog.v1beta2table.protoListTablesRequest
MessageRequest message for listing Tables.
dtkt.catalog.v1beta2table.protoListTablesResponse
MessageResponse message for listing Tables.
| Field | Type | Number | Description |
|---|---|---|---|
| tables | Table[] dtkt.catalog.v1beta2.Table[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.catalog.v1beta2table.protoGetTableRequest
MessageGet Table request.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Table resource name to retrieve. |
| metadata | map<string, string> | 2 | Metadata of the Table, if any. |
dtkt.catalog.v1beta2table.protoGetTableResponse
MessageGet Table response.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta2.Table | 1 | The retrieved Table. |
dtkt.catalog.v1beta2table.protoCreateTableRequest
MessageCreate Table request.
| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Parent catalog resource name. |
| table_id | string | 2 | Table identifier, e.g. final segment in resource name: |
| table | Table dtkt.catalog.v1beta2.Table | 3 | Table to create. |
dtkt.catalog.v1beta2table.protoCreateTableResponse
MessageCreate Table response.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta2.Table | 1 | Table created. |
dtkt.catalog.v1beta2table.protoUpdateTableRequest
MessageUpdate Table request.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta2.Table | 1 | Table with updated fields |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update. |
dtkt.catalog.v1beta2table.protoUpdateTableResponse
MessageUpdate Table response.
| Field | Type | Number | Description |
|---|---|---|---|
| table | Table dtkt.catalog.v1beta2.Table | 1 | The updated Table. |
dtkt.catalog.v1beta2table.protoDeleteTableRequest
MessageRequest message for deleting a table.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of table to delete. |
dtkt.catalog.v1beta2table.protoDeleteTableResponse
MessageResponse message for deleting a table.
dtkt.catalog.v1beta2table.protoWriteRowsRequest
MessageRequest message for writing to a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | string | 1 | Table resource name to write row. |
| row | Row dtkt.catalog.v1beta2.Row | 2 | A single row to be written to table and conforming to the description found in value.proto. |
dtkt.catalog.v1beta2table.protoWriteRowsResponse
MessageResponse message for rows written to a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table_rows_written | map<string, int64> | 1 | Map of table resource name to total rows written. |
dtkt.catalog.v1beta2table.protoReadRowsRequest
MessageRequest message for reading rows from a table.
dtkt.catalog.v1beta2table.protoReadRowsResponse
MessageResponse message for reading rows from a table.
| Field | Type | Number | Description |
|---|---|---|---|
| table | string | 1 | Table resource name to read row. |
| rows | Row[] dtkt.catalog.v1beta2.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.protoSSHConfig
MessageConfiguration for remote SSH execution.
| Field | Type | Number | Description |
|---|---|---|---|
| address | string | 1 | Hostname or IP address and port of the SSH server |
| user | string | 2 | Username for SSH authentication |
| authOneOf | Authentication method If not provided, uses SSH agent by default (matches SSH CLI behavior) | ||
| private_key | PrivateKeyAuth dtkt.command.v1beta1.SSHConfig.PrivateKeyAuth | 3 | Private key authentication |
| identity_file | IdentityFileAuth dtkt.command.v1beta1.SSHConfig.IdentityFileAuth | 4 | Identity file authentication |
| password | string | 5 | 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_path | string | 6 | 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 dtkt.command.v1beta1.SSHConfig.KnownHosts | 7 | Verify against known_hosts files (uses default locations if empty) |
| fingerprint | string | 8 | Verify against specific fingerprint (SHA256 or MD5 format)
Examples: "SHA256:abc123..." or "MD5:12:34:56:..."
Get fingerprint: |
| insecure_skip_verify | bool | 9 | Skip verification (INSECURE) |
| proxy_command | string | 10 | ProxyCommand to tunnel SSH connection through another command
Example: |
| config_file_path | string | 11 | 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.protoCommandDoc
MessageDescribes a command.
| Field | Type | Number | Description |
|---|---|---|---|
| usage | string | 1 | No description. |
| short | string | 2 | No description. |
| long | string | 3 | No description. |
| examples | string[] | 4 | No description. |
| flags | FlagDoc[] dtkt.command.v1beta1.FlagDoc[] | 5 | No description. |
| inherited_flags | FlagDoc[] dtkt.command.v1beta1.FlagDoc[] | 6 | No description. |
dtkt.command.v1beta1messages.protoFlagDoc
MessageDescribes a command flag.
dtkt.command.v1beta1messages.protoCommand
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
| description | string | 2 | No description. |
| commands | CommandDoc[] dtkt.command.v1beta1.CommandDoc[] | 3 | No description. |
dtkt.command.v1beta1messages.protoListCommandsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| commands | Command[] dtkt.command.v1beta1.Command[] | 1 | No description. |
dtkt.command.v1beta1messages.protoGetCommandRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
dtkt.command.v1beta1messages.protoGetCommandResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| command | Command[] dtkt.command.v1beta1.Command[] | 1 | No description. |
dtkt.command.v1beta1messages.protoExecutableCommand
MessageA command to execute.
| Field | Type | Number | Description |
|---|---|---|---|
| command | string | 1 | Command executable. |
| args | string[] | 2 | No description. |
| workdir | string | 3 | No description. |
| env | map<string, string> | 4 | No description. |
| timeout | Duration google.protobuf.Duration | 5 | No description. |
| expects_stdin | bool | 6 | 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.protoShellCommand
MessageA shell command to execute.
| Field | Type | Number | Description |
|---|---|---|---|
| command | string | 1 | The shell command (supports pipes and redirects). |
| workdir | string | 3 | No description. |
| env | map<string, string> | 4 | No description. |
| timeout | Duration google.protobuf.Duration | 5 | No description. |
| expects_stdin | bool | 6 | 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.protoCommandInput
MessageA single stdin chunk or signal for streaming commands.
| Field | Type | Number | Description |
|---|---|---|---|
| stdin | bytes | 1 | No description. |
| eof | bool | 2 | No description. |
| signal | Signal dtkt.command.v1beta1.Signal | 3 | No description. |
dtkt.command.v1beta1messages.protoCommandOutput
Messagestdout and stderr chunks
dtkt.command.v1beta1messages.protoCommandResult
MessageThe result of a command execution.
| Field | Type | Number | Description |
|---|---|---|---|
| exit_code | int32 | 1 | No description. |
| reason | Reason dtkt.command.v1beta1.CommandResult.Reason | 2 | No description. |
| duration | Duration google.protobuf.Duration | 3 | No description. |
dtkt.command.v1beta1messages.protoBatchResult
Message| Field | Type | Number | Description |
|---|---|---|---|
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 1 | No description. |
| result | CommandResult dtkt.command.v1beta1.CommandResult | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteCommandRequest
MessageThe request for executing a command.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ExecutableCommand dtkt.command.v1beta1.ExecutableCommand | 1 | The command to execute |
| input | CommandInput dtkt.command.v1beta1.CommandInput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteCommandResponse
MessageThe response for executing a command.
| Field | Type | Number | Description |
|---|---|---|---|
| result | CommandResult dtkt.command.v1beta1.CommandResult | 1 | No description. |
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteCommandsRequest
MessageThe request for executing a stream of commands.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ExecutableCommand dtkt.command.v1beta1.ExecutableCommand | 1 | Command to execute |
dtkt.command.v1beta1messages.protoExecuteCommandsResponse
MessageThe response for executing a stream of commands.
| Field | Type | Number | Description |
|---|---|---|---|
| result | CommandResult dtkt.command.v1beta1.CommandResult | 1 | No description. |
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteStreamedCommandRequest
MessageThe request for streaming a single command.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ExecutableCommand dtkt.command.v1beta1.ExecutableCommand | 1 | No description. |
| input | CommandInput dtkt.command.v1beta1.CommandInput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteStreamedCommandResponse
MessageThe response for streaming a single command.
| Field | Type | Number | Description |
|---|---|---|---|
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 1 | No description. |
| result | CommandResult dtkt.command.v1beta1.CommandResult | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteBatchCommandsRequest
MessageThe request for executing a batch of commands.
| Field | Type | Number | Description |
|---|---|---|---|
| commands | ExecutableCommand[] dtkt.command.v1beta1.ExecutableCommand[] | 1 | No description. |
dtkt.command.v1beta1messages.protoExecuteBatchCommandsResponse
MessageThe response for executing a batch of commands.
| Field | Type | Number | Description |
|---|---|---|---|
| results | BatchResult[] dtkt.command.v1beta1.BatchResult[] | 1 | No description. |
dtkt.command.v1beta1messages.protoExecuteShellCommandRequest
MessageThe request for executing a shell command.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ShellCommand dtkt.command.v1beta1.ShellCommand | 1 | The shell command to execute |
dtkt.command.v1beta1messages.protoExecuteShellCommandResponse
MessageThe response for executing a shell command.
| Field | Type | Number | Description |
|---|---|---|---|
| result | CommandResult dtkt.command.v1beta1.CommandResult | 1 | No description. |
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteShellCommandsRequest
MessageThe request for executing a stream of shell commands.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ShellCommand dtkt.command.v1beta1.ShellCommand | 1 | Shell command to execute |
dtkt.command.v1beta1messages.protoExecuteShellCommandsResponse
MessageThe response for executing a stream of shell commands.
| Field | Type | Number | Description |
|---|---|---|---|
| result | CommandResult dtkt.command.v1beta1.CommandResult | 1 | No description. |
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteStreamedShellCommandRequest
MessageThe request for streaming a single shell command.
| Field | Type | Number | Description |
|---|---|---|---|
| command | ShellCommand dtkt.command.v1beta1.ShellCommand | 1 | No description. |
| input | CommandInput dtkt.command.v1beta1.CommandInput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteStreamedShellCommandResponse
MessageThe response for streaming a single shell command.
| Field | Type | Number | Description |
|---|---|---|---|
| result | CommandResult dtkt.command.v1beta1.CommandResult | 1 | No description. |
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 2 | No description. |
dtkt.command.v1beta1messages.protoExecuteBatchShellCommandsRequest
MessageThe request for executing a batch of shell commands.
| Field | Type | Number | Description |
|---|---|---|---|
| commands | ShellCommand[] dtkt.command.v1beta1.ShellCommand[] | 1 | No description. |
dtkt.command.v1beta1messages.protoExecuteBatchShellCommandsResponse
MessageThe response for executing a batch of shell commands.
| Field | Type | Number | Description |
|---|---|---|---|
| results | BatchResult[] dtkt.command.v1beta1.BatchResult[] | 1 | No description. |
dtkt.command.v1beta1messages.protoTerminalSessionRequest
MessageThe request for a terminal session and streaming in input.
| Field | Type | Number | Description |
|---|---|---|---|
| start | StartEvent dtkt.command.v1beta1.TerminalSessionRequest.StartEvent | 1 | No description. |
| resize | ResizeEvent dtkt.command.v1beta1.TerminalSessionRequest.ResizeEvent | 2 | No description. |
| input | CommandInput dtkt.command.v1beta1.CommandInput | 3 | No description. |
dtkt.command.v1beta1messages.protoTerminalSessionResponse
MessageThe response for a terminal session.
| Field | Type | Number | Description |
|---|---|---|---|
| output | CommandOutput dtkt.command.v1beta1.CommandOutput | 1 | No description. |
dtkt.flow.v1beta1type.protoBool
Messagedtkt.flow.v1beta1type.protoBytes
Messagedtkt.flow.v1beta1type.protoDouble
Messagedtkt.flow.v1beta1type.protoFloat
Messagedtkt.flow.v1beta1type.protoInt64
Messagedtkt.flow.v1beta1type.protoUint64
Messagedtkt.flow.v1beta1type.protoInt32
Messagedtkt.flow.v1beta1type.protoUint32
Messagedtkt.flow.v1beta1type.protoString
Messagedtkt.flow.v1beta1type.protoList
Message| Field | Type | Number | Description |
|---|---|---|---|
| items | string | 1 | Type of list items: scalar type, nested list/map, or message type |
| nullable | bool | 2 | No description. |
| default | ListValue google.protobuf.ListValue | 3 | No description. |
dtkt.flow.v1beta1type.protoMap
Message| Field | Type | Number | Description |
|---|---|---|---|
| key | string | 1 | Key type: bool, int32, int64, uint32, uint64, or string (default) |
| value | string | 2 | Value type: scalar type, nested list/map, or message type |
| nullable | bool | 3 | No description. |
| default | Struct google.protobuf.Struct | 4 | No description. |
dtkt.flow.v1beta1type.protoMessage
MessageProto message type
| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | Fully qualified message name: "google.protobuf.Struct", "google.protobuf.Timestamp", etc. |
| nullable | bool | 2 | No description. |
| default | Struct google.protobuf.Struct | 3 | No description. |
dtkt.flow.v1beta1spec.protoFlow
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
| description | string | 2 | No description. |
| connections | Connection[] dtkt.flow.v1beta1.Connection[] | 3 | No description. |
| inputs | Input[] dtkt.flow.v1beta1.Input[] | 4 | No description. |
| vars | Var[] dtkt.flow.v1beta1.Var[] | 5 | No description. |
| actions | Action[] dtkt.flow.v1beta1.Action[] | 7 | No description. |
| outputs | Output[] dtkt.flow.v1beta1.Output[] | 9 | No description. |
| streams | Stream[] dtkt.flow.v1beta1.Stream[] | 10 | No description. |
dtkt.flow.v1beta1spec.protoConnection
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| services | string[] | 2 | No description. |
| package | Identity dtkt.shared.v1beta1.Package.Identity | 3 | No description. |
dtkt.flow.v1beta1spec.protoInput
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| typeOneOf | No description. | ||
| bool | Bool dtkt.flow.v1beta1.Bool | 3 | No description. |
| bytes | Bytes dtkt.flow.v1beta1.Bytes | 4 | No description. |
| double | Double dtkt.flow.v1beta1.Double | 5 | No description. |
| float | Float dtkt.flow.v1beta1.Float | 6 | No description. |
| int64 | Int64 dtkt.flow.v1beta1.Int64 | 7 | No description. |
| uint64 | Uint64 dtkt.flow.v1beta1.Uint64 | 8 | No description. |
| int32 | Int32 dtkt.flow.v1beta1.Int32 | 9 | No description. |
| uint32 | Uint32 dtkt.flow.v1beta1.Uint32 | 10 | No description. |
| string | String dtkt.flow.v1beta1.String | 11 | No description. |
| list | List dtkt.flow.v1beta1.List | 12 | No description. |
| map | Map dtkt.flow.v1beta1.Map | 13 | No description. |
| message | Message dtkt.flow.v1beta1.Message | 14 | No description. |
| cache | bool | 20 | No description. |
dtkt.flow.v1beta1spec.protoVar
MessageVar is an intermediate value in a Flow used to transform and/or memoize the result of a computation for reuse.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| cache | bool | 2 | When cache is true var always returns its first non-null memoized value. |
| typeOneOf | No description. | ||
| value | string | 3 | Given expression evaluates to var's memoized value, example: "= inputs.foo.getValue()" |
| switch | Switch dtkt.flow.v1beta1.Switch | 4 | Given switch statement's first matching case (otherwise default) evaluates to var's memoized value. |
dtkt.flow.v1beta1spec.protoAction
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| run_if | string | 2 | No description. |
| on_error | string | 3 | No description. |
| cache | bool | 10 | When cache is true action always returns its first non-null memoized value. |
| typeOneOf | No description. | ||
| call | MethodCall dtkt.flow.v1beta1.MethodCall | 4 | No description. |
| user | UserAction dtkt.flow.v1beta1.UserAction | 5 | No description. |
dtkt.flow.v1beta1spec.protoOutput
Messagedtkt.flow.v1beta1spec.protoStream
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| start_if | string | 10 | Start stream when expression evaluates to true; optional. |
| stop_if | string | 11 | Stop stream when expression evaluates to true; optional. |
| typeOneOf | No description. | ||
| call | MethodCall dtkt.flow.v1beta1.MethodCall | 2 | No description. |
| generate | Ticker dtkt.flow.v1beta1.Ticker | 3 | No description. |
dtkt.flow.v1beta1spec.protoMethodCall
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | string | 1 | No description. |
| method | string | 2 | No description. |
| request | Value google.protobuf.Value | 3 | No description. |
| response | string | 4 | No description. |
dtkt.flow.v1beta1spec.protoUserAction
Message| Field | Type | Number | Description |
|---|---|---|---|
| inputs | Input[] dtkt.flow.v1beta1.UserAction.Input[] | 1 | No description. |
dtkt.flow.v1beta1spec.protoSwitch
Message| Field | Type | Number | Description |
|---|---|---|---|
| value | string | 1 | No description. |
| case | Case[] dtkt.flow.v1beta1.Switch.Case[] | 2 | No description. |
| default | string | 3 | No description. |
dtkt.flow.v1beta1spec.protoTicker
Message| Field | Type | Number | Description |
|---|---|---|---|
| every | Duration google.protobuf.Duration | 1 | No description. |
| initial | Duration google.protobuf.Duration | 2 | No description. |
| value | string | 3 | No description. |
dtkt.flow.v1beta1eval.protoRuntime
Message| Field | Type | Number | Description |
|---|---|---|---|
| connections | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 1 | No description. |
| inputs | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 2 | No description. |
| vars | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 3 | No description. |
| actions | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 5 | No description. |
| streams | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 8 | No description. |
| outputs | map<string, Node> map<string, dtkt.flow.v1beta1.Node> | 7 | No description. |
dtkt.flow.v1beta1eval.protoGraph
Message| Field | Type | Number | Description |
|---|---|---|---|
| nodes | Node[] dtkt.flow.v1beta1.Node[] | 1 | No description. |
| edges | Edge[] dtkt.flow.v1beta1.Edge[] | 2 | No description. |
dtkt.flow.v1beta1eval.protoGroups
Message| Field | Type | Number | Description |
|---|---|---|---|
| groups | Group[] dtkt.flow.v1beta1.Groups.Group[] | 1 | No description. |
dtkt.flow.v1beta1eval.protoEdge
Messagedtkt.flow.v1beta1eval.protoNode
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| state | State dtkt.flow.v1beta1.Node.State | 2 | No description. |
| call_count | uint64 | 4 | No description. |
| prev_value | Value cel.expr.Value | 5 | No description. |
| curr_value | Value cel.expr.Value | 6 | No description. |
| typeOneOf | No description. | ||
| connection | Connection dtkt.flow.v1beta1.Connection | 7 | No description. |
| input | Input dtkt.flow.v1beta1.Input | 8 | No description. |
| var | Var dtkt.flow.v1beta1.Var | 9 | No description. |
| action | Action dtkt.flow.v1beta1.Action | 11 | No description. |
| output | Output dtkt.flow.v1beta1.Output | 13 | No description. |
| stream | Stream dtkt.flow.v1beta1.Stream | 14 | No description. |
dtkt.core.v1messages.protoAutomation
MessageAutomation is a runnable instance of a Flow with a tagged spec version and runtime configuration.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Automation resource name is one of:
|
| uid | string | 2 | Server-assigned unique ID (UUID). |
| flow | string | 3 | Name of flow resource to resolve spec. |
| etag | string | 4 | Checksum of flow spec must match when resolving spec (concurrency control). |
| exec | ExecutionMetadata dtkt.core.v1.Automation.ExecutionMetadata | 5 | Execution metadata of resolved Flow spec (versioned). |
| connections | map<string, ConnectionMetadata> map<string, dtkt.core.v1.Automation.ConnectionMetadata> | 6 | Connections configuration as map of connection node id to connection resource name and context (control plane). Examples: |
| inputs | map<string, Any> map<string, google.protobuf.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 google.protobuf.Duration | 8 | Execution is stopped if total time exceeds given duration. Default: 0; no timeout |
| batch | string | 9 | Server-assigned batch name if created within a batch (optional). |
| create_time | Timestamp google.protobuf.Timestamp | 20 | Automation create time. |
| update_time | Timestamp google.protobuf.Timestamp | 21 | Automation update time. |
dtkt.core.v1messages.protoFlow
MessageFlow is a versioned workflow spec with parsed graph representation.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Flow resource name is one of:
|
| uid | string | 2 | Server-assigned unique ID (UUID). |
| spec_uri | string | 3 | Spec source URI (optional). |
| spec_etag | string | 4 | Spec source checksum for concurrency control. |
| spec | SpecMetadata dtkt.core.v1.Flow.SpecMetadata | 5 | Resolved flow spec (versioned). |
| graph | GraphMetadata dtkt.core.v1.Flow.GraphMetadata | 6 | Parsed flow graph (versioned). |
| create_time | Timestamp google.protobuf.Timestamp | 20 | Flow create time. |
| update_time | Timestamp google.protobuf.Timestamp | 21 | Flow update time. |
dtkt.core.v1messages.protoConnection
MessageConnection 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)
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Connection resource name is one of:
|
| uid | string | 2 | Server-assigned unique ID (UUID). |
| typeOneOf | No description. | ||
| deployment | string | 3 | Name of a deployment resource. |
| custom_protos | string | 4 | Custom proto descriptors URI. |
| custom_grpc | bool | 5 | Custom using gRPC reflection. |
| address | Address dtkt.shared.v1beta1.Address | 6 | Address of gRPC server. |
| config_data | Any google.protobuf.Any | 10 | Config data compatible with integration config schema. |
| config_hash | string | 11 | Hash of config data. |
| config_gen | uint64 | 12 | Generation of config data. |
| config_uri | string | 13 | Config source uri (optional). |
| headers | map<string, string> | 14 | Headers applied when dialing connection. |
| create_time | Timestamp google.protobuf.Timestamp | 20 | Connection create time. |
| update_time | Timestamp google.protobuf.Timestamp | 21 | Connection update time. |
dtkt.core.v1messages.protoDeployment
MessageDeployment is a runnable instance of an Integration with a tagged build artifact and runtime configuration.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Deployment resource name is one of:
|
| uid | string | 2 | Server-assigned unique ID (UUID). |
| address | Address dtkt.shared.v1beta1.Address | 3 | Bind address of deployment. |
| build_uri | string | 4 | URI of build artifact. |
| build_etag | string | 5 | Checksum of build artifact for concurrency control. |
| env | map<string, string> | 6 | Env vars applied at runtime. |
| ports | map<string, string> | 7 | Port mappings applied at runtime. |
| create_time | Timestamp google.protobuf.Timestamp | 20 | Deployment create time. |
| update_time | Timestamp google.protobuf.Timestamp | 21 | Deployment update time. |
dtkt.core.v1messages.protoIntegration
MessageIntegration describes a software package which uses the DataKit SDK making it natively compatible with DataKit's build and run tooling & infrastructure.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Integration resource name, one of:
|
| uid | string | 2 | Server-assigned unique ID (UUID). |
| spec_uri | string | 3 | Package spec URI. |
| spec_etag | string | 4 | Package spec checksum for concurrency control. |
| spec | SpecMetadata dtkt.core.v1.Integration.SpecMetadata | 5 | Versioned package spec. |
| cloud | CloudMetadata dtkt.core.v1.CloudMetadata | 6 | Cloud metadata (only present when running on cloud network). |
| build | BuildMetadata dtkt.core.v1.BuildMetadata | 7 | Build metadata (only present when developing locally). |
| create_time | Timestamp google.protobuf.Timestamp | 20 | Integration create time. |
| update_time | Timestamp google.protobuf.Timestamp | 21 | Integration update time. |
dtkt.core.v1messages.protoService
MessageService message for documentation and reflection indexing.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
| description | string | 2 | No description. |
| methods | Method[] dtkt.core.v1.Method[] | 3 | No description. |
| parent | string | 20 | Parent resource name, one of:
|
dtkt.core.v1messages.protoMethod
MessageMethod message for documentation and reflection indexing.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
| description | string | 2 | No description. |
| request | string | 3 | No description. |
| response | string | 4 | No description. |
| request_streaming | bool | 5 | No description. |
| response_streaming | bool | 6 | No description. |
| parent | string | 20 | Parent resource name, one of:
|
dtkt.core.v1messages.protoType
MessageType message for documentation and reflection indexing.
| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Type name |
| schema | TypeSchema dtkt.shared.v1beta1.TypeSchema | 2 | Type schema |
| system_type | bool | 3 | True if this is a system type (has no parent) |
| parent | string | 4 | Parent resource name, one of:
|
dtkt.core.v1messages.protoResource
MessageResource combines any data-plane message with context enabling auditing, tracing, and observability across network boundaries.
| Field | Type | Number | Description |
|---|---|---|---|
| message | Any google.protobuf.Any | 1 | No description. |
| context | Context dtkt.core.v1.Context | 2 | No description. |
dtkt.core.v1messages.protoContext
MessageContext provides the name and address of a control plane and an optional connection resource name used for data plane resource tracing.
dtkt.core.v1messages.protoCloudMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| bind_config | bytes | 1 | Cloud network bind configuration. |
dtkt.core.v1messages.protoBuildMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| runtime | Runtime dtkt.shared.v1beta1.Runtime | 1 | Target runtime of build artifact. |
| platform | Platform dtkt.shared.v1beta1.Platform | 2 | Target platform of build artifact. |
| env | map<string, string> | 3 | Env vars. |
| source_uri | string | 4 | URI of build source. |
| target_uri | string | 5 | URI of build target artifact. |
| target_etag | string | 10 | Checksum of build target artifact (present if build is successful). |
dtkt.core.v1messages.protoDialMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| state | State dtkt.core.v1.DialMetadata.State | 1 | Connection dial state. |
| message | string | 2 | Connection dial message. |
| time | Timestamp google.protobuf.Timestamp | 3 | Connection dial time. |
dtkt.core.v1messages.protoBuildOperationMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| state | State dtkt.core.v1.BuildOperationMetadata.State | 1 | Build state. |
| message | string | 2 | Build status message. |
| start_time | Timestamp google.protobuf.Timestamp | 20 | Build start time. |
| finish_time | Timestamp google.protobuf.Timestamp | 21 | Build finish time. |
dtkt.core.v1messages.protoRunOperationMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| state | State dtkt.core.v1.RunOperationMetadata.State | 1 | Run state. |
| message | string | 2 | Run status message. |
| start_time | Timestamp google.protobuf.Timestamp | 20 | Run start time. |
| stop_time | Timestamp google.protobuf.Timestamp | 21 | Run stop time. |
dtkt.core.v1messages.protoBatchRunOperationMetadata
Message| Field | Type | Number | Description |
|---|---|---|---|
| failed_requests | map<int32, Status> map<int32, google.rpc.Status> | 1 | No description. |
dtkt.core.v1messages.protoGetAutomationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of Automation resource to get. |
dtkt.core.v1messages.protoGetAutomationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| automation | Automation dtkt.core.v1.Automation | 1 | No description. |
dtkt.core.v1messages.protoCreateAutomationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Parent resource name. Format is one of:
|
| automation_id | string | 2 | No description. |
| automation | Automation dtkt.core.v1.Automation | 3 | No description. |
dtkt.core.v1messages.protoCreateAutomationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| automation | Automation dtkt.core.v1.Automation | 1 | No description. |
dtkt.core.v1messages.protoBatchCreateAutomationsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Parent resource name shared by all automations this batch. Format is one of:
|
| requests | CreateAutomationRequest[] dtkt.core.v1.CreateAutomationRequest[] | 2 | No description. |
dtkt.core.v1messages.protoBatchCreateAutomationsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| automations | Automation[] dtkt.core.v1.Automation[] | 1 | No description. |
dtkt.core.v1messages.protoListAutomationsRequest
Messagedtkt.core.v1messages.protoListAutomationsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| automations | Automation[] dtkt.core.v1.Automation[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoSendAutomationEvent
Message| Field | Type | Number | Description |
|---|---|---|---|
| typeOneOf | No description. | ||
| inputs_event | InputsEvent dtkt.core.v1.SendAutomationEvent.InputsEvent | 1 | No description. |
| user_response_event | UserResponseEvent dtkt.core.v1.SendAutomationEvent.UserResponseEvent | 2 | No description. |
dtkt.core.v1messages.protoReceiveAutomationEvent
Message| Field | Type | Number | Description |
|---|---|---|---|
| typeOneOf | No description. | ||
| outputs_event | OutputsEvent dtkt.core.v1.ReceiveAutomationEvent.OutputsEvent | 1 | No description. |
| user_request_event | UserRequestEvent dtkt.core.v1.ReceiveAutomationEvent.UserRequestEvent | 2 | No description. |
dtkt.core.v1messages.protoSendAutomationEventRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of Automation resource to send event. |
| event | SendAutomationEvent dtkt.core.v1.SendAutomationEvent | 2 | Event to send. |
dtkt.core.v1messages.protoReceiveAutomationEventsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of Automation resource to receive events. |
dtkt.core.v1messages.protoReceiveAutomationEventsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| event | ReceiveAutomationEvent dtkt.core.v1.ReceiveAutomationEvent | 2 | No description. |
dtkt.core.v1messages.protoStreamAutomationEventsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of Automation resource to send event. |
| event | SendAutomationEvent dtkt.core.v1.SendAutomationEvent | 2 | No description. |
dtkt.core.v1messages.protoStreamAutomationEventsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| event | ReceiveAutomationEvent dtkt.core.v1.ReceiveAutomationEvent | 1 | No description. |
dtkt.core.v1messages.protoListConnectionsRequest
Messagedtkt.core.v1messages.protoListConnectionsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| connections | Connection[] dtkt.core.v1.Connection[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoGetConnectionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
dtkt.core.v1messages.protoGetConnectionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | Connection dtkt.core.v1.Connection | 1 | No description. |
dtkt.core.v1messages.protoCreateConnectionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | No description. |
| connection_id | string | 2 | No description. |
| connection | Connection dtkt.core.v1.Connection | 3 | No description. |
dtkt.core.v1messages.protoCreateConnectionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | Connection dtkt.core.v1.Connection | 1 | No description. |
dtkt.core.v1messages.protoUpdateConnectionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | Connection dtkt.core.v1.Connection | 1 | The connection with updated fields. Must include |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update (e.g., "config_data,integration"). |
dtkt.core.v1messages.protoUpdateConnectionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| connection | Connection dtkt.core.v1.Connection | 1 | No description. |
dtkt.core.v1messages.protoDeleteConnectionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of connection to delete. |
dtkt.core.v1messages.protoDeleteConnectionResponse
Messagedtkt.core.v1messages.protoDialConnectionRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| targetOneOf | No description. | ||
| name | string | 1 | Name of connection to dial. |
| addr | Address dtkt.shared.v1beta1.Address | 2 | Address of connection to dial. |
dtkt.core.v1messages.protoDialConnectionResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| dial | DialMetadata dtkt.core.v1.DialMetadata | 1 | No description. |
dtkt.core.v1messages.protoStoreDescriptorsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Name of parent resource. |
| descriptors | FileDescriptorSet google.protobuf.FileDescriptorSet | 2 | Proto descriptor file set to store. |
dtkt.core.v1messages.protoStoreDescriptorsResponse
Messagedtkt.core.v1messages.protoLoadDescriptorsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| parent | string | 1 | Name of parent resource. |
dtkt.core.v1messages.protoLoadDescriptorsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| descriptors | FileDescriptorSet google.protobuf.FileDescriptorSet | 1 | Proto descriptor file set. |
dtkt.core.v1messages.protoListDeploymentsRequest
Messagedtkt.core.v1messages.protoListDeploymentsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployments | Deployment[] dtkt.core.v1.Deployment[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoGetDeploymentRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
dtkt.core.v1messages.protoGetDeploymentResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment | Deployment dtkt.core.v1.Deployment | 1 | No description. |
dtkt.core.v1messages.protoCreateDeploymentRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment_id | string | 1 | No description. |
| deployment | Deployment dtkt.core.v1.Deployment | 2 | Deployment to create (name ignored; server sets it). |
| parent | string | 3 | Parent: |
dtkt.core.v1messages.protoCreateDeploymentResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment | Deployment dtkt.core.v1.Deployment | 1 | No description. |
dtkt.core.v1messages.protoUpdateDeploymentRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment | Deployment dtkt.core.v1.Deployment | 1 | Deployment with updated fields. Must include |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update (e.g., "config,address"). |
dtkt.core.v1messages.protoUpdateDeploymentResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment | Deployment dtkt.core.v1.Deployment | 1 | No description. |
dtkt.core.v1messages.protoDeleteDeploymentRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
dtkt.core.v1messages.protoDeleteDeploymentResponse
Messagedtkt.core.v1messages.protoRunDeploymentRequest
Messagedtkt.core.v1messages.protoRunDeploymentResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| deployment | Deployment dtkt.core.v1.Deployment | 1 | No description. |
dtkt.core.v1messages.protoListFlowsRequest
Messagedtkt.core.v1messages.protoListFlowsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| flows | Flow[] dtkt.core.v1.Flow[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoGetFlowRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Flow resource name, one of:
|
dtkt.core.v1messages.protoGetFlowResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| flow | Flow dtkt.core.v1.Flow | 1 | No description. |
dtkt.core.v1messages.protoCreateFlowRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| flow_id | string | 1 | Flow resource identifier. |
| flow | Flow dtkt.core.v1.Flow | 2 | Flow to create. |
| parent | string | 3 | Parent resource name, one of:
|
dtkt.core.v1messages.protoCreateFlowResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| flow | Flow dtkt.core.v1.Flow | 1 | No description. |
dtkt.core.v1messages.protoUpdateFlowRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| flow | Flow dtkt.core.v1.Flow | 1 | No description. |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update (e.g., "spec"). |
dtkt.core.v1messages.protoUpdateFlowResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| flow | Flow dtkt.core.v1.Flow | 1 | No description. |
dtkt.core.v1messages.protoDeleteFlowRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of flow to delete. |
dtkt.core.v1messages.protoDeleteFlowResponse
Messagedtkt.core.v1messages.protoListIntegrationsRequest
Messagedtkt.core.v1messages.protoListIntegrationsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| integrations | Integration[] dtkt.core.v1.Integration[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoGetIntegrationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of integration: |
dtkt.core.v1messages.protoGetIntegrationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration | Integration dtkt.core.v1.Integration | 1 | No description. |
dtkt.core.v1messages.protoCreateIntegrationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration_id | string | 1 | Client-provided ID for integration resource. |
| integration | Integration dtkt.core.v1.Integration | 2 | Integration to create. |
| parent | string | 3 | Parent: |
dtkt.core.v1messages.protoCreateIntegrationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration | Integration dtkt.core.v1.Integration | 1 | No description. |
dtkt.core.v1messages.protoBuildIntegrationRequest
Messagedtkt.core.v1messages.protoBuildIntegrationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration | Integration dtkt.core.v1.Integration | 1 | No description. |
dtkt.core.v1messages.protoUpdateIntegrationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration | Integration dtkt.core.v1.Integration | 1 | Integration with updated fields. Must include |
| update_mask | FieldMask google.protobuf.FieldMask | 2 | Fields to update (e.g., "config,spec"). |
dtkt.core.v1messages.protoUpdateIntegrationResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| integration | Integration dtkt.core.v1.Integration | 1 | No description. |
dtkt.core.v1messages.protoDeleteIntegrationRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Integration name to delete. |
dtkt.core.v1messages.protoDeleteIntegrationResponse
Messagedtkt.core.v1messages.protoGetTypeRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Type name, e.g.: "dtkt.shared.v1beta1.Package" |
| parent | string | 3 | Parent resource name, one of:
|
dtkt.core.v1messages.protoGetTypeResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | Type dtkt.core.v1.Type | 1 | No description. |
dtkt.core.v1messages.protoListTypesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| page_size | int32 | 1 | No description. |
| page_token | string | 2 | No description. |
| parent | string | 3 | Parent resource name, one of:
|
| filter | string | 4 | No description. |
dtkt.core.v1messages.protoListTypesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| types | Type[] dtkt.core.v1.Type[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoGetMethodRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the method to get. |
| parent | string | 20 | Parent resource name, one of:
|
dtkt.core.v1messages.protoGetMethodResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| method | Method dtkt.core.v1.Method | 1 | No description. |
dtkt.core.v1messages.protoGetServiceRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | Name of the service to get. |
| parent | string | 20 | Parent resource name, one of:
|
dtkt.core.v1messages.protoGetServiceResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| service | Service dtkt.core.v1.Service | 1 | No description. |
dtkt.core.v1messages.protoListServicesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| page_size | int32 | 1 | No description. |
| page_token | string | 2 | No description. |
| parent | string | 20 | Parent resource name, one of (blank will return all):
|
| filter | string | 21 | No description. |
dtkt.core.v1messages.protoListServicesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| services | Service[] dtkt.core.v1.Service[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.core.v1messages.protoListMethodsRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| page_size | int32 | 1 | No description. |
| page_token | string | 2 | No description. |
| service | string | 10 | Service name to filter methods. |
| parent | string | 20 | Parent resource name, one of (blank will return all):
|
| filter | string | 21 | No description. |
dtkt.core.v1messages.protoListMethodsResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| methods | Method[] dtkt.core.v1.Method[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.email.v1beta1messages.protoEmailAddress
Messagedtkt.email.v1beta1messages.protoEmailSendStatus
Messagedtkt.email.v1beta1messages.protoRepresents an email message.
| Field | Type | Number | Description |
|---|---|---|---|
| from | EmailAddress dtkt.email.v1beta1.EmailAddress | 1 | No description. |
| reply_to | EmailAddress dtkt.email.v1beta1.EmailAddress | 2 | No description. |
| to | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 3 | No description. |
| cc | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 4 | No description. |
| bcc | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 5 | No description. |
| return_path | EmailAddress dtkt.email.v1beta1.EmailAddress | 6 | No description. |
| subject | string | 7 | No description. |
| text_body | string | 8 | No description. |
| html_body | string | 9 | No description. |
dtkt.email.v1beta1messages.protoEmailTemplate
MessageRepresents an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| language | TemplateLanguage dtkt.email.v1beta1.TemplateLanguage | 2 | No description. |
| subject | string | 3 | No description. |
| text_body | string | 4 | No description. |
| html_body | string | 5 | No description. |
dtkt.email.v1beta1messages.protoEmailWithTemplate
MessageRepresents an email message.
| Field | Type | Number | Description |
|---|---|---|---|
| from | EmailAddress dtkt.email.v1beta1.EmailAddress | 1 | No description. |
| reply_to | EmailAddress dtkt.email.v1beta1.EmailAddress | 2 | No description. |
| to | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 3 | No description. |
| cc | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 4 | No description. |
| bcc | EmailAddress[] dtkt.email.v1beta1.EmailAddress[] | 5 | No description. |
| return_path | EmailAddress dtkt.email.v1beta1.EmailAddress | 6 | No description. |
| template_id | string | 7 | No description. |
| template_params | map<string, string> | 8 | No description. |
dtkt.email.v1beta1messages.protoSendEmailRequest
MessageRepresents an email sending request.
| Field | Type | Number | Description |
|---|---|---|---|
Email dtkt.email.v1beta1.Email | 1 | The email to be sent. |
dtkt.email.v1beta1messages.protoSendEmailResponse
MessageRepresents an email sending response.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus dtkt.email.v1beta1.EmailSendStatus | 1 | The email sending status. |
dtkt.email.v1beta1messages.protoSendEmailsRequest
MessageRepresents a stream of email sending requests.
| Field | Type | Number | Description |
|---|---|---|---|
Email dtkt.email.v1beta1.Email | 1 | The email to be sent. |
dtkt.email.v1beta1messages.protoSendEmailsResponse
MessageRepresents a stream of email sending responses.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus dtkt.email.v1beta1.EmailSendStatus | 1 | The email sending status. |
dtkt.email.v1beta1messages.protoSendBatchEmailRequest
MessageRepresents a batch email sending request.
| Field | Type | Number | Description |
|---|---|---|---|
| emails | Email[] dtkt.email.v1beta1.Email[] | 1 | The list of emails to be sent. |
dtkt.email.v1beta1messages.protoSendBatchEmailResponse
MessageRepresents a batch email sending response.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus[] dtkt.email.v1beta1.EmailSendStatus[] | 1 | The list of email sending statuses. |
dtkt.email.v1beta1messages.protoSendEmailWithTemplateRequest
MessageRepresents an email sending request sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
EmailWithTemplate dtkt.email.v1beta1.EmailWithTemplate | 1 | The email to be sent. |
dtkt.email.v1beta1messages.protoSendEmailWithTemplateResponse
MessageRepresents an email sending response sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus dtkt.email.v1beta1.EmailSendStatus | 1 | The email sending status. |
dtkt.email.v1beta1messages.protoSendEmailsWithTemplateRequest
MessageRepresents a stream of email sending requests sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
EmailWithTemplate dtkt.email.v1beta1.EmailWithTemplate | 1 | The email to be sent. |
dtkt.email.v1beta1messages.protoSendEmailsWithTemplateResponse
MessageRepresents a stream of email sending responses sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus dtkt.email.v1beta1.EmailSendStatus | 1 | The email sending status. |
dtkt.email.v1beta1messages.protoSendBatchEmailWithTemplateRequest
MessageRepresents a batch email sending request sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
| emails | EmailWithTemplate[] dtkt.email.v1beta1.EmailWithTemplate[] | 1 | The list of emails to be sent. |
dtkt.email.v1beta1messages.protoSendBatchEmailWithTemplateResponse
MessageRepresents a batch email sending response sent with a template.
| Field | Type | Number | Description |
|---|---|---|---|
| send_status | EmailSendStatus[] dtkt.email.v1beta1.EmailSendStatus[] | 1 | The list of email sending statuses. |
dtkt.email.v1beta1messages.protoGetEmailTemplateRequest
MessageRepresents a request to get an email template by ID.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
dtkt.email.v1beta1messages.protoGetEmailTemplateResponse
MessageRepresents a response to get an email template by ID.
| Field | Type | Number | Description |
|---|---|---|---|
| template | EmailTemplate dtkt.email.v1beta1.EmailTemplate | 1 | No description. |
dtkt.email.v1beta1messages.protoListEmailTemplatesRequest
MessageRepresents a request to list email templates.
| Field | Type | Number | Description |
|---|---|---|---|
| page_size | int32 | 1 | 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_token | string | 2 | A page token, received from a previous When paginating, all other parameters provided to |
dtkt.email.v1beta1messages.protoListEmailTemplatesResponse
MessageRepresents a response to list email templates.
| Field | Type | Number | Description |
|---|---|---|---|
| templates | EmailTemplate[] dtkt.email.v1beta1.EmailTemplate[] | 1 | No description. |
| next_page_token | string | 2 | No description. |
dtkt.email.v1beta1messages.protoCreateEmailTemplateRequest
MessageRepresents a request to create an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| template | EmailTemplate dtkt.email.v1beta1.EmailTemplate | 1 | No description. |
dtkt.email.v1beta1messages.protoCreateEmailTemplateResponse
MessageRepresents a response to create an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| template | EmailTemplate dtkt.email.v1beta1.EmailTemplate | 1 | No description. |
dtkt.email.v1beta1messages.protoUpdateEmailTemplateRequest
MessageRepresents a request to update an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| template | EmailTemplate dtkt.email.v1beta1.EmailTemplate | 2 | No description. |
dtkt.email.v1beta1messages.protoUpdateEmailTemplateResponse
MessageRepresents a response to update an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| template | EmailTemplate dtkt.email.v1beta1.EmailTemplate | 1 | No description. |
dtkt.email.v1beta1messages.protoDeleteEmailTemplateRequest
MessageRepresents a request to delete an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
dtkt.email.v1beta1messages.protoDeleteEmailTemplateResponse
MessageRepresents a response to delete an email template.
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
dtkt.email.v1beta1messages.protoReceivedEmail
MessageRepresents a received Email
| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| at | string | 2 | No description. |
Email dtkt.email.v1beta1.Email | 3 | No description. |
dtkt.event.v1beta1messages.protoEvent
MessageRepresents an event type deliverable by an EventSource.
| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | Type of the event. |
| description | string | 2 | Description of the event. |
| action_type | ActionType dtkt.shared.v1beta1.ActionType | 3 | Type of action associated with event. |
| payload_schema | TypeSchema dtkt.shared.v1beta1.TypeSchema | 4 | Schema describing the payload of the event. |
| payload | Any google.protobuf.Any | 5 | Payload when event is delivered. |
dtkt.event.v1beta1messages.protoEventSource
MessageRepresents an event source supported by the service.
| Field | Type | Number | Description |
|---|---|---|---|
| strategy | EventSourceStrategy dtkt.event.v1beta1.EventSourceStrategy | 1 | The strategy used by the event source. |
| name | string | 2 | Name of the event source. |
| description | string | 3 | Description of the event source. |
| config_schema | TypeSchema dtkt.shared.v1beta1.TypeSchema | 4 | Schema for configuring the event source. |
| requires_creation | bool | 5 | Specifies if creation is required before using the event source. |
| config | Any google.protobuf.Any | 6 | Configuration of the event source, if any (only available when requires_creation is true and it has been created). |
| pull_freq | Duration google.protobuf.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_url | string | 8 | 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.protoListEventsRequest
MessageRequest for retrieving events.
dtkt.event.v1beta1messages.protoListEventsResponse
MessageResponse containing a list of events.
| Field | Type | Number | Description |
|---|---|---|---|
| events | Event[] dtkt.event.v1beta1.Event[] | 1 | List of available events. |
dtkt.event.v1beta1messages.protoListEventSourcesRequest
MessageRequest for retrieving event source types supported by this service.
| Field | Type | Number | Description |
|---|---|---|---|
| strategy | EventSourceStrategy dtkt.event.v1beta1.EventSourceStrategy | 1 | The strategy used by the event source. |
| configured | bool | 2 | Indicates whether to list only configured event sources. |
dtkt.event.v1beta1messages.protoListEventSourcesResponse
MessageList of event sources supported by or configured for this service.
| Field | Type | Number | Description |
|---|---|---|---|
| event_sources | EventSource[] dtkt.event.v1beta1.EventSource[] | 1 | List of event sources. |
dtkt.event.v1beta1messages.protoStreamPullEventsRequest
MessageRequest to pull events from a PULL event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Pull event source. |
| config | Any google.protobuf.Any | 2 | Configuration of the event source. |
| pull_freq | Duration google.protobuf.Duration | 3 | Pull frequency of the event source. |
dtkt.event.v1beta1messages.protoStreamPullEventsResponse
MessageResponse for pulling events.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Pull event source from request. |
| event | Event dtkt.event.v1beta1.Event | 2 | Event delivered by source. |
dtkt.event.v1beta1messages.protoStreamPushEventsRequest
MessageRequest to validate an event from a PUSH event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Push event source. |
| headers | map<string, StringList> map<string, dtkt.shared.v1beta1.StringList> | 2 | Headers of the event. |
| body | bytes | 3 | Body of the event. |
dtkt.event.v1beta1messages.protoStreamPushEventsResponse
MessageResponse of a valid event from a PUSH event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Push event source. |
| event | Event dtkt.event.v1beta1.Event | 2 | Event delivered. |
dtkt.event.v1beta1messages.protoCreateEventSourceRequest
MessageRequest to create a new event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Event source to create. |
| config | Any google.protobuf.Any | 2 | Configuration of the event source. |
| pull_freq | Duration google.protobuf.Duration | 3 | Pull frequency of the event source, if any (only supported when strategy is PULL). |
| push_url | string | 4 | Push URL of the event source, if any (only supported when strategy is PUSH). |
dtkt.event.v1beta1messages.protoCreateEventSourceResponse
MessageResponse for creating an event source.
| Field | Type | Number | Description |
|---|---|---|---|
| created | bool | 1 | Indicates if the creation was successful. |
| error | string | 2 | Error message, if any. |
| event_source | EventSource dtkt.event.v1beta1.EventSource | 3 | The created event source. |
dtkt.event.v1beta1messages.protoUpdateEventSourceRequest
MessageRequest to update an event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | Event source to update. |
| config | Any google.protobuf.Any | 2 | Configuration of the event source. |
| pull_freq | Duration google.protobuf.Duration | 3 | Pull frequency of the event source, if any (only supported when strategy is PULL). |
| push_url | string | 4 | Push URL of the event source, if any (only supported when strategy is PUSH). |
dtkt.event.v1beta1messages.protoUpdateEventSourceResponse
MessageResponse for updating an event source.
| Field | Type | Number | Description |
|---|---|---|---|
| updated | bool | 1 | Indicates if the update was successful. |
| error | string | 2 | Error message, if any. |
| event_source | EventSource dtkt.event.v1beta1.EventSource | 3 | The updated event source. |
dtkt.event.v1beta1messages.protoDeleteEventSourceRequest
MessageRequest to delete an event source.
| Field | Type | Number | Description |
|---|---|---|---|
| event_source | EventSource dtkt.event.v1beta1.EventSource | 1 | The event source to delete. |
dtkt.event.v1beta1messages.protoDeleteEventSourceResponse
MessageResponse for deleting an event source.
| Field | Type | Number | Description |
|---|---|---|---|
| deleted | bool | 1 | Indicates if the deletion was successful. |
| error | string | 2 | Error message, if any. |
| event_source | EventSource dtkt.event.v1beta1.EventSource | 3 | The deleted event source. |
dtkt.geo.v1beta1messages.protoGeoSource
Message| Field | Type | Number | Description |
|---|---|---|---|
| id | string | 1 | No description. |
| geo_fields | string[] | 2 | No description. |
| prop_fields | PropertyField[] dtkt.geo.v1beta1.PropertyField[] | 3 | No description. |
| update_freq | Duration google.protobuf.Duration | 4 | No description. |
| sourceOneOf | No description. | ||
| table | Table dtkt.catalog.v1beta1.Table | 5 | No description. |
| query | Query dtkt.catalog.v1beta1.Query | 6 | No description. |
dtkt.geo.v1beta1messages.protoPropertyField
Message| Field | Type | Number | Description |
|---|---|---|---|
| name | string | 1 | No description. |
| type | PropertyType dtkt.geo.v1beta1.PropertyType | 2 | No description. |
dtkt.geo.v1beta1messages.protoBounds
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | BoundsType dtkt.geo.v1beta1.BoundsType | 1 | No description. |
| geom | Geometry dtkt.geojson.v1beta1.Geometry | 2 | No description. |
| centroid | bool | 3 | No description. |
dtkt.geo.v1beta1messages.protoListGeoSourcesRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| scopeOneOf | No description. | ||
| catalog | Catalog dtkt.catalog.v1beta1.Catalog | 1 | No description. |
| schema | Schema dtkt.catalog.v1beta1.Schema | 2 | No description. |
dtkt.geo.v1beta1messages.protoListGeoSourcesResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| geo_source | GeoSource dtkt.geo.v1beta1.GeoSource | 1 | No description. |
dtkt.geo.v1beta1messages.protoStreamGeoJsonRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| source | GeoSource dtkt.geo.v1beta1.GeoSource | 1 | No description. |
| bounds | Bounds dtkt.geo.v1beta1.Bounds | 2 | No description. |
| geo_field | string | 3 | No description. |
| prop_fields | string[] | 4 | No description. |
dtkt.geo.v1beta1messages.protoStreamGeoJsonResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| result | GeoJSON dtkt.geojson.v1beta1.GeoJSON | 1 | No description. |
dtkt.geojson.v1beta1messages.protoGeoJSON
MessageGeoJSON Root object union
| Field | Type | Number | Description |
|---|---|---|---|
| geojsonOneOf | No description. | ||
| geometry | Geometry dtkt.geojson.v1beta1.Geometry | 1 | No description. |
| feature | Feature dtkt.geojson.v1beta1.Feature | 2 | No description. |
| feature_collection | FeatureCollection dtkt.geojson.v1beta1.FeatureCollection | 3 | No description. |
dtkt.geojson.v1beta1messages.protoGeometry
MessageUnion type for Geometry using oneof
| Field | Type | Number | Description |
|---|---|---|---|
| geometryOneOf | No description. | ||
| point | Point dtkt.geojson.v1beta1.Point | 1 | No description. |
| multi_point | MultiPoint dtkt.geojson.v1beta1.MultiPoint | 2 | No description. |
| line_string | LineString dtkt.geojson.v1beta1.LineString | 3 | No description. |
| multi_line_string | MultiLineString dtkt.geojson.v1beta1.MultiLineString | 4 | No description. |
| polygon | Polygon dtkt.geojson.v1beta1.Polygon | 5 | No description. |
| multi_polygon | MultiPolygon dtkt.geojson.v1beta1.MultiPolygon | 6 | No description. |
| geometry_collection | GeometryCollection dtkt.geojson.v1beta1.GeometryCollection | 7 | No description. |
dtkt.geojson.v1beta1messages.protoFeature
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| geometry | Geometry dtkt.geojson.v1beta1.Geometry | 2 | No description. |
| properties | Struct google.protobuf.Struct | 3 | No description. |
| idOneOf | No description. | ||
| id_str | string | 4 | No description. |
| id_num | int64 | 5 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 6 | No description. |
dtkt.geojson.v1beta1messages.protoFeatureCollection
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| features | Feature[] dtkt.geojson.v1beta1.Feature[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoBBox
MessageRepresents a GeoJSON Bounding Box
| Field | Type | Number | Description |
|---|---|---|---|
| coordinates | double[] | 1 | No description. |
dtkt.geojson.v1beta1messages.protoPosition
MessageRepresents a GeoJSON Position (array of numbers: length 2 or 3)
| Field | Type | Number | Description |
|---|---|---|---|
| values | double[] | 1 | No description. |
dtkt.geojson.v1beta1messages.protoPoint
MessageGeoJSON Geometry types
| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | Position dtkt.geojson.v1beta1.Position | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoMultiPoint
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | Position[] dtkt.geojson.v1beta1.Position[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoLineString
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | Position[] dtkt.geojson.v1beta1.Position[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoMultiLineString
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | LineStringCoords[] dtkt.geojson.v1beta1.LineStringCoords[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoPolygon
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | LinearRing[] dtkt.geojson.v1beta1.LinearRing[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoMultiPolygon
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| coordinates | PolygonCoords[] dtkt.geojson.v1beta1.PolygonCoords[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoGeometryCollection
Message| Field | Type | Number | Description |
|---|---|---|---|
| type | string | 1 | No description. |
| geometries | Geometry[] dtkt.geojson.v1beta1.Geometry[] | 2 | No description. |
| bbox | BBox dtkt.geojson.v1beta1.BBox | 3 | No description. |
dtkt.geojson.v1beta1messages.protoLineStringCoords
MessageHelper types for nested coordinates
| Field | Type | Number | Description |
|---|---|---|---|
| positions | Position[] dtkt.geojson.v1beta1.Position[] | 1 | No description. |
dtkt.geojson.v1beta1messages.protoLinearRing
Message| Field | Type | Number | Description |
|---|---|---|---|
| positions | Position[] dtkt.geojson.v1beta1.Position[] | 1 | No description. |
dtkt.geojson.v1beta1messages.protoPolygonCoords
Message| Field | Type | Number | Description |
|---|---|---|---|
| linear_rings | LinearRing[] dtkt.geojson.v1beta1.LinearRing[] | 1 | No description. |
dtkt.protocoap.v1beta1protocoap.protoResource
Messagedtkt.protocoap.v1beta1protocoap.protoServiceOption
Message| Field | Type | Number | Description |
|---|---|---|---|
| oscore | bool | 1 | No description. |
| resources | Resource[] dtkt.protocoap.v1beta1.Resource[] | 2 | No description. |
dtkt.protocoap.v1beta1protocoap.protoMethodOption
Message| Field | Type | Number | Description |
|---|---|---|---|
| confirm | bool | 1 | No description. |
| resource | string | 2 | No description. |
| method | RequestMethod dtkt.protocoap.v1beta1.RequestMethod | 3 | No description. |
dtkt.protostore.v1beta1protostore.protoField
Messagedtkt.protostore.v1beta1protostore.protoEdge
Messagedtkt.replication.v1beta1messages.protoSource
MessageRepresents a configured replication Source.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | Replication service of Source. |
| destination_id | string | 2 | Unique identifier of Destination. |
| config_id | string | 3 | Unique identifier of source config from replication service. |
| id | string | 4 | Unique identifier returned by Source. |
| name | string | 5 | Name returned by Source. |
| config | Struct google.protobuf.Struct | 6 | Config for Source. |
| sync_status | SyncStatus dtkt.replication.v1beta1.SyncStatus | 7 | Sync status of the Source. |
| sync_error | string | 8 | Sync error message when sync status is failed. |
dtkt.replication.v1beta1messages.protoSourceConfig
MessageRepresents a supported replication source config.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | Replication service of source config. |
| id | string | 2 | Unique identifier for source config. |
| name | string | 3 | Name of source config. |
| description | string | 4 | Description of source config. |
| icon_url | string | 5 | Icon URL of source config. |
| category | string | 6 | Category of source config. |
| config_schema | string | 7 | Schema for source config. |
dtkt.replication.v1beta1messages.protoCheckSourceAuthRequest
MessageRequest for checking source auth.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | Replication service the Source. |
| config_id | string | 2 | Unique identifier of source config from replication service. |
| type | AuthCheck dtkt.shared.v1beta1.AuthCheck | 3 | The auth check type. |
| oauthOneOf | If auth type response is OAuth. | ||
| code_request | OAuthCodeRequest dtkt.shared.v1beta1.OAuthCodeRequest | 4 | When check type is auth code url. |
| token_request | OAuthTokenRequest dtkt.shared.v1beta1.OAuthTokenRequest | 5 | When check type is callback. |
| refresh_request | OAuthRefreshRequest dtkt.shared.v1beta1.OAuthRefreshRequest | 6 | When check type is refresh. |
dtkt.replication.v1beta1messages.protoCheckSourceAuthResponse
MessageResponse for checking source auth.
| Field | Type | Number | Description |
|---|---|---|---|
| type | AuthType dtkt.shared.v1beta1.AuthType | 1 | The auth type of this source. |
| success | bool | 2 | Indicates if the auth check was successful. |
| error | string | 3 | Error message if success is false. |
| oauthOneOf | Present when type is OAuth. | ||
| auth_code_url | string | 4 | Returned when check is code. |
| token | OAuthToken dtkt.shared.v1beta1.OAuthToken | 5 | Returned when check type is token or refresh. |
| config_data | Struct google.protobuf.Struct | 6 | Data for source config. |
dtkt.replication.v1beta1messages.protoListSourceConfigsRequest
MessageRequest to retrieve a list of supported replication Sources.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
dtkt.replication.v1beta1messages.protoListSourceConfigsResponse
MessageResponse to retrieve a list of supported replication Sources.
| Field | Type | Number | Description |
|---|---|---|---|
| source_configs | SourceConfig[] dtkt.replication.v1beta1.SourceConfig[] | 1 | No description. |
dtkt.replication.v1beta1messages.protoGetSourceRequest
MessageRequest for replication Source of given provider.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of source config from replication service. |
| id | string | 3 | Unique identifier of Source. |
dtkt.replication.v1beta1messages.protoGetSourceResponse
MessageResponse for replication Source of given provider.
| Field | Type | Number | Description |
|---|---|---|---|
| source | Source dtkt.replication.v1beta1.Source | 1 | No description. |
dtkt.replication.v1beta1messages.protoCreateSourceRequest
MessageRequest to create configured Source.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of source config from replication service. |
| name | string | 3 | Name assigned to Source being created. |
| config | Struct google.protobuf.Struct | 4 | Config assigned to Source being created. |
dtkt.replication.v1beta1messages.protoCreateSourceResponse
MessageResponse from create configured Source.
| Field | Type | Number | Description |
|---|---|---|---|
| created | bool | 1 | Indicates whether Source was successfully created. |
| error | string | 2 | An error message if created is false. |
| source | Source dtkt.replication.v1beta1.Source | 3 | The returned Source if created is true. |
dtkt.replication.v1beta1messages.protoUpdateSourceRequest
MessageRequest to update configured Source.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of source config from replication service. |
| id | string | 3 | Unique identifier of Source. |
| config | Struct google.protobuf.Struct | 4 | Source config overrides. |
dtkt.replication.v1beta1messages.protoUpdateSourceResponse
MessageResponse from update configured Source.
| Field | Type | Number | Description |
|---|---|---|---|
| updated | bool | 1 | Indicates whether Source was successfully updated. |
| error | string | 2 | An error message if updated is false. |
| source | Source dtkt.replication.v1beta1.Source | 3 | The returned Source if updated is true. |
dtkt.replication.v1beta1messages.protoDeleteSourceRequest
MessageRequest to delete configured Source.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of source config from replication service. |
| id | string | 3 | Unique identifier of Source. |
dtkt.replication.v1beta1messages.protoDeleteSourceResponse
MessageResponse for delete configured Source.
dtkt.replication.v1beta1messages.protoStartSyncRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| destination_id | string | 2 | Unique identifier of Destination. |
| source_config_id | string | 3 | Unique identifier of source config from replication service. |
| source_id | string | 4 | Unique identifier of Source. |
dtkt.replication.v1beta1messages.protoStartSyncResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| source | Source dtkt.replication.v1beta1.Source | 1 | The returned Source. |
dtkt.replication.v1beta1messages.protoStopSyncRequest
Message| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| destination_id | string | 2 | Unique identifier of Destination. |
| source_config_id | string | 3 | Unique identifier of source config from replication service. |
| source_id | string | 4 | Unique identifier of Source. |
dtkt.replication.v1beta1messages.protoStopSyncResponse
Message| Field | Type | Number | Description |
|---|---|---|---|
| source | Source dtkt.replication.v1beta1.Source | 1 | The returned Source. |
dtkt.replication.v1beta1messages.protoDestination
MessageRepresents a replication Destination.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | Replication service of this Destination. |
| config_id | string | 2 | Unique identifier of destination config from replication service. |
| id | string | 3 | Unique identifier of Destination. |
| name | string | 4 | Name assigned to Destination. |
| config | Struct google.protobuf.Struct | 5 | Config for Destination. |
dtkt.replication.v1beta1messages.protoDestinationConfig
MessageRepresents a supported destination config.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | Replication service of destination config. |
| id | string | 2 | Unique identifier for destination config. |
| name | string | 3 | Name of destination config. |
| description | string | 4 | Description of destination config. |
| icon_url | string | 5 | Icon URL of destination config. |
| category | string | 6 | Category of destination config. |
| config_schema | string | 7 | Schema for destination config. |
dtkt.replication.v1beta1messages.protoListDestinationConfigsRequest
MessageRequest to retrieve a list of supported destinations.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
dtkt.replication.v1beta1messages.protoListDestinationConfigsResponse
MessageList of Destinations.
| Field | Type | Number | Description |
|---|---|---|---|
| destination_configs | DestinationConfig[] dtkt.replication.v1beta1.DestinationConfig[] | 1 | No description. |
dtkt.replication.v1beta1messages.protoGetDestinationRequest
MessageRequest for replication Destination of given provider.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of destination config from replication service. |
| id | string | 3 | Unique identifier of Destination. |
dtkt.replication.v1beta1messages.protoGetDestinationResponse
MessageResponse for replication Destination of given provider.
| Field | Type | Number | Description |
|---|---|---|---|
| destination | Destination dtkt.replication.v1beta1.Destination | 1 | No description. |
dtkt.replication.v1beta1messages.protoCreateDestinationRequest
MessageRequest to create configured destination.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of destination config from replication service. |
| name | string | 3 | Name assigned to Destination. |
| config | Struct google.protobuf.Struct | 4 | Destination config overrides. |
dtkt.replication.v1beta1messages.protoCreateDestinationResponse
MessageResponse from create configured destination.
| Field | Type | Number | Description |
|---|---|---|---|
| created | bool | 1 | Indicates whether destination was successfully created. |
| error | string | 2 | An error message if created is false. |
| destination | Destination dtkt.replication.v1beta1.Destination | 3 | The returned destination if created is true. |
dtkt.replication.v1beta1messages.protoUpdateDestinationRequest
MessageRequest to update configured destination.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of destination config from replication service. |
| id | string | 3 | Unique identifier of Destination. |
| config | Struct google.protobuf.Struct | 4 | Destination config overrides. |
dtkt.replication.v1beta1messages.protoUpdateDestinationResponse
MessageResponse from update configured destination.
| Field | Type | Number | Description |
|---|---|---|---|
| updated | bool | 1 | Indicates whether destination was successfully updated. |
| error | string | 2 | An error message if updated is false. |
| destination | Destination dtkt.replication.v1beta1.Destination | 3 | The returned destination if updated is true. |
dtkt.replication.v1beta1messages.protoDeleteDestinationRequest
MessageRequest to delete configured destination.
| Field | Type | Number | Description |
|---|---|---|---|
| service_config | ServiceConfig dtkt.replication.v1beta1.ServiceConfig | 1 | The configured replication service. |
| config_id | string | 2 | Unique identifier of destination config from replication service. |
| id | string | 3 | Unique identifier of Destination. |
dtkt.replication.v1beta1messages.protoDeleteDestinationResponse
MessageResponse for delete configured destination.
dtkt.replication.v1beta1messages.protoServiceConfig
MessageSupported service config.
| Field | Type | Number | Description |
|---|---|---|---|
| service | ServiceType dtkt.replication.v1beta1.ServiceType | 1 | No description. |
| configOneOf | No description. | ||
| fivetran_config | FivetranConfig dtkt.replication.v1beta1.FivetranConfig | 2 | No description. |
dtkt.replication.v1beta1messages.protoFivetranConfig
MessageRepresents Fivetran replication service config.
| Field | Type | Number | Description |
|---|---|---|---|
| api_key | string | 1 | No description. |
| api_secret | string | 2 | No description. |
| webhook_secret | string | 3 | No description. |
| configOneOf | No description. | ||
| source_config | FivetranSourceConfig dtkt.replication.v1beta1.FivetranSourceConfig | 4 | No description. |
| destination_config | FivetranDestinationConfig dtkt.replication.v1beta1.FivetranDestinationConfig | 5 | No description. |
dtkt.replication.v1beta1messages.protoFivetranSourceConfig
Message| Field | Type | Number | Description |
|---|---|---|---|
| group_id | string | 1 | The unique identifier for the group within the Fivetran system |
| paused | bool | 2 | Specifies whether the connector is paused. |
| pause_after_trial | bool | 3 | Specifies whether the connector should be paused after the free trial period has ended. |
| sync_frequency | int32 | 4 | The connector sync frequency in minutes. |
| daily_sync_time | string | 5 | 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_type | string | 6 | The connector schedule configuration type. Supported values: auto, manual. |
| run_setup_tests | bool | 7 | Specifies whether setup tests should be run automatically. |
dtkt.replication.v1beta1messages.protoFivetranDestinationConfig
Message| Field | Type | Number | Description |
|---|---|---|---|
| region | string | 1 | Data processing location. This is where Fivetran will operate and run computation on data. |
| time_zone_offset | string | 2 | Determines the time zone for the Fivetran sync schedule. |
| daylight_saving_time_enabled | bool | 3 | Shift my UTC offset with daylight savings time (US Only) |
| run_setup_tests | bool | 4 | Specifies whether setup tests should be run automatically. |