Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c57f217

Browse files
yoshi-automationyoshi-automation
committedMar 4, 2025
feat(spanner): update the api
#### spanner:v1 The following keys were added: - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adaptMessage (Total Keys: 12) - resources.projects.resources.instances.resources.databases.resources.sessions.methods.adapter (Total Keys: 12) - schemas.AdaptMessageRequest (Total Keys: 7) - schemas.AdaptMessageResponse (Total Keys: 6) - schemas.AdapterSession (Total Keys: 3)
1 parent bd8cd53 commit c57f217

File tree

2 files changed

+177
-1
lines changed

2 files changed

+177
-1
lines changed
 

‎docs/dyn/spanner_v1.projects.instances.databases.sessions.html

+65
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@
7474

7575
<h1><a href="spanner_v1.html">Cloud Spanner API</a> . <a href="spanner_v1.projects.html">projects</a> . <a href="spanner_v1.projects.instances.html">instances</a> . <a href="spanner_v1.projects.instances.databases.html">databases</a> . <a href="spanner_v1.projects.instances.databases.sessions.html">sessions</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#adaptMessage">adaptMessage(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.</p>
80+
<p class="toc_element">
81+
<code><a href="#adapter">adapter(parent, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.</p>
7783
<p class="toc_element">
7884
<code><a href="#batchCreate">batchCreate(database, body=None, x__xgafv=None)</a></code></p>
7985
<p class="firstline">Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.</p>
@@ -129,6 +135,65 @@ <h2>Instance Methods</h2>
129135
<code><a href="#streamingRead">streamingRead(session, body=None, x__xgafv=None)</a></code></p>
130136
<p class="firstline">Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.</p>
131137
<h3>Method Details</h3>
138+
<div class="method">
139+
<code class="details" id="adaptMessage">adaptMessage(name, body=None, x__xgafv=None)</code>
140+
<pre>Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.
141+
142+
Args:
143+
name: string, Required. The database session in which the adapter request is processed. (required)
144+
body: object, The request body.
145+
The object takes the form of:
146+
147+
{ # Message sent by the client to the adapter.
148+
&quot;attachments&quot;: { # Optional. Opaque request state passed by the client to the server.
149+
&quot;a_key&quot;: &quot;A String&quot;,
150+
},
151+
&quot;payload&quot;: &quot;A String&quot;, # Optional. Uninterpreted bytes from the underlying wire protocol.
152+
&quot;protocol&quot;: &quot;A String&quot;, # Required. Identifier for the underlying wire protocol.
153+
}
154+
155+
x__xgafv: string, V1 error format.
156+
Allowed values
157+
1 - v1 error format
158+
2 - v2 error format
159+
160+
Returns:
161+
An object of the form:
162+
163+
{ # Message sent by the adapter to the client.
164+
&quot;payload&quot;: &quot;A String&quot;, # Optional. Uninterpreted bytes from the underlying wire protocol.
165+
&quot;stateUpdates&quot;: { # Optional. Opaque state updates to be applied by the client.
166+
&quot;a_key&quot;: &quot;A String&quot;,
167+
},
168+
}</pre>
169+
</div>
170+
171+
<div class="method">
172+
<code class="details" id="adapter">adapter(parent, body=None, x__xgafv=None)</code>
173+
<pre>Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.
174+
175+
Args:
176+
parent: string, Required. The database in which the new session is created. (required)
177+
body: object, The request body.
178+
The object takes the form of:
179+
180+
{ # A session in the Cloud Spanner Adapter API.
181+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the session. This is always system-assigned.
182+
}
183+
184+
x__xgafv: string, V1 error format.
185+
Allowed values
186+
1 - v1 error format
187+
2 - v2 error format
188+
189+
Returns:
190+
An object of the form:
191+
192+
{ # A session in the Cloud Spanner Adapter API.
193+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the session. This is always system-assigned.
194+
}</pre>
195+
</div>
196+
132197
<div class="method">
133198
<code class="details" id="batchCreate">batchCreate(database, body=None, x__xgafv=None)</code>
134199
<pre>Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

‎googleapiclient/discovery_cache/documents/spanner.v1.json

+112-1
Original file line numberDiff line numberDiff line change
@@ -2343,6 +2343,64 @@
23432343
},
23442344
"sessions": {
23452345
"methods": {
2346+
"adaptMessage": {
2347+
"description": "Handles a single message from the client and returns the result as a stream. The server will interpret the message frame and respond with message frames to the client.",
2348+
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:adaptMessage",
2349+
"httpMethod": "POST",
2350+
"id": "spanner.projects.instances.databases.sessions.adaptMessage",
2351+
"parameterOrder": [
2352+
"name"
2353+
],
2354+
"parameters": {
2355+
"name": {
2356+
"description": "Required. The database session in which the adapter request is processed.",
2357+
"location": "path",
2358+
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
2359+
"required": true,
2360+
"type": "string"
2361+
}
2362+
},
2363+
"path": "v1/{+name}:adaptMessage",
2364+
"request": {
2365+
"$ref": "AdaptMessageRequest"
2366+
},
2367+
"response": {
2368+
"$ref": "AdaptMessageResponse"
2369+
},
2370+
"scopes": [
2371+
"https://www.googleapis.com/auth/cloud-platform",
2372+
"https://www.googleapis.com/auth/spanner.data"
2373+
]
2374+
},
2375+
"adapter": {
2376+
"description": "Creates a new session to be used for requests made by the adapter. A session identifies a specific incarnation of a database resource and is meant to be reused across many `AdaptMessage` calls.",
2377+
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:adapter",
2378+
"httpMethod": "POST",
2379+
"id": "spanner.projects.instances.databases.sessions.adapter",
2380+
"parameterOrder": [
2381+
"parent"
2382+
],
2383+
"parameters": {
2384+
"parent": {
2385+
"description": "Required. The database in which the new session is created.",
2386+
"location": "path",
2387+
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
2388+
"required": true,
2389+
"type": "string"
2390+
}
2391+
},
2392+
"path": "v1/{+parent}/sessions:adapter",
2393+
"request": {
2394+
"$ref": "AdapterSession"
2395+
},
2396+
"response": {
2397+
"$ref": "AdapterSession"
2398+
},
2399+
"scopes": [
2400+
"https://www.googleapis.com/auth/cloud-platform",
2401+
"https://www.googleapis.com/auth/spanner.data"
2402+
]
2403+
},
23462404
"batchCreate": {
23472405
"description": "Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.",
23482406
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate",
@@ -3348,9 +3406,62 @@
33483406
}
33493407
}
33503408
},
3351-
"revision": "20250218",
3409+
"revision": "20250220",
33523410
"rootUrl": "https://spanner.googleapis.com/",
33533411
"schemas": {
3412+
"AdaptMessageRequest": {
3413+
"description": "Message sent by the client to the adapter.",
3414+
"id": "AdaptMessageRequest",
3415+
"properties": {
3416+
"attachments": {
3417+
"additionalProperties": {
3418+
"type": "string"
3419+
},
3420+
"description": "Optional. Opaque request state passed by the client to the server.",
3421+
"type": "object"
3422+
},
3423+
"payload": {
3424+
"description": "Optional. Uninterpreted bytes from the underlying wire protocol.",
3425+
"format": "byte",
3426+
"type": "string"
3427+
},
3428+
"protocol": {
3429+
"description": "Required. Identifier for the underlying wire protocol.",
3430+
"type": "string"
3431+
}
3432+
},
3433+
"type": "object"
3434+
},
3435+
"AdaptMessageResponse": {
3436+
"description": "Message sent by the adapter to the client.",
3437+
"id": "AdaptMessageResponse",
3438+
"properties": {
3439+
"payload": {
3440+
"description": "Optional. Uninterpreted bytes from the underlying wire protocol.",
3441+
"format": "byte",
3442+
"type": "string"
3443+
},
3444+
"stateUpdates": {
3445+
"additionalProperties": {
3446+
"type": "string"
3447+
},
3448+
"description": "Optional. Opaque state updates to be applied by the client.",
3449+
"type": "object"
3450+
}
3451+
},
3452+
"type": "object"
3453+
},
3454+
"AdapterSession": {
3455+
"description": "A session in the Cloud Spanner Adapter API.",
3456+
"id": "AdapterSession",
3457+
"properties": {
3458+
"name": {
3459+
"description": "Identifier. The name of the session. This is always system-assigned.",
3460+
"type": "string"
3461+
}
3462+
},
3463+
"type": "object"
3464+
},
33543465
"AddSplitPointsRequest": {
33553466
"description": "The request for AddSplitPoints.",
33563467
"id": "AddSplitPointsRequest",

0 commit comments

Comments
 (0)
Please sign in to comment.