Skip to content

Commit 195cae3

Browse files
feat(spanner): update the api
#### spanner:v1 The following keys were added: - resources.projects.resources.instances.resources.databases.methods.changequorum (Total Keys: 12) - schemas.ChangeQuorumMetadata (Total Keys: 7) - schemas.ChangeQuorumRequest (Total Keys: 4) - schemas.Database.properties.quorumInfo (Total Keys: 2) - schemas.DualRegionQuorum (Total Keys: 2) - schemas.InstanceConfig.properties.quorumType (Total Keys: 2) - schemas.QuorumInfo (Total Keys: 9) - schemas.QuorumType (Total Keys: 4) - schemas.SingleRegionQuorum (Total Keys: 3)
1 parent 0cfcab3 commit 195cae3

6 files changed

+286
-32
lines changed

docs/dyn/spanner_v1.projects.instanceConfigs.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ <h3>Method Details</h3>
141141
&quot;type&quot;: &quot;A String&quot;, # The type of replica.
142142
},
143143
],
144+
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
144145
&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.
145146
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
146147
{
@@ -239,6 +240,7 @@ <h3>Method Details</h3>
239240
&quot;type&quot;: &quot;A String&quot;, # The type of replica.
240241
},
241242
],
243+
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
242244
&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.
243245
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
244246
{
@@ -290,6 +292,7 @@ <h3>Method Details</h3>
290292
&quot;type&quot;: &quot;A String&quot;, # The type of replica.
291293
},
292294
],
295+
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
293296
&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.
294297
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
295298
{
@@ -350,6 +353,7 @@ <h3>Method Details</h3>
350353
&quot;type&quot;: &quot;A String&quot;, # The type of replica.
351354
},
352355
],
356+
&quot;quorumType&quot;: &quot;A String&quot;, # Output only. The `QuorumType` of the instance configuration.
353357
&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.
354358
&quot;replicas&quot;: [ # The geographic placement of nodes in this instance configuration and their replication properties.
355359
{

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ <h2>Instance Methods</h2>
8989
</p>
9090
<p class="firstline">Returns the sessions Resource.</p>
9191

92+
<p class="toc_element">
93+
<code><a href="#changequorum">changequorum(name, body=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">ChangeQuorum is strictly restricted to databases that use dual region instance configurations. Initiates a background operation to change quorum a database from dual-region mode to single-region mode and vice versa. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track execution of the ChangeQuorum. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.</p>
9295
<p class="toc_element">
9396
<code><a href="#close">close()</a></code></p>
9497
<p class="firstline">Close httplib2 connections.</p>
@@ -132,6 +135,56 @@ <h2>Instance Methods</h2>
132135
<code><a href="#updateDdl">updateDdl(database, body=None, x__xgafv=None)</a></code></p>
133136
<p class="firstline">Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.</p>
134137
<h3>Method Details</h3>
138+
<div class="method">
139+
<code class="details" id="changequorum">changequorum(name, body=None, x__xgafv=None)</code>
140+
<pre>ChangeQuorum is strictly restricted to databases that use dual region instance configurations. Initiates a background operation to change quorum a database from dual-region mode to single-region mode and vice versa. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track execution of the ChangeQuorum. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.
141+
142+
Args:
143+
name: string, Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. (required)
144+
body: object, The request body.
145+
The object takes the form of:
146+
147+
{ # The request for ChangeQuorum.
148+
&quot;etag&quot;: &quot;A String&quot;, # Optional. The etag is the hash of the QuorumInfo. The ChangeQuorum operation will only be performed if the etag matches that of the QuorumInfo in the current database resource. Otherwise the API will return an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition.
149+
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`.
150+
&quot;quorumType&quot;: { # Information about the database quorum type. this applies only for dual region instance configs. # Required. The type of this Quorum.
151+
&quot;dualRegion&quot;: { # Message type for a dual-region quorum. Currently this type has no options. # Dual region quorum type.
152+
},
153+
&quot;singleRegion&quot;: { # Message type for a single-region quorum. # Single region quorum type.
154+
&quot;servingLocation&quot;: &quot;A String&quot;, # Required. The location of the serving region, e.g. &quot;us-central1&quot;. The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type.
155+
},
156+
},
157+
}
158+
159+
x__xgafv: string, V1 error format.
160+
Allowed values
161+
1 - v1 error format
162+
2 - v2 error format
163+
164+
Returns:
165+
An object of the form:
166+
167+
{ # This resource represents a long-running operation that is the result of a network API call.
168+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
169+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
170+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
171+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
172+
{
173+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174+
},
175+
],
176+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
177+
},
178+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
179+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180+
},
181+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
182+
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
183+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184+
},
185+
}</pre>
186+
</div>
187+
135188
<div class="method">
136189
<code class="details" id="close">close()</code>
137190
<pre>Close httplib2 connections.</pre>
@@ -250,6 +303,18 @@ <h3>Method Details</h3>
250303
},
251304
],
252305
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
306+
&quot;quorumInfo&quot;: { # Information about the dual region quorum. # Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum.
307+
&quot;etag&quot;: &quot;A String&quot;, # Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition.
308+
&quot;initiator&quot;: &quot;A String&quot;, # Output only. Whether this ChangeQuorum is a Google or User initiated.
309+
&quot;quorumType&quot;: { # Information about the database quorum type. this applies only for dual region instance configs. # Output only. The type of this quorum. See QuorumType for more information about quorum type specifications.
310+
&quot;dualRegion&quot;: { # Message type for a dual-region quorum. Currently this type has no options. # Dual region quorum type.
311+
},
312+
&quot;singleRegion&quot;: { # Message type for a single-region quorum. # Single region quorum type.
313+
&quot;servingLocation&quot;: &quot;A String&quot;, # Required. The location of the serving region, e.g. &quot;us-central1&quot;. The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type.
314+
},
315+
},
316+
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the request was triggered.
317+
},
253318
&quot;reconciling&quot;: True or False, # Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
254319
&quot;restoreInfo&quot;: { # Information about the database restore. # Output only. Applicable only for restored databases. Contains information about the restore source.
255320
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the database. The backup may no longer exist.
@@ -581,6 +646,18 @@ <h3>Method Details</h3>
581646
},
582647
],
583648
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
649+
&quot;quorumInfo&quot;: { # Information about the dual region quorum. # Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum.
650+
&quot;etag&quot;: &quot;A String&quot;, # Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition.
651+
&quot;initiator&quot;: &quot;A String&quot;, # Output only. Whether this ChangeQuorum is a Google or User initiated.
652+
&quot;quorumType&quot;: { # Information about the database quorum type. this applies only for dual region instance configs. # Output only. The type of this quorum. See QuorumType for more information about quorum type specifications.
653+
&quot;dualRegion&quot;: { # Message type for a dual-region quorum. Currently this type has no options. # Dual region quorum type.
654+
},
655+
&quot;singleRegion&quot;: { # Message type for a single-region quorum. # Single region quorum type.
656+
&quot;servingLocation&quot;: &quot;A String&quot;, # Required. The location of the serving region, e.g. &quot;us-central1&quot;. The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type.
657+
},
658+
},
659+
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the request was triggered.
660+
},
584661
&quot;reconciling&quot;: True or False, # Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
585662
&quot;restoreInfo&quot;: { # Information about the database restore. # Output only. Applicable only for restored databases. Contains information about the restore source.
586663
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the database. The backup may no longer exist.
@@ -650,6 +727,18 @@ <h3>Method Details</h3>
650727
},
651728
],
652729
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
730+
&quot;quorumInfo&quot;: { # Information about the dual region quorum. # Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum.
731+
&quot;etag&quot;: &quot;A String&quot;, # Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition.
732+
&quot;initiator&quot;: &quot;A String&quot;, # Output only. Whether this ChangeQuorum is a Google or User initiated.
733+
&quot;quorumType&quot;: { # Information about the database quorum type. this applies only for dual region instance configs. # Output only. The type of this quorum. See QuorumType for more information about quorum type specifications.
734+
&quot;dualRegion&quot;: { # Message type for a dual-region quorum. Currently this type has no options. # Dual region quorum type.
735+
},
736+
&quot;singleRegion&quot;: { # Message type for a single-region quorum. # Single region quorum type.
737+
&quot;servingLocation&quot;: &quot;A String&quot;, # Required. The location of the serving region, e.g. &quot;us-central1&quot;. The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type.
738+
},
739+
},
740+
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the request was triggered.
741+
},
653742
&quot;reconciling&quot;: True or False, # Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.
654743
&quot;restoreInfo&quot;: { # Information about the database restore. # Output only. Applicable only for restored databases. Contains information about the restore source.
655744
&quot;backupInfo&quot;: { # Information about a backup. # Information about the backup used to restore the database. The backup may no longer exist.

0 commit comments

Comments
 (0)