Skip to content

Commit a58343b

Browse files
feat(spanner): update the api
#### spanner:v1 The following keys were added: - schemas.ReadRequest.properties.lockHint.type (Total Keys: 1) - schemas.ReadRequest.properties.orderBy.type (Total Keys: 1)
1 parent 3a74e53 commit a58343b

File tree

3 files changed

+55
-23
lines changed

3 files changed

+55
-23
lines changed

docs/dyn/spanner_v1.projects.instanceConfigs.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h2>Instance Methods</h2>
9898
<p class="firstline">Gets information about a particular instance configuration.</p>
9999
<p class="toc_element">
100100
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
101-
<p class="firstline">Lists the supported instance configurations for a given project.</p>
101+
<p class="firstline">Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.</p>
102102
<p class="toc_element">
103103
<code><a href="#list_next">list_next()</a></code></p>
104104
<p class="firstline">Retrieves the next page of results.</p>
@@ -133,7 +133,7 @@ <h3>Method Details</h3>
133133
&quot;leaderOptions&quot;: [ # Allowed values of the &quot;default_leader&quot; schema option for databases in instances that use this instance configuration.
134134
&quot;A String&quot;,
135135
],
136-
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
136+
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.
137137
&quot;optionalReplicas&quot;: [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
138138
{
139139
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
@@ -143,7 +143,7 @@ <h3>Method Details</h3>
143143
],
144144
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
145145
&quot;reconciling&quot;: True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
146-
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
146+
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
147147
{
148148
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
149149
&quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g., &quot;us-central1&quot;.
@@ -232,7 +232,7 @@ <h3>Method Details</h3>
232232
&quot;leaderOptions&quot;: [ # Allowed values of the &quot;default_leader&quot; schema option for databases in instances that use this instance configuration.
233233
&quot;A String&quot;,
234234
],
235-
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
235+
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.
236236
&quot;optionalReplicas&quot;: [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
237237
{
238238
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
@@ -242,7 +242,7 @@ <h3>Method Details</h3>
242242
],
243243
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
244244
&quot;reconciling&quot;: True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
245-
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
245+
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
246246
{
247247
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
248248
&quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g., &quot;us-central1&quot;.
@@ -256,7 +256,7 @@ <h3>Method Details</h3>
256256

257257
<div class="method">
258258
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
259-
<pre>Lists the supported instance configurations for a given project.
259+
<pre>Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.
260260

261261
Args:
262262
parent: string, Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. (required)
@@ -284,7 +284,7 @@ <h3>Method Details</h3>
284284
&quot;leaderOptions&quot;: [ # Allowed values of the &quot;default_leader&quot; schema option for databases in instances that use this instance configuration.
285285
&quot;A String&quot;,
286286
],
287-
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
287+
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.
288288
&quot;optionalReplicas&quot;: [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
289289
{
290290
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
@@ -294,7 +294,7 @@ <h3>Method Details</h3>
294294
],
295295
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
296296
&quot;reconciling&quot;: True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
297-
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
297+
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
298298
{
299299
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
300300
&quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g., &quot;us-central1&quot;.
@@ -328,7 +328,7 @@ <h3>Method Details</h3>
328328
<pre>Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config&#x27;s reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata&#x27;s cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config&#x27;s new values are readable via the API. * The instance config&#x27;s reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
329329

330330
Args:
331-
name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. (required)
331+
name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. (required)
332332
body: object, The request body.
333333
The object takes the form of:
334334

@@ -345,7 +345,7 @@ <h3>Method Details</h3>
345345
&quot;leaderOptions&quot;: [ # Allowed values of the &quot;default_leader&quot; schema option for databases in instances that use this instance configuration.
346346
&quot;A String&quot;,
347347
],
348-
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.
348+
&quot;name&quot;: &quot;A String&quot;, # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.
349349
&quot;optionalReplicas&quot;: [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
350350
{
351351
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
@@ -355,7 +355,7 @@ <h3>Method Details</h3>
355355
],
356356
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
357357
&quot;reconciling&quot;: True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
358-
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
358+
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
359359
{
360360
&quot;defaultLeaderLocation&quot;: True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
361361
&quot;location&quot;: &quot;A String&quot;, # The location of the serving resources, e.g., &quot;us-central1&quot;.

0 commit comments

Comments
 (0)