1<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="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="connectors_v1.projects.locations.connections.runtimeActionSchemas.html">runtimeActionSchemas()</a></code> 79</p> 80<p class="firstline">Returns the runtimeActionSchemas Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="connectors_v1.projects.locations.connections.runtimeEntitySchemas.html">runtimeEntitySchemas()</a></code> 84</p> 85<p class="firstline">Returns the runtimeEntitySchemas Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(parent, body=None, connectionId=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Creates a new Connection in a given project and location.</p> 93<p class="toc_element"> 94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Deletes a single Connection.</p> 96<p class="toc_element"> 97 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Gets details of a single Connection.</p> 99<p class="toc_element"> 100 <code><a href="#getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</a></code></p> 101<p class="firstline">Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.</p> 102<p class="toc_element"> 103 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 104<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> 105<p class="toc_element"> 106 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 107<p class="firstline">Lists Connections in a given project and location.</p> 108<p class="toc_element"> 109 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 110<p class="firstline">Retrieves the next page of results.</p> 111<p class="toc_element"> 112 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 113<p class="firstline">Updates the parameters of a single Connection.</p> 114<p class="toc_element"> 115 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 116<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> 117<p class="toc_element"> 118 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 119<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> 120<h3>Method Details</h3> 121<div class="method"> 122 <code class="details" id="close">close()</code> 123 <pre>Close httplib2 connections.</pre> 124</div> 125 126<div class="method"> 127 <code class="details" id="create">create(parent, body=None, connectionId=None, x__xgafv=None)</code> 128 <pre>Creates a new Connection in a given project and location. 129 130Args: 131 parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required) 132 body: object, The request body. 133 The object takes the form of: 134 135{ # Connection represents an instance of connector. 136 "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. 137 "additionalVariables": [ # List containing additional auth configs. 138 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 139 "boolValue": True or False, # Value is a bool. 140 "intValue": "A String", # Value is an integer 141 "key": "A String", # Key of the config variable. 142 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 143 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 144 }, 145 "stringValue": "A String", # Value is a string. 146 }, 147 ], 148 "authType": "A String", # The type of authentication configured. 149 "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. 150 "clientId": "A String", # The client identifier. 151 "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 152 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 153 }, 154 }, 155 "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. 156 "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. 157 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 158 }, 159 "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. 160 "audience": "A String", # Value for the "aud" claim. 161 "issuer": "A String", # Value for the "iss" claim. 162 "subject": "A String", # Value for the "sub" claim. 163 }, 164 }, 165 "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. 166 "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. 167 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 168 }, 169 "username": "A String", # Username. 170 }, 171 }, 172 "configVariables": [ # Optional. Configuration for configuring the connection with an external system. 173 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 174 "boolValue": True or False, # Value is a bool. 175 "intValue": "A String", # Value is an integer 176 "key": "A String", # Key of the config variable. 177 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 178 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 179 }, 180 "stringValue": "A String", # Value is a string. 181 }, 182 ], 183 "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* 184 "createTime": "A String", # Output only. Created time. 185 "description": "A String", # Optional. Description of the resource. 186 "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. 187 "A String", 188 ], 189 "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} 190 "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} 191 "inactive": True or False, # Optional. Inactive indicates the connection is active to use or not. 192 "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources 193 "a_key": "A String", 194 }, 195 "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited. 196 "locked": True or False, # Indicates whether or not the connection is locked. 197 "reason": "A String", # Describes why a connection is locked. 198 }, 199 "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} 200 "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources. 201 "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" 202 "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection. 203 "description": "A String", # Description. 204 "state": "A String", # State. 205 "status": "A String", # Status provides detailed information for the state. 206 }, 207 "updateTime": "A String", # Output only. Updated time. 208} 209 210 connectionId: string, Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource. 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { # This resource represents a long-running operation that is the result of a network API call. 220 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 221 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 222 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 223 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 224 { 225 "a_key": "", # Properties of the object. Contains field @type with type URL. 226 }, 227 ], 228 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 229 }, 230 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 231 "a_key": "", # Properties of the object. Contains field @type with type URL. 232 }, 233 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 234 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 235 "a_key": "", # Properties of the object. Contains field @type with type URL. 236 }, 237}</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 242 <pre>Deletes a single Connection. 243 244Args: 245 name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required) 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251Returns: 252 An object of the form: 253 254 { # This resource represents a long-running operation that is the result of a network API call. 255 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 256 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 257 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 258 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 259 { 260 "a_key": "", # Properties of the object. Contains field @type with type URL. 261 }, 262 ], 263 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 264 }, 265 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 266 "a_key": "", # Properties of the object. Contains field @type with type URL. 267 }, 268 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 269 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 270 "a_key": "", # Properties of the object. Contains field @type with type URL. 271 }, 272}</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> 277 <pre>Gets details of a single Connection. 278 279Args: 280 name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required) 281 view: string, Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view. 282 Allowed values 283 CONNECTION_VIEW_UNSPECIFIED - CONNECTION_UNSPECIFIED. 284 BASIC - Do not include runtime required configs. 285 FULL - Include runtime required configs. 286 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 { # Connection represents an instance of connector. 295 "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. 296 "additionalVariables": [ # List containing additional auth configs. 297 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 298 "boolValue": True or False, # Value is a bool. 299 "intValue": "A String", # Value is an integer 300 "key": "A String", # Key of the config variable. 301 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 302 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 303 }, 304 "stringValue": "A String", # Value is a string. 305 }, 306 ], 307 "authType": "A String", # The type of authentication configured. 308 "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. 309 "clientId": "A String", # The client identifier. 310 "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 311 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 312 }, 313 }, 314 "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. 315 "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. 316 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 317 }, 318 "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. 319 "audience": "A String", # Value for the "aud" claim. 320 "issuer": "A String", # Value for the "iss" claim. 321 "subject": "A String", # Value for the "sub" claim. 322 }, 323 }, 324 "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. 325 "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. 326 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 327 }, 328 "username": "A String", # Username. 329 }, 330 }, 331 "configVariables": [ # Optional. Configuration for configuring the connection with an external system. 332 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 333 "boolValue": True or False, # Value is a bool. 334 "intValue": "A String", # Value is an integer 335 "key": "A String", # Key of the config variable. 336 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 337 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 338 }, 339 "stringValue": "A String", # Value is a string. 340 }, 341 ], 342 "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* 343 "createTime": "A String", # Output only. Created time. 344 "description": "A String", # Optional. Description of the resource. 345 "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. 346 "A String", 347 ], 348 "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} 349 "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} 350 "inactive": True or False, # Optional. Inactive indicates the connection is active to use or not. 351 "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources 352 "a_key": "A String", 353 }, 354 "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited. 355 "locked": True or False, # Indicates whether or not the connection is locked. 356 "reason": "A String", # Describes why a connection is locked. 357 }, 358 "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} 359 "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources. 360 "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" 361 "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection. 362 "description": "A String", # Description. 363 "state": "A String", # State. 364 "status": "A String", # Status provides detailed information for the state. 365 }, 366 "updateTime": "A String", # Output only. Updated time. 367}</pre> 368</div> 369 370<div class="method"> 371 <code class="details" id="getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</code> 372 <pre>Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection. 373 374Args: 375 name: string, Required. Connection name Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required) 376 x__xgafv: string, V1 error format. 377 Allowed values 378 1 - v1 error format 379 2 - v2 error format 380 381Returns: 382 An object of the form: 383 384 { # Metadata of connection schema. 385 "actions": [ # Output only. List of actions. 386 "A String", 387 ], 388 "entities": [ # Output only. List of entity names. 389 "A String", 390 ], 391}</pre> 392</div> 393 394<div class="method"> 395 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 396 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 397 398Args: 399 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 400 options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 401 x__xgafv: string, V1 error format. 402 Allowed values 403 1 - v1 error format 404 2 - v2 error format 405 406Returns: 407 An object of the form: 408 409 { # 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`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 410 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 411 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 412 "auditLogConfigs": [ # The configuration for logging of each type of permission. 413 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 414 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 415 "A String", 416 ], 417 "logType": "A String", # The log type that this config enables. 418 }, 419 ], 420 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 421 }, 422 ], 423 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 424 { # Associates `members`, or principals, with a `role`. 425 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals 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). 426 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 427 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 428 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 429 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 430 }, 431 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 432 "A String", 433 ], 434 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 435 }, 436 ], 437 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 438 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 439}</pre> 440</div> 441 442<div class="method"> 443 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 444 <pre>Lists Connections in a given project and location. 445 446Args: 447 parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required) 448 filter: string, Filter. 449 orderBy: string, Order by parameters. 450 pageSize: integer, Page size. 451 pageToken: string, Page token. 452 view: string, Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view. 453 Allowed values 454 CONNECTION_VIEW_UNSPECIFIED - CONNECTION_UNSPECIFIED. 455 BASIC - Do not include runtime required configs. 456 FULL - Include runtime required configs. 457 x__xgafv: string, V1 error format. 458 Allowed values 459 1 - v1 error format 460 2 - v2 error format 461 462Returns: 463 An object of the form: 464 465 { # Response message for ConnectorsService.ListConnections 466 "connections": [ # Connections. 467 { # Connection represents an instance of connector. 468 "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. 469 "additionalVariables": [ # List containing additional auth configs. 470 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 471 "boolValue": True or False, # Value is a bool. 472 "intValue": "A String", # Value is an integer 473 "key": "A String", # Key of the config variable. 474 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 475 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 476 }, 477 "stringValue": "A String", # Value is a string. 478 }, 479 ], 480 "authType": "A String", # The type of authentication configured. 481 "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. 482 "clientId": "A String", # The client identifier. 483 "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 484 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 485 }, 486 }, 487 "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. 488 "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. 489 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 490 }, 491 "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. 492 "audience": "A String", # Value for the "aud" claim. 493 "issuer": "A String", # Value for the "iss" claim. 494 "subject": "A String", # Value for the "sub" claim. 495 }, 496 }, 497 "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. 498 "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. 499 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 500 }, 501 "username": "A String", # Username. 502 }, 503 }, 504 "configVariables": [ # Optional. Configuration for configuring the connection with an external system. 505 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 506 "boolValue": True or False, # Value is a bool. 507 "intValue": "A String", # Value is an integer 508 "key": "A String", # Key of the config variable. 509 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 510 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 511 }, 512 "stringValue": "A String", # Value is a string. 513 }, 514 ], 515 "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* 516 "createTime": "A String", # Output only. Created time. 517 "description": "A String", # Optional. Description of the resource. 518 "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. 519 "A String", 520 ], 521 "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} 522 "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} 523 "inactive": True or False, # Optional. Inactive indicates the connection is active to use or not. 524 "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources 525 "a_key": "A String", 526 }, 527 "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited. 528 "locked": True or False, # Indicates whether or not the connection is locked. 529 "reason": "A String", # Describes why a connection is locked. 530 }, 531 "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} 532 "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources. 533 "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" 534 "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection. 535 "description": "A String", # Description. 536 "state": "A String", # State. 537 "status": "A String", # Status provides detailed information for the state. 538 }, 539 "updateTime": "A String", # Output only. Updated time. 540 }, 541 ], 542 "nextPageToken": "A String", # Next page token. 543 "unreachable": [ # Locations that could not be reached. 544 "A String", 545 ], 546}</pre> 547</div> 548 549<div class="method"> 550 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 551 <pre>Retrieves the next page of results. 552 553Args: 554 previous_request: The request for the previous page. (required) 555 previous_response: The response from the request for the previous page. (required) 556 557Returns: 558 A request object that you can call 'execute()' on to request the next 559 page. Returns None if there are no more items in the collection. 560 </pre> 561</div> 562 563<div class="method"> 564 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 565 <pre>Updates the parameters of a single Connection. 566 567Args: 568 name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) 569 body: object, The request body. 570 The object takes the form of: 571 572{ # Connection represents an instance of connector. 573 "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. 574 "additionalVariables": [ # List containing additional auth configs. 575 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 576 "boolValue": True or False, # Value is a bool. 577 "intValue": "A String", # Value is an integer 578 "key": "A String", # Key of the config variable. 579 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 580 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 581 }, 582 "stringValue": "A String", # Value is a string. 583 }, 584 ], 585 "authType": "A String", # The type of authentication configured. 586 "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials. 587 "clientId": "A String", # The client identifier. 588 "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. 589 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 590 }, 591 }, 592 "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer. 593 "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. 594 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 595 }, 596 "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. 597 "audience": "A String", # Value for the "aud" claim. 598 "issuer": "A String", # Value for the "iss" claim. 599 "subject": "A String", # Value for the "sub" claim. 600 }, 601 }, 602 "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. 603 "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. 604 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 605 }, 606 "username": "A String", # Username. 607 }, 608 }, 609 "configVariables": [ # Optional. Configuration for configuring the connection with an external system. 610 { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. 611 "boolValue": True or False, # Value is a bool. 612 "intValue": "A String", # Value is an integer 613 "key": "A String", # Key of the config variable. 614 "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. 615 "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. 616 }, 617 "stringValue": "A String", # Value is a string. 618 }, 619 ], 620 "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* 621 "createTime": "A String", # Output only. Created time. 622 "description": "A String", # Optional. Description of the resource. 623 "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. 624 "A String", 625 ], 626 "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} 627 "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} 628 "inactive": True or False, # Optional. Inactive indicates the connection is active to use or not. 629 "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources 630 "a_key": "A String", 631 }, 632 "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited. 633 "locked": True or False, # Indicates whether or not the connection is locked. 634 "reason": "A String", # Describes why a connection is locked. 635 }, 636 "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} 637 "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources. 638 "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" 639 "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection. 640 "description": "A String", # Description. 641 "state": "A String", # State. 642 "status": "A String", # Status provides detailed information for the state. 643 }, 644 "updateTime": "A String", # Output only. Updated time. 645} 646 647 updateMask: string, Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. 648 x__xgafv: string, V1 error format. 649 Allowed values 650 1 - v1 error format 651 2 - v2 error format 652 653Returns: 654 An object of the form: 655 656 { # This resource represents a long-running operation that is the result of a network API call. 657 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 658 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 659 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 660 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 661 { 662 "a_key": "", # Properties of the object. Contains field @type with type URL. 663 }, 664 ], 665 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 666 }, 667 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 668 "a_key": "", # Properties of the object. Contains field @type with type URL. 669 }, 670 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 671 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 672 "a_key": "", # Properties of the object. Contains field @type with type URL. 673 }, 674}</pre> 675</div> 676 677<div class="method"> 678 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 679 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. 680 681Args: 682 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 683 body: object, The request body. 684 The object takes the form of: 685 686{ # Request message for `SetIamPolicy` method. 687 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. 688 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 689 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 690 "auditLogConfigs": [ # The configuration for logging of each type of permission. 691 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 692 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 693 "A String", 694 ], 695 "logType": "A String", # The log type that this config enables. 696 }, 697 ], 698 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 699 }, 700 ], 701 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 702 { # Associates `members`, or principals, with a `role`. 703 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals 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). 704 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 705 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 706 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 707 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 708 }, 709 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 710 "A String", 711 ], 712 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 713 }, 714 ], 715 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 716 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 717 }, 718 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` 719} 720 721 x__xgafv: string, V1 error format. 722 Allowed values 723 1 - v1 error format 724 2 - v2 error format 725 726Returns: 727 An object of the form: 728 729 { # 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`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 730 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 731 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 732 "auditLogConfigs": [ # The configuration for logging of each type of permission. 733 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 734 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 735 "A String", 736 ], 737 "logType": "A String", # The log type that this config enables. 738 }, 739 ], 740 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 741 }, 742 ], 743 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 744 { # Associates `members`, or principals, with a `role`. 745 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals 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). 746 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 747 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 748 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 749 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 750 }, 751 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 752 "A String", 753 ], 754 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 755 }, 756 ], 757 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 758 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 759}</pre> 760</div> 761 762<div class="method"> 763 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 764 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. 765 766Args: 767 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) 768 body: object, The request body. 769 The object takes the form of: 770 771{ # Request message for `TestIamPermissions` method. 772 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 773 "A String", 774 ], 775} 776 777 x__xgafv: string, V1 error format. 778 Allowed values 779 1 - v1 error format 780 2 - v2 error format 781 782Returns: 783 An object of the form: 784 785 { # Response message for `TestIamPermissions` method. 786 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 787 "A String", 788 ], 789}</pre> 790</div> 791 792</body></html>