Blame - docs/dyn/datafusion_v1.projects.locations.instances.html - platform/external/python/google-api-python-client

2021-01-15 07:10:04 -0800

[diff] [blame]

93

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

Dmitry Frenkel

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

[diff] [blame]

94

<p class="firstline">Lists Data Fusion instances in the specified project and location.</p>

95

96

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

97

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

98

99

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

100

<p class="firstline">Updates a single Data Fusion instance.</p>

101

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

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

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

112

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

113

<pre>Close httplib2 connections.</pre>

</div>

<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

120

Args:

121

parent: string, 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

129

"state": "A String", # The state of the accelerator

Yoshi Automation Bot

c2228be

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

[diff] [blame]

130

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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

"versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.

Dmitry Frenkel

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

[diff] [blame]

140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

141

],

142

"createTime": "A String", # Output only. The time the instance was created.

143

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

144

"description": "A String", # A description of this instance.

145

"displayName": "A String", # Display name for an instance.

146

"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.

147

"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.

148

"gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

149

"labels": { # The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels.

150

"a_key": "A String",

151

},

152

"name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

153

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

154

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

155

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

156

},

157

"options": { # Map of additional options used to configure the behavior of Data Fusion instance.

158

"a_key": "A String",

159

},

160

"p4ServiceAccount": "A String", # Output only. P4 service account for the customer project.

161

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

162

"serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

163

"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.

164

"state": "A String", # Output only. The current state of this Data Fusion instance.

165

"stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available.

166

"tenantProjectId": "A String", # Output only. The name of the tenant project.

167

"type": "A String", # Required. Instance type.

168

"updateTime": "A String", # Output only. The time the instance was last updated.

169

"version": "A String", # Current version of the Data Fusion. Only specifiable in Update.

170

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

171

}

Dmitry Frenkel

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

[diff] [blame]

172

173

instanceId: string, The name of the instance to create.

174

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

181

182

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

183

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

184

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

185

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

186

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

187

{

188

"a_key": "", # Properties of the object. Contains field @type with type URL.

189

},

190

],

191

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

192

},

193

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

194

"a_key": "", # Properties of the object. Contains field @type with type URL.

195

},

196

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

197

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

198

"a_key": "", # Properties of the object. Contains field @type with type URL.

199

},

200

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

205

<pre>Deletes a single Date Fusion instance.

206

207

Args:

208

name: string, The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} (required)

209

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

216

217

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

218

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

219

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

220

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

221

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

222

{

223

"a_key": "", # Properties of the object. Contains field @type with type URL.

224

},

225

],

226

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

227

},

228

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

229

"a_key": "", # Properties of the object. Contains field @type with type URL.

230

},

231

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

232

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

233

"a_key": "", # Properties of the object. Contains field @type with type URL.

234

},

235

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

240

<pre>Gets details of a single Data Fusion instance.

241

242

Args:

243

name: string, The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}. (required)

244

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

251

252

{ # Represents a Data Fusion instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

253

"accelerators": [ # List of accelerators enabled for this CDF instance.

254

{ # Identifies Data Fusion accelerators for an instance.

255

"acceleratorType": "A String", # The type of an accelator for a CDF instance.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

256

"state": "A String", # The state of the accelerator

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

257

},

258

],

259

"apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.

260

"availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest.

261

{ # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

262

"availableFeatures": [ # Represents a list of available feature names for a given version.

263

"A String",

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

264

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

265

"defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion

266

"versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.

267

},

268

],

269

"createTime": "A String", # Output only. The time the instance was created.

270

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

271

"description": "A String", # A description of this instance.

272

"displayName": "A String", # Display name for an instance.

273

"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.

274

"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.

275

"gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

276

"labels": { # The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels.

277

"a_key": "A String",

278

},

279

"name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

280

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

281

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

282

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

283

},

284

"options": { # Map of additional options used to configure the behavior of Data Fusion instance.

285

"a_key": "A String",

286

},

287

"p4ServiceAccount": "A String", # Output only. P4 service account for the customer project.

288

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

289

"serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

290

"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.

291

"state": "A String", # Output only. The current state of this Data Fusion instance.

292

"stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available.

293

"tenantProjectId": "A String", # Output only. The name of the tenant project.

294

"type": "A String", # Required. Instance type.

295

"updateTime": "A String", # Output only. The time the instance was last updated.

296

"version": "A String", # Current version of the Data Fusion. Only specifiable in Update.

297

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

298

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

303

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

304

305

Args:

306

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

307

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

308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

315

316

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

317

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

318

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

319

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

320

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

321

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

322

"A String",

323

],

324

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

325

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

326

],

327

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

328

},

329

],

330

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

331

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

332

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

333

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

334

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

335

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

336

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

337

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

338

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

339

"A String",

340

],

341

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

342

},

343

],

344

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

345

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

346

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

350

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

Dmitry Frenkel

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

[diff] [blame]

351

<pre>Lists Data Fusion instances in the specified project and location.

352

353

Args:

354

parent: string, 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)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

355

filter: string, List filter.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

356

orderBy: string, Sort results. Supported values are "name", "name desc", or "" (unsorted).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

357

pageSize: integer, The maximum number of items to return.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

358

pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.

Dmitry Frenkel

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

[diff] [blame]

359

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

366

367

{ # Response message for the list instance request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

368

"instances": [ # Represents a list of Data Fusion instances.

369

{ # Represents a Data Fusion instance.

370

"accelerators": [ # List of accelerators enabled for this CDF instance.

371

{ # Identifies Data Fusion accelerators for an instance.

372

"acceleratorType": "A String", # The type of an accelator for a CDF instance.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

373

"state": "A String", # The state of the accelerator

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

374

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

375

],

376

"apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.

377

"availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest.

378

{ # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

379

"availableFeatures": [ # Represents a list of available feature names for a given version.

380

"A String",

381

],

382

"defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion

383

"versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.

384

},

385

],

386

"createTime": "A String", # Output only. The time the instance was created.

387

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

388

"description": "A String", # A description of this instance.

389

"displayName": "A String", # Display name for an instance.

390

"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.

391

"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.

392

"gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

393

"labels": { # The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels.

394

"a_key": "A String",

395

},

396

"name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

397

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

398

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

399

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

400

},

401

"options": { # Map of additional options used to configure the behavior of Data Fusion instance.

402

"a_key": "A String",

403

},

404

"p4ServiceAccount": "A String", # Output only. P4 service account for the customer project.

405

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

406

"serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

407

"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.

408

"state": "A String", # Output only. The current state of this Data Fusion instance.

409

"stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available.

410

"tenantProjectId": "A String", # Output only. The name of the tenant project.

411

"type": "A String", # Required. Instance type.

412

"updateTime": "A String", # Output only. The time the instance was last updated.

413

"version": "A String", # Current version of the Data Fusion. Only specifiable in Update.

414

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

415

},

416

],

417

"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list.

418

"unreachable": [ # Locations that could not be reached.

419

"A String",

420

],

421

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

426

<pre>Retrieves the next page of results.

427

428

Args:

429

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

430

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

431

432

Returns:

433

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

434

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

</pre>

</div>

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

440

<pre>Updates a single Data Fusion instance.

441

442

Args:

443

name: string, Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. (required)

444

body: object, The request body.

445

The object takes the form of:

446

447

{ # Represents a Data Fusion instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

448

"accelerators": [ # List of accelerators enabled for this CDF instance.

449

{ # Identifies Data Fusion accelerators for an instance.

450

"acceleratorType": "A String", # The type of an accelator for a CDF instance.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

451

"state": "A String", # The state of the accelerator

Yoshi Automation Bot

c2228be

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

[diff] [blame]

452

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

453

],

454

"apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.

455

"availableVersion": [ # Available versions that the instance can be upgraded to using UpdateInstanceRequest.

456

{ # The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

457

"availableFeatures": [ # Represents a list of available feature names for a given version.

458

"A String",

459

],

460

"defaultVersion": True or False, # Whether this is currently the default version for Cloud Data Fusion

461

"versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.

Dmitry Frenkel

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

[diff] [blame]

462

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

463

],

464

"createTime": "A String", # Output only. The time the instance was created.

465

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

466

"description": "A String", # A description of this instance.

467

"displayName": "A String", # Display name for an instance.

468

"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.

469

"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.

470

"gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

471

"labels": { # The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels.

472

"a_key": "A String",

473

},

474

"name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

475

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

476

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

477

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

478

},

479

"options": { # Map of additional options used to configure the behavior of Data Fusion instance.

480

"a_key": "A String",

481

},

482

"p4ServiceAccount": "A String", # Output only. P4 service account for the customer project.

483

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

484

"serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

485

"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.

486

"state": "A String", # Output only. The current state of this Data Fusion instance.

487

"stateMessage": "A String", # Output only. Additional information about the current state of this Data Fusion instance if available.

488

"tenantProjectId": "A String", # Output only. The name of the tenant project.

489

"type": "A String", # Required. Instance type.

490

"updateTime": "A String", # Output only. The time the instance was last updated.

491

"version": "A String", # Current version of the Data Fusion. Only specifiable in Update.

492

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

493

}

Dmitry Frenkel

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

[diff] [blame]

494

495

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.

496

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

503

504

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

505

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

506

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

507

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

508

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

509

{

510

"a_key": "", # Properties of the object. Contains field @type with type URL.

511

},

512

],

513

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

514

},

515

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

516

"a_key": "", # Properties of the object. Contains field @type with type URL.

517

},

518

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

519

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

520

"a_key": "", # Properties of the object. Contains field @type with type URL.

521

},

522

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

527

<pre>Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

528

529

Args:

530

name: string, Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance} (required)

531

body: object, The request body.

532

The object takes the form of:

533

534

{ # Request message for restarting a Data Fusion instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

535

}

Dmitry Frenkel

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

[diff] [blame]

536

537

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

544

545

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

546

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

547

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

548

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

549

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

550

{

551

"a_key": "", # Properties of the object. Contains field @type with type URL.

552

},

553

],

554

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

555

},

556

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

557

"a_key": "", # Properties of the object. Contains field @type with type URL.

558

},

559

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

560

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

561

"a_key": "", # Properties of the object. Contains field @type with type URL.

562

},

563

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

568

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

569

570

Args:

571

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

572

body: object, The request body.

573

The object takes the form of:

574

575

{ # Request message for `SetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

576

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Dmitry Frenkel

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

[diff] [blame]

577

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

578

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

Dmitry Frenkel

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

[diff] [blame]

579

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

580

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

581

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

582

"A String",

583

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

584

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

Dmitry Frenkel

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

[diff] [blame]

585

},

586

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

587

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

Dmitry Frenkel

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

[diff] [blame]

588

},

589

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

590

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

591

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

592

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

593

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

594

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

595

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

596

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

597

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

598

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

599

"A String",

600

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

601

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

602

},

603

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

604

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

605

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

606

},

607

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

608

}

609

610

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

617

618

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

619

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

620

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

621

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

622

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

623

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

624

"A String",

625

],

626

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

627

},

628

],

629

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

630

},

631

],

632

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

633

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

634

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

635

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

636

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

637

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

638

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

639

},

640

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

641

"A String",

642

],

643

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

644

},

645

],

646

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

647

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

648

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

653

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

654

655

Args:

656

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)

657

body: object, The request body.

658

The object takes the form of:

659

660

{ # Request message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

661

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

662

"A String",

663

],

664

}

Dmitry Frenkel