/
snippet_metadata.google.cloud.bigquery.storage.v1beta1.json
198 lines (198 loc) · 8.31 KB
/
snippet_metadata.google.cloud.bigquery.storage.v1beta1.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
{
"clientLibrary": {
"name": "cloud.google.com/go/bigquery/storage/apiv1beta1",
"version": "1.55.0",
"language": "GO",
"apis": [
{
"id": "google.cloud.bigquery.storage.v1beta1",
"version": "v1beta1"
}
]
},
"snippets": [
{
"regionTag": "bigquerystorage_v1beta1_generated_BigQueryStorage_BatchCreateReadSessionStreams_sync",
"title": "bigquerystorage BatchCreateReadSessionStreams Sample",
"description": "BatchCreateReadSessionStreams creates additional streams for a ReadSession. This API can be used to\ndynamically adjust the parallelism of a batch processing task upwards by\nadding additional workers.",
"file": "BigQueryStorageClient/BatchCreateReadSessionStreams/main.go",
"language": "GO",
"clientMethod": {
"shortName": "BatchCreateReadSessionStreams",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient.BatchCreateReadSessionStreams",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "storagepb.BatchCreateReadSessionStreamsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*storagepb.BatchCreateReadSessionStreamsResponse",
"client": {
"shortName": "BigQueryStorageClient",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient"
},
"method": {
"shortName": "BatchCreateReadSessionStreams",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage.BatchCreateReadSessionStreams",
"service": {
"shortName": "BigQueryStorage",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "bigquerystorage_v1beta1_generated_BigQueryStorage_CreateReadSession_sync",
"title": "bigquerystorage CreateReadSession Sample",
"description": "CreateReadSession creates a new read session. A read session divides the contents of a\nBigQuery table into one or more streams, which can then be used to read\ndata from the table. The read session also specifies properties of the\ndata to be read, such as a list of columns or a push-down filter describing\nthe rows to be returned.\n\nA particular row can be read by at most one stream. When the caller has\nreached the end of each stream in the session, then all the data in the\ntable has been read.\n\nRead sessions automatically expire 6 hours after they are created and do\nnot require manual clean-up by the caller.",
"file": "BigQueryStorageClient/CreateReadSession/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateReadSession",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient.CreateReadSession",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "storagepb.CreateReadSessionRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*storagepb.ReadSession",
"client": {
"shortName": "BigQueryStorageClient",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient"
},
"method": {
"shortName": "CreateReadSession",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage.CreateReadSession",
"service": {
"shortName": "BigQueryStorage",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "bigquerystorage_v1beta1_generated_BigQueryStorage_FinalizeStream_sync",
"title": "bigquerystorage FinalizeStream Sample",
"description": "FinalizeStream causes a single stream in a ReadSession to gracefully stop. This\nAPI can be used to dynamically adjust the parallelism of a batch processing\ntask downwards without losing data.\n\nThis API does not delete the stream -- it remains visible in the\nReadSession, and any data processed by the stream is not released to other\nstreams. However, no additional data will be assigned to the stream once\nthis call completes. Callers must continue reading data on the stream until\nthe end of the stream is reached so that data which has already been\nassigned to the stream will be processed.\n\nThis method will return an error if there are no other live streams\nin the Session, or if SplitReadStream() has been called on the given\nStream.",
"file": "BigQueryStorageClient/FinalizeStream/main.go",
"language": "GO",
"clientMethod": {
"shortName": "FinalizeStream",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient.FinalizeStream",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "storagepb.FinalizeStreamRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "BigQueryStorageClient",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient"
},
"method": {
"shortName": "FinalizeStream",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage.FinalizeStream",
"service": {
"shortName": "BigQueryStorage",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "bigquerystorage_v1beta1_generated_BigQueryStorage_SplitReadStream_sync",
"title": "bigquerystorage SplitReadStream Sample",
"description": "SplitReadStream splits a given read stream into two Streams. These streams are referred to\nas the primary and the residual of the split. The original stream can still\nbe read from in the same manner as before. Both of the returned streams can\nalso be read from, and the total rows return by both child streams will be\nthe same as the rows read from the original stream.\n\nMoreover, the two child streams will be allocated back to back in the\noriginal Stream. Concretely, it is guaranteed that for streams Original,\nPrimary, and Residual, that Original[0-j] = Primary[0-j] and\nOriginal[j-n] = Residual[0-m] once the streams have been read to\ncompletion.\n\nThis method is guaranteed to be idempotent.",
"file": "BigQueryStorageClient/SplitReadStream/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SplitReadStream",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient.SplitReadStream",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "storagepb.SplitReadStreamRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*storagepb.SplitReadStreamResponse",
"client": {
"shortName": "BigQueryStorageClient",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorageClient"
},
"method": {
"shortName": "SplitReadStream",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage.SplitReadStream",
"service": {
"shortName": "BigQueryStorage",
"fullName": "google.cloud.bigquery.storage.v1beta1.BigQueryStorage"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
}
]
}