talos

1
---
2
title: API
3
description: Talos gRPC API reference.
4
---
5

6
## Table of Contents
7
{{range .Files}}
8
{{$file_name := .Name}}- [{{.Name}}](#{{.Name}})
9
  {{- if .Messages }}
10
  {{range .Messages}}  - [{{.LongName}}](#{{.FullName}})
11
  {{end}}
12
  {{- end -}}
13
  {{- if .Enums }}
14
  {{range .Enums}}  - [{{.LongName}}](#{{.FullName}})
15
  {{end}}
16
  {{- end -}}
17
  {{- if .Extensions }}
18
  {{range (list .Extensions | uniq)}}  - [File-level Extensions](#{{$file_name}}-extensions)
19
  {{end}}
20
  {{- end -}}
21
  {{- if .Services }}
22
  {{range .Services}}  - [{{.Name}}](#{{.FullName}})
23
  {{end}}
24
  {{- end -}}
25
{{end}}
26
- [Scalar Value Types](#scalar-value-types)
27

28
{{range .Files}}
29
{{$file_name := .Name}}
30
<a name="{{.Name}}"></a>
31
<p align="right"><a href="#top">Top</a></p>
32

33
## {{.Name}}
34
{{.Description}}
35

36
{{range .Messages}}
37
<a name="{{.FullName}}"></a>
38

39
### {{.LongName}}
40
{{.Description}}
41

42
{{if .HasFields}}
43
| Field | Type | Label | Description |
44
| ----- | ---- | ----- | ----------- |
45
{{range .Fields -}}
46
  | {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
47
{{end}}
48
{{end}}
49

50
{{if .HasExtensions}}
51
| Extension | Type | Base | Number | Description |
52
| --------- | ---- | ---- | ------ | ----------- |
53
{{range .Extensions -}}
54
  | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
55
{{end}}
56
{{end}}
57

58
{{end}} <!-- end messages -->
59

60
{{range .Enums}}
61
<a name="{{.FullName}}"></a>
62

63
### {{.LongName}}
64
{{.Description}}
65

66
| Name | Number | Description |
67
| ---- | ------ | ----------- |
68
{{range .Values -}}
69
  | {{.Name}} | {{.Number}} | {{nobr .Description}} |
70
{{end}}
71

72
{{end}} <!-- end enums -->
73

74
{{if .HasExtensions}}
75
<a name="{{$file_name}}-extensions"></a>
76

77
### File-level Extensions
78
| Extension | Type | Base | Number | Description |
79
| --------- | ---- | ---- | ------ | ----------- |
80
{{range .Extensions -}}
81
  | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
82
{{end}}
83
{{end}} <!-- end HasExtensions -->
84

85
{{range .Services}}
86
<a name="{{.FullName}}"></a>
87

88
### {{.Name}}
89
{{.Description}}
90

91
| Method Name | Request Type | Response Type | Description |
92
| ----------- | ------------ | ------------- | ------------|
93
{{range .Methods -}}
94
  | {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
95
{{end}}
96
{{end}} <!-- end services -->
97

98
{{end}}
99

100
## Scalar Value Types
101

102
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
103
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
104
{{range .Scalars -}}
105
  | <a name="{{.ProtoType}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
106
{{end}}
107