|
260 | 260 | ] |
261 | 261 | }, |
262 | 262 | "list": { |
263 | | - "description": "Lists the supported instance configurations for a given project.", |
| 263 | + "description": "Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.", |
264 | 264 | "flatPath": "v1/projects/{projectsId}/instanceConfigs", |
265 | 265 | "httpMethod": "GET", |
266 | 266 | "id": "spanner.projects.instanceConfigs.list", |
|
306 | 306 | ], |
307 | 307 | "parameters": { |
308 | 308 | "name": { |
309 | | - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.", |
| 309 | + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", |
310 | 310 | "location": "path", |
311 | 311 | "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", |
312 | 312 | "required": true, |
|
3005 | 3005 | } |
3006 | 3006 | } |
3007 | 3007 | }, |
3008 | | - "revision": "20240529", |
| 3008 | + "revision": "20240612", |
3009 | 3009 | "rootUrl": "https://spanner.googleapis.com/", |
3010 | 3010 | "schemas": { |
3011 | 3011 | "AutoscalingConfig": { |
|
4521 | 4521 | "type": "array" |
4522 | 4522 | }, |
4523 | 4523 | "name": { |
4524 | | - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.", |
| 4524 | + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", |
4525 | 4525 | "type": "string" |
4526 | 4526 | }, |
4527 | 4527 | "optionalReplicas": { |
|
4555 | 4555 | "type": "boolean" |
4556 | 4556 | }, |
4557 | 4557 | "replicas": { |
4558 | | - "description": "The geographic placement of nodes in this instance configuration and their replication properties.", |
| 4558 | + "description": "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`.", |
4559 | 4559 | "items": { |
4560 | 4560 | "$ref": "ReplicaInfo" |
4561 | 4561 | }, |
|
5748 | 5748 | "format": "int64", |
5749 | 5749 | "type": "string" |
5750 | 5750 | }, |
| 5751 | + "lockHint": { |
| 5752 | + "description": "Optional. Lock Hint for the request, it can only be used with read-write transactions.", |
| 5753 | + "enum": [ |
| 5754 | + "LOCK_HINT_UNSPECIFIED", |
| 5755 | + "LOCK_HINT_SHARED", |
| 5756 | + "LOCK_HINT_EXCLUSIVE" |
| 5757 | + ], |
| 5758 | + "enumDescriptions": [ |
| 5759 | + "Default value. LOCK_HINT_UNSPECIFIED is equivalent to LOCK_HINT_SHARED.", |
| 5760 | + "Acquire shared locks. By default when you perform a read as part of a read-write transaction, Spanner acquires shared read locks, which allows other reads to still access the data until your transaction is ready to commit. When your transaction is committing and writes are being applied, the transaction attempts to upgrade to an exclusive lock for any data you are writing. For more information about locks, see [Lock modes](https://cloud.google.com/spanner/docs/introspection/lock-statistics#explain-lock-modes).", |
| 5761 | + "Acquire exclusive locks. Requesting exclusive locks is beneficial if you observe high write contention, which means you notice that multiple transactions are concurrently trying to read and write to the same data, resulting in a large number of aborts. This problem occurs when two transactions initially acquire shared locks and then both try to upgrade to exclusive locks at the same time. In this situation both transactions are waiting for the other to give up their lock, resulting in a deadlocked situation. Spanner is able to detect this occurring and force one of the transactions to abort. However, this is a slow and expensive operation and results in lower performance. In this case it makes sense to acquire exclusive locks at the start of the transaction because then when multiple transactions try to act on the same data, they automatically get serialized. Each transaction waits its turn to acquire the lock and avoids getting into deadlock situations. Because the exclusive lock hint is just a hint, it should not be considered equivalent to a mutex. In other words, you should not use Spanner exclusive locks as a mutual exclusion mechanism for the execution of code outside of Spanner. **Note:** Request exclusive locks judiciously because they block others from reading that data for the entire transaction, rather than just when the writes are being performed. Unless you observe high write contention, you should use the default of shared read locks so you don't prematurely block other clients from reading the data that you're writing to." |
| 5762 | + ], |
| 5763 | + "type": "string" |
| 5764 | + }, |
| 5765 | + "orderBy": { |
| 5766 | + "description": "Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).", |
| 5767 | + "enum": [ |
| 5768 | + "ORDER_BY_UNSPECIFIED", |
| 5769 | + "ORDER_BY_PRIMARY_KEY", |
| 5770 | + "ORDER_BY_NO_ORDER" |
| 5771 | + ], |
| 5772 | + "enumDescriptions": [ |
| 5773 | + "Default value. ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.", |
| 5774 | + "Read rows are returned in primary key order. In the event that this option is used in conjunction with the `partition_token` field, the API will return an `INVALID_ARGUMENT` error.", |
| 5775 | + "Read rows are returned in any order." |
| 5776 | + ], |
| 5777 | + "type": "string" |
| 5778 | + }, |
5751 | 5779 | "partitionToken": { |
5752 | 5780 | "description": "If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.", |
5753 | 5781 | "format": "byte", |
|
6164 | 6192 | "type": "object" |
6165 | 6193 | }, |
6166 | 6194 | "multiplexed": { |
6167 | | - "description": "Optional. If true, specifies a multiplexed session. A multiplexed session may be used for multiple, concurrent read-only operations but can not be used for read-write transactions, partitioned reads, or partitioned queries. Multiplexed sessions can be created via CreateSession but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.", |
| 6195 | + "description": "Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.", |
6168 | 6196 | "type": "boolean" |
6169 | 6197 | }, |
6170 | 6198 | "name": { |
|
0 commit comments