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="datafusion_v1.html">Cloud Data Fusion API</a> . <a href="datafusion_v1.projects.html">projects</a> . <a href="datafusion_v1.projects.locations.html">locations</a> . <a href="datafusion_v1.projects.locations.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new Data Fusion instance in the specified project and location.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a single Date Fusion instance.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets details of a single Data Fusion instance.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists Data Fusion instances in the specified project and location.</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> 100<p class="firstline">Updates a single Data Fusion instance.</p> 101<p class="toc_element"> 102 <code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.</p> 104<p class="toc_element"> 105 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 106<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> 107<p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 109<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> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="close">close()</code> 113 <pre>Close httplib2 connections.</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code> 118 <pre>Creates a new Data Fusion instance in the specified project and location. 119 120Args: 121 parent: string, Required. The instance's project and location in the format projects/{project}/locations/{location}. (required) 122 body: object, The request body. 123 The object takes the form of: 124 125{ # Represents a Data Fusion instance. 126 "accelerators": [ # List of accelerators enabled for this CDF instance. 127 { # Identifies Data Fusion accelerators for an instance. 128 "acceleratorType": "A String", # The type of an accelator for a CDF instance. 129 "state": "A String", # The state of the accelerator 130 }, 131 ], 132 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. 133 "availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest. 134 { # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade. 135 "availableFeatures": [ # Represents a list of available feature names for a given version. 136 "A String", 137 ], 138 "defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion 139 "type": "A String", # Type represents the release availability of the version 140 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. 141 }, 142 ], 143 "createTime": "A String", # Output only. The time the instance was created. 144 "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. 145 "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. 146 }, 147 "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. 148 "description": "A String", # A description of this instance. 149 "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. 150 "A String", 151 ], 152 "displayName": "A String", # Display name for an instance. 153 "enableRbac": True or False, # Option to enable granular role-based access control. 154 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. 155 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. 156 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. 157 "labels": { # The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. 158 "a_key": "A String", 159 }, 160 "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. 161 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. 162 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network. 163 "network": "A String", # Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network} 164 }, 165 "options": { # Map of additional options used to configure the behavior of Data Fusion instance. 166 "a_key": "A String", 167 }, 168 "p4ServiceAccount": "A String", # Output only. P4 service account for the customer project. 169 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. 170 "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. 171 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. 172 "state": "A String", # Output only. The current state of this Data Fusion instance. 173 "stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available. 174 "tenantProjectId": "A String", # Output only. The name of the tenant project. 175 "type": "A String", # Required. Instance type. 176 "updateTime": "A String", # Output only. The time the instance was last updated. 177 "version": "A String", # Current version of the Data Fusion. Only specifiable in Update. 178 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. 179} 180 181 instanceId: string, Required. The name of the instance to create. 182 x__xgafv: string, V1 error format. 183 Allowed values 184 1 - v1 error format 185 2 - v2 error format 186 187Returns: 188 An object of the form: 189 190 { # This resource represents a long-running operation that is the result of a network API call. 191 "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. 192 "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. 193 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 194 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 195 { 196 "a_key": "", # Properties of the object. Contains field @type with type URL. 197 }, 198 ], 199 "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. 200 }, 201 "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. 202 "a_key": "", # Properties of the object. Contains field @type with type URL. 203 }, 204 "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}`. 205 "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`. 206 "a_key": "", # Properties of the object. Contains field @type with type URL. 207 }, 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 213 <pre>Deletes a single Date Fusion instance. 214 215Args: 216 name: string, Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} (required) 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # This resource represents a long-running operation that is the result of a network API call. 226 "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. 227 "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. 228 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 229 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 230 { 231 "a_key": "", # Properties of the object. Contains field @type with type URL. 232 }, 233 ], 234 "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. 235 }, 236 "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. 237 "a_key": "", # Properties of the object. Contains field @type with type URL. 238 }, 239 "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}`. 240 "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`. 241 "a_key": "", # Properties of the object. Contains field @type with type URL. 242 }, 243}</pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="get">get(name, x__xgafv=None)</code> 248 <pre>Gets details of a single Data Fusion instance. 249 250Args: 251 name: string, Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}. (required) 252 x__xgafv: string, V1 error format. 253 Allowed values 254 1 - v1 error format 255 2 - v2 error format 256 257Returns: 258 An object of the form: 259 260 { # Represents a Data Fusion instance. 261 "accelerators": [ # List of accelerators enabled for this CDF instance. 262 { # Identifies Data Fusion accelerators for an instance. 263 "acceleratorType": "A String", # The type of an accelator for a CDF instance. 264 "state": "A String", # The state of the accelerator 265 }, 266 ], 267 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. 268 "availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest. 269 { # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade. 270 "availableFeatures": [ # Represents a list of available feature names for a given version. 271 "A String", 272 ], 273 "defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion 274 "type": "A String", # Type represents the release availability of the version 275 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. 276 }, 277 ], 278 "createTime": "A String", # Output only. The time the instance was created. 279 "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. 280 "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. 281 }, 282 "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. 283 "description": "A String", # A description of this instance. 284 "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. 285 "A String", 286 ], 287 "displayName": "A String", # Display name for an instance. 288 "enableRbac": True or False, # Option to enable granular role-based access control. 289 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. 290 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. 291 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. 292 "labels": { # The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. 293 "a_key": "A String", 294 }, 295 "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. 296 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. 297 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network. 298 "network": "A String", # Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network} 299 }, 300 "options": { # Map of additional options used to configure the behavior of Data Fusion instance. 301 "a_key": "A String", 302 }, 303 "p4ServiceAccount": "A String", # Output only. P4 service account for the customer project. 304 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. 305 "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. 306 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. 307 "state": "A String", # Output only. The current state of this Data Fusion instance. 308 "stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available. 309 "tenantProjectId": "A String", # Output only. The name of the tenant project. 310 "type": "A String", # Required. Instance type. 311 "updateTime": "A String", # Output only. The time the instance was last updated. 312 "version": "A String", # Current version of the Data Fusion. Only specifiable in Update. 313 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. 314}</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 319 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 320 321Args: 322 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 323 options_requestedPolicyVersion: integer, 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). 324 x__xgafv: string, V1 error format. 325 Allowed values 326 1 - v1 error format 327 2 - v2 error format 328 329Returns: 330 An object of the form: 331 332 { # 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/). 333 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 334 { # 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. 335 "auditLogConfigs": [ # The configuration for logging of each type of permission. 336 { # 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. 337 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 338 "A String", 339 ], 340 "logType": "A String", # The log type that this config enables. 341 }, 342 ], 343 "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. 344 }, 345 ], 346 "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`. 347 { # Associates `members`, or principals, with a `role`. 348 "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). 349 "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. 350 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 351 "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. 352 "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. 353 }, 354 "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`. 355 "A String", 356 ], 357 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 358 }, 359 ], 360 "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. 361 "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). 362}</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 367 <pre>Lists Data Fusion instances in the specified project and location. 368 369Args: 370 parent: string, Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated. (required) 371 filter: string, List filter. 372 orderBy: string, Sort results. Supported values are "name", "name desc", or "" (unsorted). 373 pageSize: integer, The maximum number of items to return. 374 pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request. 375 x__xgafv: string, V1 error format. 376 Allowed values 377 1 - v1 error format 378 2 - v2 error format 379 380Returns: 381 An object of the form: 382 383 { # Response message for the list instance request. 384 "instances": [ # Represents a list of Data Fusion instances. 385 { # Represents a Data Fusion instance. 386 "accelerators": [ # List of accelerators enabled for this CDF instance. 387 { # Identifies Data Fusion accelerators for an instance. 388 "acceleratorType": "A String", # The type of an accelator for a CDF instance. 389 "state": "A String", # The state of the accelerator 390 }, 391 ], 392 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. 393 "availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest. 394 { # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade. 395 "availableFeatures": [ # Represents a list of available feature names for a given version. 396 "A String", 397 ], 398 "defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion 399 "type": "A String", # Type represents the release availability of the version 400 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. 401 }, 402 ], 403 "createTime": "A String", # Output only. The time the instance was created. 404 "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. 405 "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. 406 }, 407 "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. 408 "description": "A String", # A description of this instance. 409 "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. 410 "A String", 411 ], 412 "displayName": "A String", # Display name for an instance. 413 "enableRbac": True or False, # Option to enable granular role-based access control. 414 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. 415 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. 416 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. 417 "labels": { # The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. 418 "a_key": "A String", 419 }, 420 "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. 421 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. 422 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network. 423 "network": "A String", # Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network} 424 }, 425 "options": { # Map of additional options used to configure the behavior of Data Fusion instance. 426 "a_key": "A String", 427 }, 428 "p4ServiceAccount": "A String", # Output only. P4 service account for the customer project. 429 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. 430 "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. 431 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. 432 "state": "A String", # Output only. The current state of this Data Fusion instance. 433 "stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available. 434 "tenantProjectId": "A String", # Output only. The name of the tenant project. 435 "type": "A String", # Required. Instance type. 436 "updateTime": "A String", # Output only. The time the instance was last updated. 437 "version": "A String", # Current version of the Data Fusion. Only specifiable in Update. 438 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. 439 }, 440 ], 441 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. 442 "unreachable": [ # Locations that could not be reached. 443 "A String", 444 ], 445}</pre> 446</div> 447 448<div class="method"> 449 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 450 <pre>Retrieves the next page of results. 451 452Args: 453 previous_request: The request for the previous page. (required) 454 previous_response: The response from the request for the previous page. (required) 455 456Returns: 457 A request object that you can call 'execute()' on to request the next 458 page. Returns None if there are no more items in the collection. 459 </pre> 460</div> 461 462<div class="method"> 463 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 464 <pre>Updates a single Data Fusion instance. 465 466Args: 467 name: string, Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. (required) 468 body: object, The request body. 469 The object takes the form of: 470 471{ # Represents a Data Fusion instance. 472 "accelerators": [ # List of accelerators enabled for this CDF instance. 473 { # Identifies Data Fusion accelerators for an instance. 474 "acceleratorType": "A String", # The type of an accelator for a CDF instance. 475 "state": "A String", # The state of the accelerator 476 }, 477 ], 478 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible. 479 "availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest. 480 { # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade. 481 "availableFeatures": [ # Represents a list of available feature names for a given version. 482 "A String", 483 ], 484 "defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion 485 "type": "A String", # Type represents the release availability of the version 486 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'. 487 }, 488 ], 489 "createTime": "A String", # Output only. The time the instance was created. 490 "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. 491 "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. 492 }, 493 "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. 494 "description": "A String", # A description of this instance. 495 "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. 496 "A String", 497 ], 498 "displayName": "A String", # Display name for an instance. 499 "enableRbac": True or False, # Option to enable granular role-based access control. 500 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging. 501 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. 502 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project. 503 "labels": { # The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. 504 "a_key": "A String", 505 }, 506 "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. 507 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. 508 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network. 509 "network": "A String", # Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network} 510 }, 511 "options": { # Map of additional options used to configure the behavior of Data Fusion instance. 512 "a_key": "A String", 513 }, 514 "p4ServiceAccount": "A String", # Output only. P4 service account for the customer project. 515 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. 516 "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. 517 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible. 518 "state": "A String", # Output only. The current state of this Data Fusion instance. 519 "stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available. 520 "tenantProjectId": "A String", # Output only. The name of the tenant project. 521 "type": "A String", # Required. Instance type. 522 "updateTime": "A String", # Output only. The time the instance was last updated. 523 "version": "A String", # Current version of the Data Fusion. Only specifiable in Update. 524 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. 525} 526 527 updateMask: string, Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels, options, and version currently) will be overwritten. 528 x__xgafv: string, V1 error format. 529 Allowed values 530 1 - v1 error format 531 2 - v2 error format 532 533Returns: 534 An object of the form: 535 536 { # This resource represents a long-running operation that is the result of a network API call. 537 "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. 538 "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. 539 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 540 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 541 { 542 "a_key": "", # Properties of the object. Contains field @type with type URL. 543 }, 544 ], 545 "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. 546 }, 547 "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. 548 "a_key": "", # Properties of the object. Contains field @type with type URL. 549 }, 550 "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}`. 551 "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`. 552 "a_key": "", # Properties of the object. Contains field @type with type URL. 553 }, 554}</pre> 555</div> 556 557<div class="method"> 558 <code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code> 559 <pre>Restart a single Data Fusion instance. At the end of an operation instance is fully restarted. 560 561Args: 562 name: string, Required. Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance} (required) 563 body: object, The request body. 564 The object takes the form of: 565 566{ # Request message for restarting a Data Fusion instance. 567} 568 569 x__xgafv: string, V1 error format. 570 Allowed values 571 1 - v1 error format 572 2 - v2 error format 573 574Returns: 575 An object of the form: 576 577 { # This resource represents a long-running operation that is the result of a network API call. 578 "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. 579 "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. 580 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 581 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 582 { 583 "a_key": "", # Properties of the object. Contains field @type with type URL. 584 }, 585 ], 586 "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. 587 }, 588 "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. 589 "a_key": "", # Properties of the object. Contains field @type with type URL. 590 }, 591 "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}`. 592 "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`. 593 "a_key": "", # Properties of the object. Contains field @type with type URL. 594 }, 595}</pre> 596</div> 597 598<div class="method"> 599 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 600 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. 601 602Args: 603 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 604 body: object, The request body. 605 The object takes the form of: 606 607{ # Request message for `SetIamPolicy` method. 608 "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. 609 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 610 { # 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. 611 "auditLogConfigs": [ # The configuration for logging of each type of permission. 612 { # 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. 613 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 614 "A String", 615 ], 616 "logType": "A String", # The log type that this config enables. 617 }, 618 ], 619 "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. 620 }, 621 ], 622 "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`. 623 { # Associates `members`, or principals, with a `role`. 624 "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). 625 "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. 626 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 627 "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. 628 "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. 629 }, 630 "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`. 631 "A String", 632 ], 633 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 634 }, 635 ], 636 "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. 637 "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). 638 }, 639 "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"` 640} 641 642 x__xgafv: string, V1 error format. 643 Allowed values 644 1 - v1 error format 645 2 - v2 error format 646 647Returns: 648 An object of the form: 649 650 { # 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/). 651 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 652 { # 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. 653 "auditLogConfigs": [ # The configuration for logging of each type of permission. 654 { # 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. 655 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 656 "A String", 657 ], 658 "logType": "A String", # The log type that this config enables. 659 }, 660 ], 661 "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. 662 }, 663 ], 664 "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`. 665 { # Associates `members`, or principals, with a `role`. 666 "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). 667 "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. 668 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 669 "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. 670 "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. 671 }, 672 "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`. 673 "A String", 674 ], 675 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 676 }, 677 ], 678 "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. 679 "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). 680}</pre> 681</div> 682 683<div class="method"> 684 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 685 <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. 686 687Args: 688 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) 689 body: object, The request body. 690 The object takes the form of: 691 692{ # Request message for `TestIamPermissions` method. 693 "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). 694 "A String", 695 ], 696} 697 698 x__xgafv: string, V1 error format. 699 Allowed values 700 1 - v1 error format 701 2 - v2 error format 702 703Returns: 704 An object of the form: 705 706 { # Response message for `TestIamPermissions` method. 707 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 708 "A String", 709 ], 710}</pre> 711</div> 712 713</body></html>