blob: 4863ba73b26094e7c3c310a7392f1766e9da38db [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <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<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes connection and associated credential.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns specified connection.</p>
89<p class="toc_element">
90 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<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 Kim65020912020-05-20 12:08:20 -070092<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080093 <code><a href="#list">list(parent, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="firstline">Returns a list of connections in the given project.</p>
95<p class="toc_element">
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<p class="toc_element">
99 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<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 Kim65020912020-05-20 12:08:20 -0700101<p class="toc_element">
102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103<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 Kim65020912020-05-20 12:08:20 -0700104<p class="toc_element">
105 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106<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 Kim65020912020-05-20 12:08:20 -0700107<p class="toc_element">
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<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 <code class="details" id="close">close()</code>
113 <pre>Close httplib2 connections.</pre>
114</div>
115
116<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 <code class="details" id="create">create(parent, body=None, connectionId=None, x__xgafv=None)</code>
118 <pre>Creates a new connection.
119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 parent: string, Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700122 body: object, The request body.
123 The object takes the form of:
124
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125{ # Configuration parameters to establish connection with an external data source, except the credential attributes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800126 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800127 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
128 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
129 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
130 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800131 &quot;database&quot;: &quot;A String&quot;, # Database name.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800132 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800134 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800135 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800136 &quot;description&quot;: &quot;A String&quot;, # User provided description.
137 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800138 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800139 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
140 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800141}
Bu Sun Kim65020912020-05-20 12:08:20 -0700142
143 connectionId: string, Optional. Connection id that should be assigned to the created connection.
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152 { # Configuration parameters to establish connection with an external data source, except the credential attributes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
154 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
155 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
156 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800157 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800158 &quot;database&quot;: &quot;A String&quot;, # Database name.
159 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
160 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
161 },
162 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
163 &quot;description&quot;: &quot;A String&quot;, # User provided description.
164 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
165 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
166 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
167 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
168}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700169</div>
170
171<div class="method">
172 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
173 <pre>Deletes connection and associated credential.
174
175Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700176 name: string, Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800186}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700187</div>
188
189<div class="method">
190 <code class="details" id="get">get(name, x__xgafv=None)</code>
191 <pre>Returns specified connection.
192
193Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700194 name: string, Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700203 { # Configuration parameters to establish connection with an external data source, except the credential attributes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800204 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
205 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
206 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
207 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800208 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 &quot;database&quot;: &quot;A String&quot;, # Database name.
210 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
211 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
212 },
213 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
214 &quot;description&quot;: &quot;A String&quot;, # User provided description.
215 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
216 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
217 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
218 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
219}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700220</div>
221
222<div class="method">
223 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700224 <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 Kim65020912020-05-20 12:08:20 -0700225
226Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700227 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 Kim65020912020-05-20 12:08:20 -0700228 body: object, The request body.
229 The object takes the form of:
230
231{ # Request message for `GetIamPolicy` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 &quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
233 &quot;requestedPolicyVersion&quot;: 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).
234 },
235}
Bu Sun Kim65020912020-05-20 12:08:20 -0700236
237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242Returns:
243 An object of the form:
244
yoshi-code-bot96afc042021-08-24 00:22:31 -0700245 { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800246 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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.
248 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
249 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
250 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
251 &quot;A String&quot;,
252 ],
253 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800254 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800255 ],
256 &quot;service&quot;: &quot;A String&quot;, # 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.
257 },
258 ],
259 &quot;bindings&quot;: [ # 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.
260 { # Associates `members` with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
262 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
263 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
264 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
265 &quot;title&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800266 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 &quot;members&quot;: [ # 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`.
268 &quot;A String&quot;,
269 ],
270 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
271 },
272 ],
273 &quot;etag&quot;: &quot;A String&quot;, # `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.
274 &quot;version&quot;: 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).
275}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700276</div>
277
278<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800279 <code class="details" id="list">list(parent, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700280 <pre>Returns a list of connections in the given project.
281
282Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700283 parent: string, Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700284 maxResults: integer, Required. Maximum number of results per page.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800285 pageToken: string, Page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
290
291Returns:
292 An object of the form:
293
294 { # The response for ConnectionService.ListConnections.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800295 &quot;connections&quot;: [ # List of connections.
296 { # Configuration parameters to establish connection with an external data source, except the credential attributes.
297 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
298 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
299 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
300 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800301 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;database&quot;: &quot;A String&quot;, # Database name.
303 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
304 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800305 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800306 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
307 &quot;description&quot;: &quot;A String&quot;, # User provided description.
308 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
309 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
310 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
311 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
312 },
313 ],
314 &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
315}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700316</div>
317
318<div class="method">
319 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
320 <pre>Retrieves the next page of results.
321
322Args:
323 previous_request: The request for the previous page. (required)
324 previous_response: The response from the request for the previous page. (required)
325
326Returns:
327 A request object that you can call &#x27;execute()&#x27; on to request the next
328 page. Returns None if there are no more items in the collection.
329 </pre>
330</div>
331
332<div class="method">
333 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700334 <pre>Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
Bu Sun Kim65020912020-05-20 12:08:20 -0700335
336Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700337 name: string, Required. Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700338 body: object, The request body.
339 The object takes the form of:
340
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700341{ # Configuration parameters to establish connection with an external data source, except the credential attributes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800342 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800343 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
344 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
345 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
346 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800347 &quot;database&quot;: &quot;A String&quot;, # Database name.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800348 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800349 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800350 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800351 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800352 &quot;description&quot;: &quot;A String&quot;, # User provided description.
353 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800354 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800355 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
356 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800357}
Bu Sun Kim65020912020-05-20 12:08:20 -0700358
359 updateMask: string, Required. Update mask for the connection fields to be updated.
360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365Returns:
366 An object of the form:
367
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700368 { # Configuration parameters to establish connection with an external data source, except the credential attributes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;cloudSql&quot;: { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
370 &quot;credential&quot;: { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
371 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
372 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800373 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800374 &quot;database&quot;: &quot;A String&quot;, # Database name.
375 &quot;instanceId&quot;: &quot;A String&quot;, # Cloud SQL instance ID in the form `project:location:instance`.
376 &quot;type&quot;: &quot;A String&quot;, # Type of the Cloud SQL database.
377 },
378 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp of the connection.
379 &quot;description&quot;: &quot;A String&quot;, # User provided description.
380 &quot;friendlyName&quot;: &quot;A String&quot;, # User provided display name for the connection.
381 &quot;hasCredential&quot;: True or False, # Output only. True, if credential is configured for this connection.
382 &quot;lastModifiedTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp of the connection.
383 &quot;name&quot;: &quot;A String&quot;, # The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
384}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700385</div>
386
387<div class="method">
388 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700389 <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 Kim65020912020-05-20 12:08:20 -0700390
391Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700392 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 Kim65020912020-05-20 12:08:20 -0700393 body: object, The request body.
394 The object takes the form of:
395
396{ # Request message for `SetIamPolicy` method.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700397 &quot;policy&quot;: { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) 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 Kim65020912020-05-20 12:08:20 -0700398 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700399 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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 Kim65020912020-05-20 12:08:20 -0700400 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700401 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700402 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim65020912020-05-20 12:08:20 -0700403 &quot;A String&quot;,
404 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800405 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -0700406 },
407 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800408 &quot;service&quot;: &quot;A String&quot;, # 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 Kim65020912020-05-20 12:08:20 -0700409 },
410 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800411 &quot;bindings&quot;: [ # 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.
412 { # Associates `members` with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800413 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
414 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
415 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
416 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
417 &quot;title&quot;: &quot;A String&quot;, # 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.
418 },
419 &quot;members&quot;: [ # 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`.
420 &quot;A String&quot;,
421 ],
422 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
423 },
424 ],
425 &quot;etag&quot;: &quot;A String&quot;, # `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.
426 &quot;version&quot;: 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).
427 },
428 &quot;updateMask&quot;: &quot;A String&quot;, # 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: &quot;bindings, etag&quot;`
429}
430
431 x__xgafv: string, V1 error format.
432 Allowed values
433 1 - v1 error format
434 2 - v2 error format
435
436Returns:
437 An object of the form:
438
yoshi-code-bot96afc042021-08-24 00:22:31 -0700439 { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800440 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
441 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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.
442 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
443 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
444 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
445 &quot;A String&quot;,
446 ],
447 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
448 },
449 ],
450 &quot;service&quot;: &quot;A String&quot;, # 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.
451 },
452 ],
453 &quot;bindings&quot;: [ # 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.
454 { # Associates `members` with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800455 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
456 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
457 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
458 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
459 &quot;title&quot;: &quot;A String&quot;, # 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.
460 },
461 &quot;members&quot;: [ # 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`.
462 &quot;A String&quot;,
463 ],
464 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
465 },
466 ],
467 &quot;etag&quot;: &quot;A String&quot;, # `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.
468 &quot;version&quot;: 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).
469}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700470</div>
471
472<div class="method">
473 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700474 <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 &quot;fail open&quot; without warning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700475
476Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700477 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 Kim65020912020-05-20 12:08:20 -0700478 body: object, The request body.
479 The object takes the form of:
480
481{ # Request message for `TestIamPermissions` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800482 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
483 &quot;A String&quot;,
484 ],
485}
Bu Sun Kim65020912020-05-20 12:08:20 -0700486
487 x__xgafv: string, V1 error format.
488 Allowed values
489 1 - v1 error format
490 2 - v2 error format
491
492Returns:
493 An object of the form:
494
495 { # Response message for `TestIamPermissions` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800496 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
497 &quot;A String&quot;,
498 ],
499}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700500</div>
501
502<div class="method">
503 <code class="details" id="updateCredential">updateCredential(name, body=None, x__xgafv=None)</code>
504 <pre>Sets the credential for the specified connection.
505
506Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700507 name: string, Required. Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700508 body: object, The request body.
509 The object takes the form of:
510
511{ # Credential to use with a connection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800512 &quot;cloudSql&quot;: { # Credential info for the Cloud SQL. # Credential for Cloud SQL database.
513 &quot;password&quot;: &quot;A String&quot;, # The password for the credential.
514 &quot;username&quot;: &quot;A String&quot;, # The username for the credential.
515 },
516}
Bu Sun Kim65020912020-05-20 12:08:20 -0700517
518 x__xgafv: string, V1 error format.
519 Allowed values
520 1 - v1 error format
521 2 - v2 error format
522
523Returns:
524 An object of the form:
525
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700526 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800527}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700528</div>
529
530</body></html>