Blame - docs/dyn/bigqueryconnection_v1beta1.projects.locations.connections.html - platform/external/python/google-api-python-client

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

[diff] [blame]

78

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

79

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

80

Bu Sun Kim

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

[diff] [blame]

81

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

82

<p class="firstline">Creates a new connection.</p>

83

84

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

85

<p class="firstline">Deletes connection and associated credential.</p>

86

87

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

88

<p class="firstline">Returns specified connection.</p>

89

90

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

91

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

Bu Sun Kim

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

[diff] [blame]

92

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Returns a list of connections in the given project.</p>

95

96

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

97

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

98

99

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

Dmitry Frenkel

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

[diff] [blame]

100

<p class="firstline">Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.</p>

Bu Sun Kim

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

[diff] [blame]

101

102

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

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>

Bu Sun Kim

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

[diff] [blame]

104

105

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

106

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

Bu Sun Kim

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

[diff] [blame]

107

108

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

109

<p class="firstline">Sets the credential for the specified connection.</p>

110

<h3>Method Details</h3>

111

Dmitry Frenkel

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

[diff] [blame]

112

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

113

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

117

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

118

<pre>Creates a new connection.

119

120

Args:

Dmitry Frenkel

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

[diff] [blame]

121

parent: string, Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` (required)

Bu Sun Kim

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

[diff] [blame]

122

body: object, The request body.

123

The object takes the form of:

124

Dmitry Frenkel

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

[diff] [blame]

125

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

126

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

127

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

128

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

129

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

130

"database": "A String", # Database name.

131

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

132

"password": "A String", # The password for the credential.

133

"username": "A String", # The username for the credential.

134

},

135

"type": "A String", # Type of the Cloud SQL database.

136

},

137

"creationTime": "A String", # Output only. The creation timestamp of the connection.

138

"friendlyName": "A String", # User provided display name for the connection.

139

"description": "A String", # User provided description.

140

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

141

}

Bu Sun Kim

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

[diff] [blame]

142

143

connectionId: string, Optional. Connection id that should be assigned to the created connection.

144

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

151

Dmitry Frenkel

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

[diff] [blame]

152

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

153

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

154

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

155

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

156

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

157

"database": "A String", # Database name.

158

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

159

"password": "A String", # The password for the credential.

160

"username": "A String", # The username for the credential.

161

},

162

"type": "A String", # Type of the Cloud SQL database.

163

},

164

"creationTime": "A String", # Output only. The creation timestamp of the connection.

165

"friendlyName": "A String", # User provided display name for the connection.

166

"description": "A String", # User provided description.

167

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

168

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

173

<pre>Deletes connection and associated credential.

174

175

Args:

Dmitry Frenkel

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

[diff] [blame]

176

name: string, Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

Bu Sun Kim

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

[diff] [blame]

177

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

184

Dmitry Frenkel

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

[diff] [blame]

185

{ # 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 `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

191

<pre>Returns specified connection.

192

193

Args:

Dmitry Frenkel

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

[diff] [blame]

194

name: string, Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

Bu Sun Kim

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

[diff] [blame]

195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

202

Dmitry Frenkel

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

[diff] [blame]

203

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

204

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

205

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

206

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

207

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

208

"database": "A String", # Database name.

209

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

210

"password": "A String", # The password for the credential.

211

"username": "A String", # The username for the credential.

212

},

213

"type": "A String", # Type of the Cloud SQL database.

214

},

215

"creationTime": "A String", # Output only. The creation timestamp of the connection.

216

"friendlyName": "A String", # User provided display name for the connection.

217

"description": "A String", # User provided description.

218

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

219

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

Dmitry Frenkel

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

[diff] [blame]

224

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Bu Sun Kim

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

[diff] [blame]

225

226

Args:

Dmitry Frenkel

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

[diff] [blame]

227

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

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

[diff] [blame]

228

body: object, The request body.

229

The object takes the form of:

230

231

{ # Request message for `GetIamPolicy` method.

Dmitry Frenkel

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

[diff] [blame]

232

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

233

"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).

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

244

Dmitry Frenkel

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

[diff] [blame]

245

{ # 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/).

Bu Sun Kim

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

[diff] [blame]

246

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Dmitry Frenkel

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

[diff] [blame]

247

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

248

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Dmitry Frenkel

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

[diff] [blame]

249

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

250

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

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

[diff] [blame]

251

"A String",

252

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

253

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

254

},

255

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

256

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

257

},

258

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

259

"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).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

260

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

261

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

262

"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`.

263

"A String",

264

],

265

"bindingId": "A String",

266

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

267

"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).

268

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

269

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

270

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

271

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

280

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

Bu Sun Kim

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

[diff] [blame]

281

<pre>Returns a list of connections in the given project.

282

283

Args:

Dmitry Frenkel

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

[diff] [blame]

284

parent: string, Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` (required)

Dmitry Frenkel

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

[diff] [blame]

285

pageToken: string, Page token.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

286

maxResults: integer, Required. Maximum number of results per page.

Bu Sun Kim

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

[diff] [blame]

287

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

294

295

{ # The response for ConnectionService.ListConnections.

Bu Sun Kim

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

[diff] [blame]

296

"connections": [ # List of connections.

Dmitry Frenkel

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

[diff] [blame]

297

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

298

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

299

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

300

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

301

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

302

"database": "A String", # Database name.

303

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

304

"password": "A String", # The password for the credential.

305

"username": "A String", # The username for the credential.

306

},

307

"type": "A String", # Type of the Cloud SQL database.

308

},

309

"creationTime": "A String", # Output only. The creation timestamp of the connection.

310

"friendlyName": "A String", # User provided display name for the connection.

311

"description": "A String", # User provided description.

312

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

313

},

Bu Sun Kim

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

[diff] [blame]

314

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

315

"nextPageToken": "A String", # Next page token.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

321

<pre>Retrieves the next page of results.

322

323

Args:

324

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

325

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

326

327

Returns:

328

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

329

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

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Dmitry Frenkel

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

[diff] [blame]

335

<pre>Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Bu Sun Kim

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

[diff] [blame]

336

337

Args:

Dmitry Frenkel

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

[diff] [blame]

338

name: string, Required. Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

Bu Sun Kim

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

[diff] [blame]

339

body: object, The request body.

340

The object takes the form of:

341

Dmitry Frenkel

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

[diff] [blame]

342

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

343

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

344

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

345

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

346

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

347

"database": "A String", # Database name.

348

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

349

"password": "A String", # The password for the credential.

350

"username": "A String", # The username for the credential.

351

},

352

"type": "A String", # Type of the Cloud SQL database.

353

},

354

"creationTime": "A String", # Output only. The creation timestamp of the connection.

355

"friendlyName": "A String", # User provided display name for the connection.

356

"description": "A String", # User provided description.

357

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

358

}

Bu Sun Kim

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

[diff] [blame]

359

360

updateMask: string, Required. Update mask for the connection fields to be updated.

361

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

368

Dmitry Frenkel

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

[diff] [blame]

369

{ # Configuration parameters to establish connection with an external data source, except the credential attributes.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

370

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

371

"name": "A String", # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

372

"cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.

373

"instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.

374

"database": "A String", # Database name.

375

"credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.

376

"password": "A String", # The password for the credential.

377

"username": "A String", # The username for the credential.

378

},

379

"type": "A String", # Type of the Cloud SQL database.

380

},

381

"creationTime": "A String", # Output only. The creation timestamp of the connection.

382

"friendlyName": "A String", # User provided display name for the connection.

383

"description": "A String", # User provided description.

384

"hasCredential": True or False, # Output only. True, if credential is configured for this connection.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

385

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -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]

390

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Bu Sun Kim

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

[diff] [blame]

391

392

Args:

Dmitry Frenkel

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

[diff] [blame]

393

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

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

[diff] [blame]

394

body: object, The request body.

395

The object takes the form of:

396

397

{ # Request message for `SetIamPolicy` method.

Dmitry Frenkel

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

[diff] [blame]

398

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

Bu Sun Kim

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

[diff] [blame]

399

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Dmitry Frenkel

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

[diff] [blame]

400

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

401

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Dmitry Frenkel

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

[diff] [blame]

402

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

403

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

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

[diff] [blame]

404

"A String",

405

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

406

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

407

},

408

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

409

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

410

},

411

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

412

"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).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

413

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

414

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

415

"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`.

416

"A String",

417

],

418

"bindingId": "A String",

419

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

420

"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).

421

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

422

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

423

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

424

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

429

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

430

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`

Bu Sun Kim

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

[diff] [blame]

431

}

432

433

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

440

Dmitry Frenkel

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

[diff] [blame]

441

{ # 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/).

Bu Sun Kim

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

[diff] [blame]

442

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Dmitry Frenkel

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

[diff] [blame]

443

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

444

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Dmitry Frenkel

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

[diff] [blame]

445

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

446

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

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

[diff] [blame]

447

"A String",

448

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

449

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

450

},

451

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

452

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

453

},

454

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

455

"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).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

456

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

457

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

458

"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`.

459

"A String",

460

],

461

"bindingId": "A String",

462

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

463

"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).

464

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

465

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

466

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

467

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

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

477

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Bu Sun Kim

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

[diff] [blame]

478

479

Args:

Dmitry Frenkel

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

[diff] [blame]

480

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

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

[diff] [blame]

481

body: object, The request body.

482

The object takes the form of:

483

484

{ # Request message for `TestIamPermissions` method.

Dmitry Frenkel

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

[diff] [blame]

485

"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

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

[diff] [blame]

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

497

498

{ # Response message for `TestIamPermissions` method.

Dmitry Frenkel

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

[diff] [blame]

499

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

}</pre>

</div>

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

507

<pre>Sets the credential for the specified connection.

508

509

Args:

Dmitry Frenkel

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

[diff] [blame]

510

name: string, Required. Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` (required)

Bu Sun Kim

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

[diff] [blame]

511

body: object, The request body.

512

The object takes the form of:

513

514

{ # Credential to use with a connection.

515

"cloudSql": { # Credential info for the Cloud SQL. # Credential for Cloud SQL database.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

516

"password": "A String", # The password for the credential.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

517

"username": "A String", # The username for the credential.

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

528

Dmitry Frenkel

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

[diff] [blame]

529

{ # 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 `{}`.

Bu Sun Kim