Blame - docs/dyn/spanner_v1.projects.instances.databases.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<code><a href="#close">close()</a></code></p>

89

<p class="firstline">Close httplib2 connections.</p>

90

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

91

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

92

<p class="firstline">Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

93

94

<code><a href="#dropDatabase">dropDatabase(database, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

95

<p class="firstline">Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

96

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

97

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

98

<p class="firstline">Gets the state of a Cloud Spanner database.</p>

99

100

<code><a href="#getDdl">getDdl(database, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

101

<p class="firstline">Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

102

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

104

<p class="firstline">Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

105

yoshi-code-bot

227f8c9

2021-05-26 00:34:03 -0700

[diff] [blame]

106

<code><a href="#getScans">getScans(name, endTime=None, startTime=None, view=None, x__xgafv=None)</a></code></p>

107

<p class="firstline">Request a specific scan with Database-specific data for Cloud Key Visualizer.</p>

108

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

109

<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

110

<p class="firstline">Lists Cloud Spanner databases.</p>

111

112

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

113

<p class="firstline">Retrieves the next page of results.</p>

114

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

115

<code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

116

<p class="firstline">Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

117

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

119

<p class="firstline">Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.</p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

120

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

121

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

122

<p class="firstline">Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

123

124

<code><a href="#updateDdl">updateDdl(database, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

125

<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>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

126

<h3>Method Details</h3>

127

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

128

<code class="details" id="close">close()</code>

129

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

133

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

134

<pre>Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

135

136

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

137

parent: string, Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

138

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

139

The object takes the form of:

140

141

{ # The request for CreateDatabase.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

142

"createStatement": "A String", # Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `a-z*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``).

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

143

"encryptionConfig": { # Encryption configuration for a Cloud Spanner database. # Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.

144

"kmsKeyName": "A String", # The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

145

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

146

"extraStatements": [ # Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.

147

"A String",

148

],

149

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

150

151

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

158

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

159

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

160

"done": 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.

161

"error": { # 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.

162

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

163

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

164

{

165

"a_key": "", # Properties of the object. Contains field @type with type URL.

166

},

167

],

168

"message": "A String", # 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.

169

},

170

"metadata": { # 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.

171

"a_key": "", # Properties of the object. Contains field @type with type URL.

172

},

173

"name": "A String", # 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}`.

174

"response": { # The normal response of the operation in case of success. 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`.

175

"a_key": "", # Properties of the object. Contains field @type with type URL.

176

},

177

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

<code class="details" id="dropDatabase">dropDatabase(database, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

182

<pre>Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

183

184

Args:

185

database: string, Required. The database to be dropped. (required)

186

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

193

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

194

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

195

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

199

<code class="details" id="get">get(name, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

200

<pre>Gets the state of a Cloud Spanner database.

201

202

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

203

name: string, Required. The name of the requested database. Values are of the form `projects//instances//databases/`. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

204

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

211

212

{ # A Cloud Spanner database.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

213

"createTime": "A String", # Output only. If exists, the time at which the database creation started.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

214

"earliestVersionTime": "A String", # Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

215

"encryptionConfig": { # Encryption configuration for a Cloud Spanner database. # Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty.

216

"kmsKeyName": "A String", # The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

217

},

218

"encryptionInfo": [ # Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as encryption state and the Cloud KMS key versions that are in use. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

219

{ # Encryption information for a Cloud Spanner database or backup.

220

"encryptionStatus": { # 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). # Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.

221

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

222

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

223

{

224

"a_key": "", # Properties of the object. Contains field @type with type URL.

225

},

226

],

227

"message": "A String", # 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.

228

},

229

"encryptionType": "A String", # Output only. The type of encryption.

230

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup.

231

},

232

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

233

"name": "A String", # 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.

234

"restoreInfo": { # Information about the database restore. # Output only. Applicable only for restored databases. Contains information about the restore source.

235

"backupInfo": { # Information about a backup. # Information about the backup used to restore the database. The backup may no longer exist.

236

"backup": "A String", # Name of the backup.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

237

"createTime": "A String", # The time the CreateBackup request was received.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

238

"sourceDatabase": "A String", # Name of the database the backup was created from.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

239

"versionTime": "A String", # The backup contains an externally consistent copy of `source_database` at the timestamp specified by `version_time`. If the CreateBackup request did not specify `version_time`, the `version_time` of the backup is equivalent to the `create_time`.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

240

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

241

"sourceType": "A String", # The type of the restore source.

242

},

243

"state": "A String", # Output only. The current database state.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

244

"versionRetentionPeriod": "A String", # Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

245

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

<code class="details" id="getDdl">getDdl(database, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

250

<pre>Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

251

252

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

253

database: string, Required. The database whose schema we wish to get. Values are of the form `projects//instances//databases/` (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

254

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

261

262

{ # The response for GetDatabaseDdl.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

263

"statements": [ # A list of formatted DDL statements defining the schema of the database specified in the request.

264

"A String",

265

],

266

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

270

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

271

<pre>Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

272

273

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

274

resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

275

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

276

The object takes the form of:

277

278

{ # Request message for `GetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

279

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.

280

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

281

},

282

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

283

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

292

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

293

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

294

{ # Associates `members` with a `role`.

295

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

296

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

297

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

298

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

299

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

300

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

301

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

302

"A String",

303

],

304

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

305

},

306

],

307

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

308

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

309

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-05-26 00:34:03 -0700

[diff] [blame]

313

<code class="details" id="getScans">getScans(name, endTime=None, startTime=None, view=None, x__xgafv=None)</code>

314

<pre>Request a specific scan with Database-specific data for Cloud Key Visualizer.

315

316

Args:

317

name: string, Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface. (required)

318

endTime: string, The upper bound for the time range to retrieve Scan data for.

319

startTime: string, These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.

320

view: string, Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.

321

Allowed values

322

VIEW_UNSPECIFIED - Not specified, equivalent to SUMMARY.

323

SUMMARY - Server responses only include `name`, `details`, `start_time` and `end_time`. The default value. Note, the ListScans method may only use this view type, others view types are not supported.

324

FULL - Full representation of the scan is returned in the server response, including `data`.

325

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

332

333

{ # Scan is a structure which describes Cloud Key Visualizer scan information.

334

"details": { # Additional information provided by the implementer.

335

"a_key": "", # Properties of the object. Contains field @type with type URL.

336

},

337

"endTime": "A String", # The upper bound for when the scan is defined.

338

"name": "A String", # The unique name of the scan, specific to the Database service implementing this interface.

339

"scanData": { # ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization. # Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans method.

340

"data": { # Cloud Key Visualizer scan data. The range of time this information covers is captured via the above time range fields. Note, this field is not available to the ListScans method.

341

"dataSourceEndToken": "A String", # The token signifying the end of a data_source.

342

"dataSourceSeparatorToken": "A String", # The token delimiting a datasource name from the rest of a key in a data_source.

343

"diagnosticMessages": [ # The list of messages (info, alerts, ...)

344

{ # A message representing the key visualizer diagnostic messages.

345

"info": { # A message representing a user-facing string whose value may need to be translated before being displayed. # Information about this diagnostic information.

346

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

347

"a_key": "A String",

348

},

349

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

350

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

351

},

352

"metric": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The metric.

353

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

354

"a_key": "A String",

355

},

356

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

357

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

358

},

359

"metricSpecific": True or False, # Whether this message is specific only for the current metric. By default Diagnostics are shown for all metrics, regardless which metric is the currently selected metric in the UI. However occasionally a metric will generate so many messages that the resulting visual clutter becomes overwhelming. In this case setting this to true, will show the diagnostic messages for that metric only if it is the currently selected metric.

360

"severity": "A String", # The severity of the diagnostic message.

361

"shortMessage": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The short message.

362

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

363

"a_key": "A String",

364

},

365

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

366

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

},

},

],

"endKeyStrings": [ # We discretize the entire keyspace into buckets. Assuming each bucket has an inclusive keyrange and covers keys from k(i) ... k(n). In this case k(n) would be an end key for a given range. end_key_string is the collection of all such end keys

371

"A String",

372

],

373

"hasPii": True or False, # Whether this scan contains PII.

374

"indexedKeys": [ # Keys of key ranges that contribute significantly to a given metric Can be thought of as heavy hitters.

375

"A String",

376

],

377

"keySeparator": "A String", # The token delimiting the key prefixes.

378

"keyUnit": "A String", # The unit for the key: e.g. 'key' or 'chunk'.

379

"metrics": [ # The list of data objects for each metric.

380

{ # A message representing the actual monitoring data, values for each key bucket over time, of a metric.

381

"aggregation": "A String", # The aggregation function used to aggregate each key bucket

382

"category": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The category of the metric, e.g. "Activity", "Alerts", "Reads", etc.

383

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

384

"a_key": "A String",

385

},

386

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

387

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

388

},

389

"derived": { # A message representing a derived metric. # The references to numerator and denominator metrics for a derived metric.

390

"denominator": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The name of the denominator metric. e.g. "rows".

391

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

392

"a_key": "A String",

393

},

394

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

395

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

396

},

397

"numerator": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The name of the numerator metric. e.g. "latency".

398

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

399

"a_key": "A String",

400

},

401

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

402

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

403

},

404

},

405

"displayLabel": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The displayed label of the metric.

406

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

407

"a_key": "A String",

408

},

409

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

410

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

411

},

412

"hasNonzeroData": True or False, # Whether the metric has any non-zero data.

413

"hotValue": 3.14, # The value that is considered hot for the metric. On a per metric basis hotness signals high utilization and something that might potentially be a cause for concern by the end user. hot_value is used to calibrate and scale visual color scales.

414

"indexedHotKeys": { # The (sparse) mapping from time index to an IndexedHotKey message, representing those time intervals for which there are hot keys.

415

"a_key": { # A message representing a (sparse) collection of hot keys for specific key buckets.

416

"sparseHotKeys": { # A (sparse) mapping from key bucket index to the index of the specific hot row key for that key bucket. The index of the hot row key can be translated to the actual row key via the ScanData.VisualizationData.indexed_keys repeated field.

"a_key": 42,

},

},

},

"indexedKeyRangeInfos": { # The (sparse) mapping from time interval index to an IndexedKeyRangeInfos message, representing those time intervals for which there are informational messages concerning key ranges.

422

"a_key": { # A message representing a (sparse) collection of KeyRangeInfos for specific key buckets.

423

"keyRangeInfos": { # A (sparse) mapping from key bucket index to the KeyRangeInfos for that key bucket.

424

"a_key": { # A message representing a list of specific information for multiple key ranges.

425

"infos": [ # The list individual KeyRangeInfos.

426

{ # A message representing information for a key range (possibly one key).

427

"contextValues": [ # The list of context values for this key range.

428

{ # A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.

429

"label": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The label for the context value. e.g. "latency".

430

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

431

"a_key": "A String",

432

},

433

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

434

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

435

},

436

"severity": "A String", # The severity of this context.

437

"unit": "A String", # The unit of the context value.

438

"value": 3.14, # The value for the context.

439

},

440

],

441

"endKeyIndex": 42, # The index of the end key in indexed_keys.

442

"info": { # A message representing a user-facing string whose value may need to be translated before being displayed. # Information about this key range, for all metrics.

443

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

444

"a_key": "A String",

445

},

446

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

447

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

448

},

449

"keysCount": "A String", # The number of keys this range covers.

450

"metric": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The name of the metric. e.g. "latency".

451

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

452

"a_key": "A String",

453

},

454

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

455

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

456

},

457

"startKeyIndex": 42, # The index of the start key in indexed_keys.

yoshi-code-bot

a933dad

2021-07-06 00:26:24 -0700

[diff] [blame^]

458

"timeOffset": "A String", # The time offset. This is the time since the start of the time interval.

yoshi-code-bot

227f8c9

2021-05-26 00:34:03 -0700

[diff] [blame]

459

"unit": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The unit of the metric. This is an unstructured field and will be mapped as is to the user.

460

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

461

"a_key": "A String",

462

},

463

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

464

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

465

},

466

"value": 3.14, # The value of the metric.

467

},

468

],

469

"totalSize": 42, # The total size of the list of all KeyRangeInfos. This may be larger than the number of repeated messages above. If that is the case, this number may be used to determine how many are not being shown.

},

},

},

},

"info": { # A message representing a user-facing string whose value may need to be translated before being displayed. # Information about the metric.

475

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

476

"a_key": "A String",

477

},

478

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

479

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

480

},

481

"matrix": { # A message representing a matrix of floats. # The data for the metric as a matrix.

482

"rows": [ # The rows of the matrix.

483

{ # A message representing a row of a matrix of floats.

484

"cols": [ # The columns of the row.

3.14,

],

},

],

},

"unit": { # A message representing a user-facing string whose value may need to be translated before being displayed. # The unit of the metric.

491

"args": { # A map of arguments used when creating the localized message. Keys represent parameter names which may be used by the localized version when substituting dynamic values.

492

"a_key": "A String",

493

},

494

"message": "A String", # The canonical English version of this message. If no token is provided or the front-end has no message associated with the token, this text will be displayed as-is.

495

"token": "A String", # The token identifying the message, e.g. 'METRIC_READ_CPU'. This should be unique within the service.

496

},

497

"visible": True or False, # Whether the metric is visible to the end user.

498

},

499

],

500

"prefixNodes": [ # The list of extracted key prefix nodes used in the key prefix hierarchy.

501

{ # A message representing a key prefix node in the key prefix hierarchy. for eg. Bigtable keyspaces are lexicographically ordered mappings of keys to values. Keys often have a shared prefix structure where users use the keys to organize data. Eg ///employee In this case Keysight will possibly use one node for a company and reuse it for all employees that fall under the company. Doing so improves legibility in the UI.

502

"dataSourceNode": True or False, # Whether this corresponds to a data_source name.

503

"depth": 42, # The depth in the prefix hierarchy.

504

"endIndex": 42, # The index of the end key bucket of the range that this node spans.

505

"startIndex": 42, # The index of the start key bucket of the range that this node spans.

506

"word": "A String", # The string represented by the prefix node.

},

],

},

"endTime": "A String", # The upper bound for when the contained data is defined.

511

"startTime": "A String", # A range of time (inclusive) for when the contained data is defined. The lower bound for when the contained data is defined.

512

},

513

"startTime": "A String", # A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined.

}</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

518

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

519

<pre>Lists Cloud Spanner databases.

520

521

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

522

parent: string, Required. The instance whose databases should be listed. Values are of the form `projects//instances/`. (required)

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

523

pageSize: integer, Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

524

pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

525

x__xgafv: string, V1 error format.

526

Allowed values

527

1 - v1 error format

528

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

529

530

Returns:

531

An object of the form:

532

533

{ # The response for ListDatabases.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

534

"databases": [ # Databases that matched the request.

535

{ # A Cloud Spanner database.

536

"createTime": "A String", # Output only. If exists, the time at which the database creation started.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

537

"earliestVersionTime": "A String", # Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

538

"encryptionConfig": { # Encryption configuration for a Cloud Spanner database. # Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty.

539

"kmsKeyName": "A String", # The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

540

},

541

"encryptionInfo": [ # Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as encryption state and the Cloud KMS key versions that are in use. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

542

{ # Encryption information for a Cloud Spanner database or backup.

543

"encryptionStatus": { # 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). # Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.

544

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

545

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

546

{

547

"a_key": "", # Properties of the object. Contains field @type with type URL.

548

},

549

],

550

"message": "A String", # 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.

551

},

552

"encryptionType": "A String", # Output only. The type of encryption.

553

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup.

554

},

555

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

556

"name": "A String", # 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.

557

"restoreInfo": { # Information about the database restore. # Output only. Applicable only for restored databases. Contains information about the restore source.

558

"backupInfo": { # Information about a backup. # Information about the backup used to restore the database. The backup may no longer exist.

559

"backup": "A String", # Name of the backup.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

560

"createTime": "A String", # The time the CreateBackup request was received.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

561

"sourceDatabase": "A String", # Name of the database the backup was created from.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

562

"versionTime": "A String", # The backup contains an externally consistent copy of `source_database` at the timestamp specified by `version_time`. If the CreateBackup request did not specify `version_time`, the `version_time` of the backup is equivalent to the `create_time`.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

563

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

564

"sourceType": "A String", # The type of the restore source.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

565

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

566

"state": "A String", # Output only. The current database state.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

567

"versionRetentionPeriod": "A String", # Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

568

},

569

],

570

"nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListDatabases call to fetch more of the matching databases.

571

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

576

<pre>Retrieves the next page of results.

577

578

Args:

579

previous_request: The request for the previous page. (required)

580

previous_response: The response from the request for the previous page. (required)

581

582

Returns:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

583

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

584

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

589

<code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

590

<pre>Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

591

592

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

593

parent: string, Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

594

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

595

The object takes the form of:

596

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

597

{ # The request for RestoreDatabase.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

598

"backup": "A String", # Name of the backup from which to restore. Values are of the form `projects//instances//backups/`.

599

"databaseId": "A String", # Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects//instances//databases/`.

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

600

"encryptionConfig": { # Encryption configuration for the restored database. # Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

601

"encryptionType": "A String", # Required. The encryption type of the restored database.

602

"kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

603

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

604

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

605

606

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

613

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

614

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

615

"done": 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.

616

"error": { # 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.

617

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

618

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

619

{

620

"a_key": "", # Properties of the object. Contains field @type with type URL.

621

},

622

],

623

"message": "A String", # 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.

624

},

625

"metadata": { # 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.

626

"a_key": "", # Properties of the object. Contains field @type with type URL.

627

},

628

"name": "A String", # 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}`.

629

"response": { # The normal response of the operation in case of success. 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`.

630

"a_key": "", # Properties of the object. Contains field @type with type URL.

631

},

632

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

637

<pre>Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

638

639

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

640

resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

641

body: object, The request body.

642

The object takes the form of:

643

644

{ # Request message for `SetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

645

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

646

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

647

{ # Associates `members` with a `role`.

648

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

649

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

650

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

651

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

652

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

653

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

654

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

655

"A String",

656

],

657

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

658

},

659

],

660

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

661

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

662

},

663

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

664

665

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

672

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

673

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

674

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

675

{ # Associates `members` with a `role`.

676

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

677

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

678

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

679

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

680

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

681

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

682

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

683

"A String",

684

],

685

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

686

},

687

],

688

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

689

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

690

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

695

<pre>Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

696

697

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

698

resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

699

body: object, The request body.

700

The object takes the form of:

701

702

{ # Request message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

703

"permissions": [ # REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.

704

"A String",

705

],

706

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

707

708

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

715

716

{ # Response message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

717

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

718

"A String",

719

],

720

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="updateDdl">updateDdl(database, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

725

<pre>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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

726

727

Args:

728

database: string, Required. The database to update. (required)

729

body: object, The request body.

730

The object takes the form of:

731

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

732

{ # Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

733

"operationId": "A String", # If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.

734

"statements": [ # Required. DDL statements to be applied to the database.

735

"A String",

736

],

737

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

738

739

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

746

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

747

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

748

"done": 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.

749

"error": { # 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.

750

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

751

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

752

{

753

"a_key": "", # Properties of the object. Contains field @type with type URL.

754

},

755

],

756

"message": "A String", # 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.

757

},

758

"metadata": { # 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.

759

"a_key": "", # Properties of the object. Contains field @type with type URL.

760

},

761

"name": "A String", # 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}`.

762

"response": { # The normal response of the operation in case of success. 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`.

763

"a_key": "", # Properties of the object. Contains field @type with type URL.

764

},

765

}</pre>

Sai Cheemalapati