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

<h1><a href="bigqueryconnection_v1beta1.html">BigQuery Connection API</a> . <a href="bigqueryconnection_v1beta1.projects.html">projects</a> . <a href="bigqueryconnection_v1beta1.projects.locations.html">locations</a> . <a href="bigqueryconnection_v1beta1.projects.locations.connections.html">connections</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

84

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

85

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

86

87

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

88

<p class="firstline">Gets the access control policy for a resource.</p>

89

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

90

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

Bu Sun Kim

6502091

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

[diff] [blame]

91

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

92

93

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

94

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

95

96

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

97

<p class="firstline">Updates the specified connection. For security reasons, also resets</p>

98

99

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

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

101

102

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

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

105

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

106

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

107

<h3>Method Details</h3>

108

109

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

110

<pre>Creates a new connection.

111

112

Args:

113

parent: string, Required. Parent resource name.

114

Must be in the format `projects/{project_id}/locations/{location_id}` (required)

115

body: object, The request body.

116

The object takes the form of:

117

118

{ # Configuration parameters to establish connection with an external data

119

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

120

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

Bu Sun Kim

6502091

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

[diff] [blame]

121

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

122

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

123

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

124

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

125

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

126

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

127

},

Bu Sun Kim

6502091

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

[diff] [blame]

128

},

129

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

130

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

131

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

132

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

133

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

134

"name": "A String", # The resource name of the connection in the form of:

135

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

136

}

137

138

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

139

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

146

147

{ # Configuration parameters to establish connection with an external data

148

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

149

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

Bu Sun Kim

6502091

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

[diff] [blame]

150

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

151

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

152

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

153

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

154

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

155

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

156

},

Bu Sun Kim

6502091

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

[diff] [blame]

157

},

158

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

159

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

160

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

161

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

162

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

163

"name": "A String", # The resource name of the connection in the form of:

164

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

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

170

<pre>Deletes connection and associated credential.

Args:

`projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

175

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

182

183

{ # A generic empty message that you can re-use to avoid defining duplicated

184

# empty messages in your APIs. A typical example is to use it as the request

185

# or the response type of an API method. For instance:

186

#

187

# service Foo {

188

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

189

# }

190

#

191

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

197

<pre>Returns specified connection.

Args:

`projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

202

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

209

210

{ # Configuration parameters to establish connection with an external data

211

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

212

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

Bu Sun Kim

6502091

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

[diff] [blame]

213

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

214

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

215

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

216

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

217

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

218

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

219

},

Bu Sun Kim

6502091

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

[diff] [blame]

220

},

221

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

222

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

223

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

224

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

225

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

226

"name": "A String", # The resource name of the connection in the form of:

227

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

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

233

<pre>Gets the access control policy for a resource.

234

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

239

See the operation documentation for the appropriate value for this field. (required)

240

body: object, The request body.

241

The object takes the form of:

242

243

{ # Request message for `GetIamPolicy` method.

244

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

245

# `GetIamPolicy`.

246

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

247

#

248

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

249

# rejected.

250

#

251

# Requests for policies with any conditional bindings must specify version 3.

252

# Policies without any conditional bindings may specify any valid value or

253

# leave the field unset.

254

#

255

# To learn which resources support conditions in their IAM policies, see the

256

# [IAM

257

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

268

269

{ # An Identity and Access Management (IAM) policy, which specifies access

270

# controls for Google Cloud resources.

271

#

272

#

273

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

274

# `members` to a single `role`. Members can be user accounts, service accounts,

275

# Google groups, and domains (such as G Suite). A `role` is a named list of

276

# permissions; each `role` can be an IAM predefined role or a user-created

277

# custom role.

278

#

279

# For some types of Google Cloud resources, a `binding` can also specify a

280

# `condition`, which is a logical expression that allows access to a resource

281

# only if the expression evaluates to `true`. A condition can add constraints

282

# based on attributes of the request, the resource, or both. To learn which

283

# resources support conditions in their IAM policies, see the

284

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

292

# "members": [

293

# "user:mike@example.com",

294

# "group:admins@example.com",

295

# "domain:google.com",

296

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

301

# "members": [

302

# "user:eve@example.com"

303

# ],

304

# "condition": {

305

# "title": "expirable access",

306

# "description": "Does not grant access after Sep 2020",

307

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

320

# - group:admins@example.com

321

# - domain:google.com

322

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

323

# role: roles/resourcemanager.organizationAdmin

324

# - members:

325

# - user:eve@example.com

326

# role: roles/resourcemanager.organizationViewer

327

# condition:

328

# title: expirable access

329

# description: Does not grant access after Sep 2020

330

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

331

# - etag: BwWWja0YfJA=

332

# - version: 3

333

#

334

# For a description of IAM and its features, see the

335

# [IAM documentation](https://cloud.google.com/iam/docs/).

336

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

337

# prevent simultaneous updates of a policy from overwriting each other.

338

# It is strongly suggested that systems make use of the `etag` in the

339

# read-modify-write cycle to perform policy updates in order to avoid race

340

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

341

# systems are expected to put that etag in the request to `setIamPolicy` to

342

# ensure that their change will be applied to the same version of the policy.

343

#

344

# **Important:** If you use IAM Conditions, you must include the `etag` field

345

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

346

# you to overwrite a version `3` policy with a version `1` policy, and all of

347

# the conditions in the version `3` policy are lost.

348

"version": 42, # Specifies the format of the policy.

349

#

350

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

351

# are rejected.

352

#

353

# Any operation that affects conditional role bindings must specify version

354

# `3`. This requirement applies to the following operations:

355

#

356

# * Getting a policy that includes a conditional role binding

357

# * Adding a conditional role binding to a policy

358

# * Changing a conditional role binding in a policy

359

# * Removing any role binding, with or without a condition, from a policy

360

# that includes conditions

361

#

362

# **Important:** If you use IAM Conditions, you must include the `etag` field

363

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

364

# you to overwrite a version `3` policy with a version `1` policy, and all of

365

# the conditions in the version `3` policy are lost.

366

#

367

# If a policy does not include any conditions, operations on that policy may

368

# specify any valid version or leave the field unset.

369

#

370

# To learn which resources support conditions in their IAM policies, see the

371

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

372

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

373

{ # Specifies the audit configuration for a service.

374

# The configuration determines which permission types are logged, and what

375

# identities, if any, are exempted from logging.

376

# An AuditConfig must have one or more AuditLogConfigs.

377

#

378

# If there are AuditConfigs for both `allServices` and a specific service,

379

# the union of the two AuditConfigs is used for that service: the log_types

380

# specified in each AuditConfig are enabled, and the exempted_members in each

381

# AuditLogConfig are exempted.

382

#

383

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

389

# "audit_log_configs": [

390

# {

391

# "log_type": "DATA_READ",

392

# "exempted_members": [

393

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

398

# },

399

# {

400

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

406

# "audit_log_configs": [

407

# {

408

# "log_type": "DATA_READ",

409

# },

410

# {

411

# "log_type": "DATA_WRITE",

412

# "exempted_members": [

413

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

422

# logging. It also exempts jose@example.com from DATA_READ logging, and

423

# aliya@example.com from DATA_WRITE logging.

424

"service": "A String", # Specifies a service that will be enabled for audit logging.

425

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

426

# `allServices` is a special value that covers all services.

427

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

428

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

433

# {

434

# "log_type": "DATA_READ",

435

# "exempted_members": [

436

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

446

# jose@example.com from DATA_READ logging.

447

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

448

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

449

# permission.

450

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

458

# `condition` that determines how and when the `bindings` are applied. Each

459

# of the `bindings` must contain at least one member.

460

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

461

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

462

#

463

# If the condition evaluates to `true`, then this binding applies to the

464

# current request.

465

#

466

# If the condition evaluates to `false`, then this binding does not apply to

467

# the current request. However, a different role binding might grant the same

468

# role to one or more of the members in this binding.

469

#

470

# To learn which resources support conditions in their IAM policies, see the

471

# [IAM

472

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

473

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

474

# are documented at https://github.com/google/cel-spec.

475

#

476

# Example (Comparison):

477

#

478

# title: "Summary size limit"

479

# description: "Determines if a summary is less than 100 chars"

480

# expression: "document.summary.size() < 100"

481

#

482

# Example (Equality):

483

#

484

# title: "Requestor is owner"

485

# description: "Determines if requestor is the document owner"

486

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

491

# description: "Determine whether the document should be publicly visible"

492

# expression: "document.type != 'private' && document.type != 'internal'"

493

#

494

# Example (Data Manipulation):

495

#

496

# title: "Notification string"

497

# description: "Create a notification string with a timestamp."

498

# expression: "'New message received at ' + string(document.create_time)"

499

#

500

# The exact variables and functions that may be referenced within an expression

501

# are determined by the service that evaluates it. See the service

502

# documentation for additional information.

503

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

504

# syntax.

505

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

506

# its purpose. This can be used e.g. in UIs which allow to enter the

507

# expression.

508

"location": "A String", # Optional. String indicating the location of the expression for error

509

# reporting, e.g. a file name and a position in the file.

510

"description": "A String", # Optional. Description of the expression. This is a longer text which

511

# describes the expression, e.g. when hovered over it in a UI.

512

},

513

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

514

# `members` can have the following values:

515

#

516

# * `allUsers`: A special identifier that represents anyone who is

517

# on the internet; with or without a Google account.

518

#

519

# * `allAuthenticatedUsers`: A special identifier that represents anyone

520

# who is authenticated with a Google account or a service account.

521

#

522

# * `user:{emailid}`: An email address that represents a specific Google

523

# account. For example, `alice@example.com` .

524

#

525

#

526

# * `serviceAccount:{emailid}`: An email address that represents a service

527

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

528

#

529

# * `group:{emailid}`: An email address that represents a Google group.

530

# For example, `admins@example.com`.

531

#

532

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

533

# identifier) representing a user that has been recently deleted. For

534

# example, `alice@example.com?uid=123456789012345678901`. If the user is

535

# recovered, this value reverts to `user:{emailid}` and the recovered user

536

# retains the role in the binding.

537

#

538

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

539

# unique identifier) representing a service account that has been recently

540

# deleted. For example,

541

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

542

# If the service account is undeleted, this value reverts to

543

# `serviceAccount:{emailid}` and the undeleted service account retains the

544

# role in the binding.

545

#

546

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

547

# identifier) representing a Google group that has been recently

548

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

549

# the group is recovered, this value reverts to `group:{emailid}` and the

550

# recovered group retains the role in the binding.

551

#

552

#

553

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

554

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

559

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

},

],

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

566

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

Bu Sun Kim

6502091

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

[diff] [blame]

567

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

568

569

Args:

570

parent: string, Required. Parent resource name.

571

Must be in the form: `projects/{project_id}/locations/{location_id}` (required)

Bu Sun Kim

6502091

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

[diff] [blame]

572

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

573

pageToken: string, Page token.

Bu Sun Kim

6502091

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

[diff] [blame]

574

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

581

582

{ # The response for ConnectionService.ListConnections.

583

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

584

"connections": [ # List of connections.

585

{ # Configuration parameters to establish connection with an external data

586

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

587

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

Bu Sun Kim

6502091

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

[diff] [blame]

588

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

589

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

590

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

591

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

592

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

593

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

594

},

Bu Sun Kim

6502091

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

[diff] [blame]

595

},

596

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

597

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

598

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

599

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

600

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

601

"name": "A String", # The resource name of the connection in the form of:

602

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

}</pre>

</div>

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

610

<pre>Retrieves the next page of results.

611

612

Args:

613

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

614

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

615

616

Returns:

617

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

618

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>

624

<pre>Updates the specified connection. For security reasons, also resets

625

credential if connection properties are in the update field mask.

Args:

`projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)

630

body: object, The request body.

631

The object takes the form of:

632

633

{ # Configuration parameters to establish connection with an external data

634

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

635

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

Bu Sun Kim

6502091

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

[diff] [blame]

636

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

637

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

638

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

639

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

640

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

641

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

642

},

Bu Sun Kim

6502091

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

[diff] [blame]

643

},

644

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

645

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

646

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

647

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

648

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

649

"name": "A String", # The resource name of the connection in the form of:

650

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

651

}

652

653

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

654

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

661

662

{ # Configuration parameters to establish connection with an external data

663

# source, except the credential attributes.

Bu Sun Kim

6502091

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

[diff] [blame]

664

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

Bu Sun Kim

6502091

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

[diff] [blame]

665

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

666

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

667

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

668

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

669

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

670

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

671

},

Bu Sun Kim

6502091

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

[diff] [blame]

672

},

673

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

674

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

675

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

676

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

677

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

678

"name": "A String", # The resource name of the connection in the form of:

679

# `projects/{project_id}/locations/{location_id}/connections/{connection_id}`

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

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

685

<pre>Sets the access control policy on the specified resource. Replaces any

686

existing policy.

687

688

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

689

690

Args:

691

resource: string, REQUIRED: The resource for which the policy is being specified.

692

See the operation documentation for the appropriate value for this field. (required)

693

body: object, The request body.

694

The object takes the form of:

695

696

{ # Request message for `SetIamPolicy` method.

697

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

698

# the policy is limited to a few 10s of KB. An empty policy is a

699

# valid policy but certain Cloud Platform services (such as Projects)

700

# might reject them.

701

# controls for Google Cloud resources.

702

#

703

#

704

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

705

# `members` to a single `role`. Members can be user accounts, service accounts,

706

# Google groups, and domains (such as G Suite). A `role` is a named list of

707

# permissions; each `role` can be an IAM predefined role or a user-created

708

# custom role.

709

#

710

# For some types of Google Cloud resources, a `binding` can also specify a

711

# `condition`, which is a logical expression that allows access to a resource

712

# only if the expression evaluates to `true`. A condition can add constraints

713

# based on attributes of the request, the resource, or both. To learn which

714

# resources support conditions in their IAM policies, see the

715

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

723

# "members": [

724

# "user:mike@example.com",

725

# "group:admins@example.com",

726

# "domain:google.com",

727

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

732

# "members": [

733

# "user:eve@example.com"

734

# ],

735

# "condition": {

736

# "title": "expirable access",

737

# "description": "Does not grant access after Sep 2020",

738

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

751

# - group:admins@example.com

752

# - domain:google.com

753

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

754

# role: roles/resourcemanager.organizationAdmin

755

# - members:

756

# - user:eve@example.com

757

# role: roles/resourcemanager.organizationViewer

758

# condition:

759

# title: expirable access

760

# description: Does not grant access after Sep 2020

761

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

762

# - etag: BwWWja0YfJA=

763

# - version: 3

764

#

765

# For a description of IAM and its features, see the

766

# [IAM documentation](https://cloud.google.com/iam/docs/).

767

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

768

# prevent simultaneous updates of a policy from overwriting each other.

769

# It is strongly suggested that systems make use of the `etag` in the

770

# read-modify-write cycle to perform policy updates in order to avoid race

771

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

772

# systems are expected to put that etag in the request to `setIamPolicy` to

773

# ensure that their change will be applied to the same version of the policy.

774

#

775

# **Important:** If you use IAM Conditions, you must include the `etag` field

776

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

777

# you to overwrite a version `3` policy with a version `1` policy, and all of

778

# the conditions in the version `3` policy are lost.

779

"version": 42, # Specifies the format of the policy.

780

#

781

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

782

# are rejected.

783

#

784

# Any operation that affects conditional role bindings must specify version

785

# `3`. This requirement applies to the following operations:

786

#

787

# * Getting a policy that includes a conditional role binding

788

# * Adding a conditional role binding to a policy

789

# * Changing a conditional role binding in a policy

790

# * Removing any role binding, with or without a condition, from a policy

791

# that includes conditions

792

#

793

# **Important:** If you use IAM Conditions, you must include the `etag` field

794

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

795

# you to overwrite a version `3` policy with a version `1` policy, and all of

796

# the conditions in the version `3` policy are lost.

797

#

798

# If a policy does not include any conditions, operations on that policy may

799

# specify any valid version or leave the field unset.

800

#

801

# To learn which resources support conditions in their IAM policies, see the

802

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

803

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

804

{ # Specifies the audit configuration for a service.

805

# The configuration determines which permission types are logged, and what

806

# identities, if any, are exempted from logging.

807

# An AuditConfig must have one or more AuditLogConfigs.

808

#

809

# If there are AuditConfigs for both `allServices` and a specific service,

810

# the union of the two AuditConfigs is used for that service: the log_types

811

# specified in each AuditConfig are enabled, and the exempted_members in each

812

# AuditLogConfig are exempted.

813

#

814

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

820

# "audit_log_configs": [

821

# {

822

# "log_type": "DATA_READ",

823

# "exempted_members": [

824

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

829

# },

830

# {

831

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

837

# "audit_log_configs": [

838

# {

839

# "log_type": "DATA_READ",

840

# },

841

# {

842

# "log_type": "DATA_WRITE",

843

# "exempted_members": [

844

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

853

# logging. It also exempts jose@example.com from DATA_READ logging, and

854

# aliya@example.com from DATA_WRITE logging.

855

"service": "A String", # Specifies a service that will be enabled for audit logging.

856

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

857

# `allServices` is a special value that covers all services.

858

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

859

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

864

# {

865

# "log_type": "DATA_READ",

866

# "exempted_members": [

867

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

877

# jose@example.com from DATA_READ logging.

878

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

879

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

880

# permission.

881

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

889

# `condition` that determines how and when the `bindings` are applied. Each

890

# of the `bindings` must contain at least one member.

891

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

892

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

893

#

894

# If the condition evaluates to `true`, then this binding applies to the

895

# current request.

896

#

897

# If the condition evaluates to `false`, then this binding does not apply to

898

# the current request. However, a different role binding might grant the same

899

# role to one or more of the members in this binding.

900

#

901

# To learn which resources support conditions in their IAM policies, see the

902

# [IAM

903

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

904

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

905

# are documented at https://github.com/google/cel-spec.

906

#

907

# Example (Comparison):

908

#

909

# title: "Summary size limit"

910

# description: "Determines if a summary is less than 100 chars"

911

# expression: "document.summary.size() < 100"

912

#

913

# Example (Equality):

914

#

915

# title: "Requestor is owner"

916

# description: "Determines if requestor is the document owner"

917

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

922

# description: "Determine whether the document should be publicly visible"

923

# expression: "document.type != 'private' && document.type != 'internal'"

924

#

925

# Example (Data Manipulation):

926

#

927

# title: "Notification string"

928

# description: "Create a notification string with a timestamp."

929

# expression: "'New message received at ' + string(document.create_time)"

930

#

931

# The exact variables and functions that may be referenced within an expression

932

# are determined by the service that evaluates it. See the service

933

# documentation for additional information.

934

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

935

# syntax.

936

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

937

# its purpose. This can be used e.g. in UIs which allow to enter the

938

# expression.

939

"location": "A String", # Optional. String indicating the location of the expression for error

940

# reporting, e.g. a file name and a position in the file.

941

"description": "A String", # Optional. Description of the expression. This is a longer text which

942

# describes the expression, e.g. when hovered over it in a UI.

943

},

944

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

945

# `members` can have the following values:

946

#

947

# * `allUsers`: A special identifier that represents anyone who is

948

# on the internet; with or without a Google account.

949

#

950

# * `allAuthenticatedUsers`: A special identifier that represents anyone

951

# who is authenticated with a Google account or a service account.

952

#

953

# * `user:{emailid}`: An email address that represents a specific Google

954

# account. For example, `alice@example.com` .

955

#

956

#

957

# * `serviceAccount:{emailid}`: An email address that represents a service

958

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

959

#

960

# * `group:{emailid}`: An email address that represents a Google group.

961

# For example, `admins@example.com`.

962

#

963

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

964

# identifier) representing a user that has been recently deleted. For

965

# example, `alice@example.com?uid=123456789012345678901`. If the user is

966

# recovered, this value reverts to `user:{emailid}` and the recovered user

967

# retains the role in the binding.

968

#

969

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

970

# unique identifier) representing a service account that has been recently

971

# deleted. For example,

972

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

973

# If the service account is undeleted, this value reverts to

974

# `serviceAccount:{emailid}` and the undeleted service account retains the

975

# role in the binding.

976

#

977

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

978

# identifier) representing a Google group that has been recently

979

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

980

# the group is recovered, this value reverts to `group:{emailid}` and the

981

# recovered group retains the role in the binding.

982

#

983

#

984

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

985

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

990

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

},

],

},

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

995

# the fields in the mask will be modified. If no mask is provided, the

996

# following default mask is used:

997

#

998

# `paths: "bindings, etag"`

999

}

1000

1001

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1008

1009

{ # An Identity and Access Management (IAM) policy, which specifies access

1010

# controls for Google Cloud resources.

1011

#

1012

#

1013

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1014

# `members` to a single `role`. Members can be user accounts, service accounts,

1015

# Google groups, and domains (such as G Suite). A `role` is a named list of

1016

# permissions; each `role` can be an IAM predefined role or a user-created

1017

# custom role.

1018

#

1019

# For some types of Google Cloud resources, a `binding` can also specify a

1020

# `condition`, which is a logical expression that allows access to a resource

1021

# only if the expression evaluates to `true`. A condition can add constraints

1022

# based on attributes of the request, the resource, or both. To learn which

1023

# resources support conditions in their IAM policies, see the

1024

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1032

# "members": [

1033

# "user:mike@example.com",

1034

# "group:admins@example.com",

1035

# "domain:google.com",

1036

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1041

# "members": [

1042

# "user:eve@example.com"

1043

# ],

1044

# "condition": {

1045

# "title": "expirable access",

1046

# "description": "Does not grant access after Sep 2020",

1047

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1060

# - group:admins@example.com

1061

# - domain:google.com

1062

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1063

# role: roles/resourcemanager.organizationAdmin

1064

# - members:

1065

# - user:eve@example.com

1066

# role: roles/resourcemanager.organizationViewer

1067

# condition:

1068

# title: expirable access

1069

# description: Does not grant access after Sep 2020

1070

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1071

# - etag: BwWWja0YfJA=

1072

# - version: 3

1073

#

1074

# For a description of IAM and its features, see the

1075

# [IAM documentation](https://cloud.google.com/iam/docs/).

1076

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1077

# prevent simultaneous updates of a policy from overwriting each other.

1078

# It is strongly suggested that systems make use of the `etag` in the

1079

# read-modify-write cycle to perform policy updates in order to avoid race

1080

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1081

# systems are expected to put that etag in the request to `setIamPolicy` to

1082

# ensure that their change will be applied to the same version of the policy.

1083

#

1084

# **Important:** If you use IAM Conditions, you must include the `etag` field

1085

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1086

# you to overwrite a version `3` policy with a version `1` policy, and all of

1087

# the conditions in the version `3` policy are lost.

1088

"version": 42, # Specifies the format of the policy.

1089

#

1090

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1091

# are rejected.

1092

#

1093

# Any operation that affects conditional role bindings must specify version

1094

# `3`. This requirement applies to the following operations:

1095

#

1096

# * Getting a policy that includes a conditional role binding

1097

# * Adding a conditional role binding to a policy

1098

# * Changing a conditional role binding in a policy

1099

# * Removing any role binding, with or without a condition, from a policy

1100

# that includes conditions

1101

#

1102

# **Important:** If you use IAM Conditions, you must include the `etag` field

1103

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1104

# you to overwrite a version `3` policy with a version `1` policy, and all of

1105

# the conditions in the version `3` policy are lost.

1106

#

1107

# If a policy does not include any conditions, operations on that policy may

1108

# specify any valid version or leave the field unset.

1109

#

1110

# To learn which resources support conditions in their IAM policies, see the

1111

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1112

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

1113

{ # Specifies the audit configuration for a service.

1114

# The configuration determines which permission types are logged, and what

1115

# identities, if any, are exempted from logging.

1116

# An AuditConfig must have one or more AuditLogConfigs.

1117

#

1118

# If there are AuditConfigs for both `allServices` and a specific service,

1119

# the union of the two AuditConfigs is used for that service: the log_types

1120

# specified in each AuditConfig are enabled, and the exempted_members in each

1121

# AuditLogConfig are exempted.

1122

#

1123

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1129

# "audit_log_configs": [

1130

# {

1131

# "log_type": "DATA_READ",

1132

# "exempted_members": [

1133

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1138

# },

1139

# {

1140

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

1146

# "audit_log_configs": [

1147

# {

1148

# "log_type": "DATA_READ",

1149

# },

1150

# {

1151

# "log_type": "DATA_WRITE",

1152

# "exempted_members": [

1153

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1162

# logging. It also exempts jose@example.com from DATA_READ logging, and

1163

# aliya@example.com from DATA_WRITE logging.

1164

"service": "A String", # Specifies a service that will be enabled for audit logging.

1165

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1166

# `allServices` is a special value that covers all services.

1167

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

1168

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1173

# {

1174

# "log_type": "DATA_READ",

1175

# "exempted_members": [

1176

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1186

# jose@example.com from DATA_READ logging.

1187

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

1188

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1189

# permission.

1190

# Follows the same format of Binding.members.

"A String",

],

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1198

# `condition` that determines how and when the `bindings` are applied. Each

1199

# of the `bindings` must contain at least one member.

1200

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

1201

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1202

#

1203

# If the condition evaluates to `true`, then this binding applies to the

1204

# current request.

1205

#

1206

# If the condition evaluates to `false`, then this binding does not apply to

1207

# the current request. However, a different role binding might grant the same

1208

# role to one or more of the members in this binding.

1209

#

1210

# To learn which resources support conditions in their IAM policies, see the

1211

# [IAM

1212

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1213

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1214

# are documented at https://github.com/google/cel-spec.

1215

#

1216

# Example (Comparison):

1217

#

1218

# title: "Summary size limit"

1219

# description: "Determines if a summary is less than 100 chars"

1220

# expression: "document.summary.size() < 100"

1221

#

1222

# Example (Equality):

1223

#

1224

# title: "Requestor is owner"

1225

# description: "Determines if requestor is the document owner"

1226

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1231

# description: "Determine whether the document should be publicly visible"

1232

# expression: "document.type != 'private' && document.type != 'internal'"

1233

#

1234

# Example (Data Manipulation):

1235

#

1236

# title: "Notification string"

1237

# description: "Create a notification string with a timestamp."

1238

# expression: "'New message received at ' + string(document.create_time)"

1239

#

1240

# The exact variables and functions that may be referenced within an expression

1241

# are determined by the service that evaluates it. See the service

1242

# documentation for additional information.

1243

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

1244

# syntax.

1245

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1246

# its purpose. This can be used e.g. in UIs which allow to enter the

1247

# expression.

1248

"location": "A String", # Optional. String indicating the location of the expression for error

1249

# reporting, e.g. a file name and a position in the file.

1250

"description": "A String", # Optional. Description of the expression. This is a longer text which

1251

# describes the expression, e.g. when hovered over it in a UI.

1252

},

1253

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1254

# `members` can have the following values:

1255

#

1256

# * `allUsers`: A special identifier that represents anyone who is

1257

# on the internet; with or without a Google account.

1258

#

1259

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1260

# who is authenticated with a Google account or a service account.

1261

#

1262

# * `user:{emailid}`: An email address that represents a specific Google

1263

# account. For example, `alice@example.com` .

1264

#

1265

#

1266

# * `serviceAccount:{emailid}`: An email address that represents a service

1267

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1268

#

1269

# * `group:{emailid}`: An email address that represents a Google group.

1270

# For example, `admins@example.com`.

1271

#

1272

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1273

# identifier) representing a user that has been recently deleted. For

1274

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1275

# recovered, this value reverts to `user:{emailid}` and the recovered user

1276

# retains the role in the binding.

1277

#

1278

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1279

# unique identifier) representing a service account that has been recently

1280

# deleted. For example,

1281

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1282

# If the service account is undeleted, this value reverts to

1283

# `serviceAccount:{emailid}` and the undeleted service account retains the

1284

# role in the binding.

1285

#

1286

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1287

# identifier) representing a Google group that has been recently

1288

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1289

# the group is recovered, this value reverts to `group:{emailid}` and the

1290

# recovered group retains the role in the binding.

1291

#

1292

#

1293

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1294

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

1299

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

},

],

}</pre>

</div>

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

1307

<pre>Returns permissions that a caller has on the specified resource.

1308

If the resource does not exist, this will return an empty set of

1309

permissions, not a `NOT_FOUND` error.

1310

1311

Note: This operation is designed to be used for building permission-aware

1312

UIs and command-line tools, not for authorization checking. This operation

1313

may "fail open" without warning.

1314

1315

Args:

1316

resource: string, REQUIRED: The resource for which the policy detail is being requested.

1317

See the operation documentation for the appropriate value for this field. (required)

1318

body: object, The request body.

1319

The object takes the form of:

1320

1321

{ # Request message for `TestIamPermissions` method.

1322

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1323

# wildcards (such as '*' or 'storage.*') are not allowed. For more

1324

# information see

1325

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1337

1338

{ # Response message for `TestIamPermissions` method.

1339

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

# allowed.

"A String",

],

}</pre>

</div>

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

1348

<pre>Sets the credential for the specified connection.

Args:

`projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` (required)

1353

body: object, The request body.

1354

The object takes the form of:

1355

1356

{ # Credential to use with a connection.

1357

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

Bu Sun Kim

6502091

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

[diff] [blame]

1358

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1359

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

Bu Sun Kim

6502091

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:

1370

1371

{ # A generic empty message that you can re-use to avoid defining duplicated

1372

# empty messages in your APIs. A typical example is to use it as the request

1373

# or the response type of an API method. For instance:

1374

#

1375

# service Foo {

1376

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1377

# }

1378

#

1379

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

</body></html>