aboutsummaryrefslogtreecommitdiff
path: root/google/spanner/v1/spanner_gapic.yaml
blob: e5d826a782ca458b801a4a0643741d066791a191 (plain)
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
language_settings:
  java:
    package_name: com.google.cloud.spanner.v1
    release_level: GA
  python:
    package_name: google.cloud.spanner_v1.gapic
    release_level: GA
  go:
    package_name: cloud.google.com/go/spanner/apiv1
    domain_layer_location: cloud.google.com/go/spanner
    release_level: GA
  csharp:
    package_name: Google.Cloud.Spanner.V1
    release_level: GA
  ruby:
    package_name: Google::Cloud::Spanner::V1
    release_level: GA
  php:
    package_name: Google\Cloud\Spanner\V1
    release_level: GA
  nodejs:
    package_name: spanner.v1
    domain_layer_location: google-cloud
    release_level: GA
interfaces:
- name: google.spanner.v1.Spanner
  collections:
  - name_pattern: projects/{project}/instances/{instance}/databases/{database}
    entity_name: database
    language_overrides:
    - language: csharp
      common_resource_name: Google.Cloud.Spanner.Common.V1.DatabaseName
  - name_pattern: projects/{project}/instances/{instance}/databases/{database}/sessions/{session}
    entity_name: session
  retry_codes_def:
  - name: idempotent
    retry_codes:
    - UNAVAILABLE
    - DEADLINE_EXCEEDED
  - name: non_idempotent
    retry_codes: []
  - name: long_running
    retry_codes:
    - UNAVAILABLE
  retry_params_def:
  - name: default
    initial_retry_delay_millis: 1000
    retry_delay_multiplier: 1.3
    max_retry_delay_millis: 32000
    initial_rpc_timeout_millis: 60000
    rpc_timeout_multiplier: 1
    max_rpc_timeout_millis: 60000
    total_timeout_millis: 600000
  - name: streaming
    initial_retry_delay_millis: 1000
    retry_delay_multiplier: 1.3
    max_retry_delay_millis: 32000
    initial_rpc_timeout_millis: 120000
    rpc_timeout_multiplier: 1
    max_rpc_timeout_millis: 120000
    total_timeout_millis: 1200000
  - name: long_running
    initial_retry_delay_millis: 1000
    retry_delay_multiplier: 1.3
    max_retry_delay_millis: 32000
    initial_rpc_timeout_millis: 3600000
    rpc_timeout_multiplier: 1
    max_rpc_timeout_millis: 3600000
    total_timeout_millis: 3600000
  methods:
  - name: CreateSession
    flattening:
      groups:
      - parameters:
        - database
    required_fields:
    - database
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      database: database
    timeout_millis: 30000
  - name: GetSession
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: session
    timeout_millis: 30000
  - name: ListSessions
    flattening:
      groups:
      - parameters:
        - database
    required_fields:
    - database
    page_streaming:
      request:
        page_size_field: page_size
        token_field: page_token
      response:
        token_field: next_page_token
        resources_field: sessions
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      database: database
    timeout_millis: 30000
  - name: DeleteSession
    flattening:
      groups:
      - parameters:
        - name
    required_fields:
    - name
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      name: session
    timeout_millis: 30000
  - name: ExecuteSql
    required_fields:
    - session
    - sql
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: ExecuteStreamingSql
    required_fields:
    - session
    - sql
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: non_idempotent
    retry_params_name: streaming
    field_name_patterns:
      session: session
    timeout_millis: 3600000
  - name: ExecuteBatchDml
    required_fields:
    - session
    - transaction
    - statements
    - seqno
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: Read
    required_fields:
    - session
    - table
    - columns
    - key_set
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: StreamingRead
    required_fields:
    - session
    - table
    - columns
    - key_set
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: non_idempotent
    retry_params_name: streaming
    field_name_patterns:
      session: session
    timeout_millis: 3600000
  - name: BeginTransaction
    flattening:
      groups:
      - parameters:
        - session
        - options
    required_fields:
    - session
    - options
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: Commit
    flattening:
      groups:
      - parameters:
        - session
        - transaction_id
        - mutations
      - parameters:
        - session
        - single_use_transaction
        - mutations
    required_fields:
    - session
    - mutations
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: long_running
    retry_params_name: long_running
    field_name_patterns:
      session: session
    timeout_millis: 3600000
  - name: Rollback
    flattening:
      groups:
      - parameters:
        - session
        - transaction_id
    required_fields:
    - session
    - transaction_id
    resource_name_treatment: STATIC_TYPES
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: PartitionQuery
    required_fields:
    - session
    - sql
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
  - name: PartitionRead
    required_fields:
    - session
    - table
    - key_set
    retry_codes_name: idempotent
    retry_params_name: default
    field_name_patterns:
      session: session
    timeout_millis: 30000
resource_name_generation:
- message_name: CreateSessionRequest
  field_entity_map:
    database: database
- message_name: Session
  field_entity_map:
    name: session
- message_name: GetSessionRequest
  field_entity_map:
    name: session
- message_name: DeleteSessionRequest
  field_entity_map:
    name: session
- message_name: ExecuteSqlRequest
  field_entity_map:
    session: session
- message_name: ExecuteBatchDmlRequest
  field_entity_map:
    session: session
- message_name: ReadRequest
  field_entity_map:
    session: session
- message_name: BeginTransactionRequest
  field_entity_map:
    session: session
- message_name: CommitRequest
  field_entity_map:
    session: session
- message_name: RollbackRequest
  field_entity_map:
    session: session
- message_name: PartitionReadRequest
  field_entity_map:
    session: session
- message_name: PartitionQueryRequest
  field_entity_map:
    session: session