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

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

[diff] [blame^]

93

<code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=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

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

[diff] [blame^]

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

"a_key": "A String",

136

},

137

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

138

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

139

{ # Identifies Data Fusion accelerators for an instance.

140

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

Yoshi Automation Bot

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

[diff] [blame]

141

},

Yoshi Automation Bot

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

[diff] [blame^]

142

],

143

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

144

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

145

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

146

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

147

"A String",

148

],

149

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

Dmitry Frenkel

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

[diff] [blame]

150

},

Yoshi Automation Bot

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

[diff] [blame^]

151

],

152

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

153

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

154

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

155

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

156

"a_key": "A String",

157

},

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

},

167

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

168

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

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

}

Dmitry Frenkel

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

[diff] [blame]

171

172

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

173

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

180

181

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

Yoshi Automation Bot

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

[diff] [blame^]

182

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

Yoshi Automation Bot

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

[diff] [blame]

183

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

184

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

185

},

Dmitry Frenkel

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

[diff] [blame]

186

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

Dmitry Frenkel

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

[diff] [blame]

187

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

188

{

189

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

190

},

191

],

Yoshi Automation Bot

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

[diff] [blame^]

192

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

193

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

Dmitry Frenkel

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

[diff] [blame]

194

},

195

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

196

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

197

},

Yoshi Automation Bot

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

[diff] [blame^]

198

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

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

204

<pre>Deletes a single Date Fusion instance.

205

206

Args:

207

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

208

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

215

216

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

Yoshi Automation Bot

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

[diff] [blame^]

217

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

Yoshi Automation Bot

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

[diff] [blame]

218

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

219

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

220

},

Dmitry Frenkel

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

[diff] [blame]

221

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

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

[diff] [blame]

222

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

223

{

224

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

225

},

226

],

Yoshi Automation Bot

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

[diff] [blame^]

227

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

228

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

Dmitry Frenkel

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

[diff] [blame]

229

},

230

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

231

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

232

},

Yoshi Automation Bot

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

[diff] [blame^]

233

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

239

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

240

241

Args:

242

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

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

{ # Represents a Data Fusion instance.

Yoshi Automation Bot

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

[diff] [blame^]

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

"a_key": "A String",

262

},

263

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

264

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

265

{ # Identifies Data Fusion accelerators for an instance.

266

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

Yoshi Automation Bot

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

[diff] [blame]

267

},

Yoshi Automation Bot

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

[diff] [blame^]

268

],

269

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

270

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

271

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

272

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

273

"A String",

274

],

275

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

Dmitry Frenkel

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

[diff] [blame]

276

},

Yoshi Automation Bot

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

[diff] [blame^]

277

],

278

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

279

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

280

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

281

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

282

"a_key": "A String",

283

},

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

},

293

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

294

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

295

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

296

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

301

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

302

303

Args:

304

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

305

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

306

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

313

314

{ # 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

2020-11-25 07:50:41 -0800

[diff] [blame]

315

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

Dmitry Frenkel

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

[diff] [blame]

316

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

317

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

318

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

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

],

Yoshi Automation Bot

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

[diff] [blame^]

324

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

Dmitry Frenkel

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

[diff] [blame]

},

],

},

],

Yoshi Automation Bot

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

[diff] [blame^]

329

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

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

332

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

333

"A String",

334

],

335

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

336

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

337

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

338

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

339

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

340

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

341

},

342

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

343

},

344

],

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

349

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

Dmitry Frenkel

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

[diff] [blame]

350

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

351

352

Args:

353

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)

354

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

355

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

Yoshi Automation Bot

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

[diff] [blame^]

356

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

357

filter: string, List filter.

Dmitry Frenkel

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

[diff] [blame]

358

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

365

366

{ # Response message for the list instance request.

Yoshi Automation Bot

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

[diff] [blame^]

367

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

368

{ # Represents a Data Fusion instance.

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

"a_key": "A String",

379

},

380

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

381

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

382

{ # Identifies Data Fusion accelerators for an instance.

383

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

384

},

385

],

386

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

387

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

388

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

389

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

390

"A String",

391

],

392

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

393

},

394

],

395

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

396

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

397

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

398

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

399

"a_key": "A String",

400

},

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

},

410

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

411

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

412

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

413

},

414

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

415

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

Yoshi Automation Bot

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

[diff] [blame]

416

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

417

"A String",

418

],

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

424

<pre>Retrieves the next page of results.

425

426

Args:

427

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

428

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

429

430

Returns:

431

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

432

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>

438

<pre>Updates a single Data Fusion instance.

439

440

Args:

441

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

442

body: object, The request body.

443

The object takes the form of:

444

445

{ # Represents a Data Fusion instance.

Yoshi Automation Bot

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

[diff] [blame^]

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

"a_key": "A String",

456

},

457

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

458

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

459

{ # Identifies Data Fusion accelerators for an instance.

460

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

Yoshi Automation Bot

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

[diff] [blame]

461

},

Yoshi Automation Bot

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

[diff] [blame^]

462

],

463

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

464

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

465

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

466

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

467

"A String",

468

],

469

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

Dmitry Frenkel

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

[diff] [blame]

470

},

Yoshi Automation Bot

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

[diff] [blame^]

471

],

472

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

473

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

474

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

475

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

476

"a_key": "A String",

477

},

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

},

487

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

488

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

489

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

490

}

Dmitry Frenkel

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

[diff] [blame]

491

492

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.

493

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

500

501

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

Yoshi Automation Bot

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

[diff] [blame^]

502

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

Yoshi Automation Bot

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

[diff] [blame]

503

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

504

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

505

},

Dmitry Frenkel

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

[diff] [blame]

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.

Dmitry Frenkel

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

[diff] [blame]

507

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

508

{

509

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

510

},

511

],

Yoshi Automation Bot

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

[diff] [blame^]

512

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

513

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

Dmitry Frenkel

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

[diff] [blame]

514

},

515

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

516

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

517

},

Yoshi Automation Bot

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

[diff] [blame^]

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

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

524

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

525

526

Args:

527

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

528

body: object, The request body.

529

The object takes the form of:

530

531

{ # Request message for restarting a Data Fusion instance.

532

}

533

534

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

541

542

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

Yoshi Automation Bot

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

[diff] [blame^]

543

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

Yoshi Automation Bot

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

[diff] [blame]

544

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

545

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

546

},

Dmitry Frenkel

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

[diff] [blame]

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.

Dmitry Frenkel

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

[diff] [blame]

548

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

549

{

550

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

551

},

552

],

Yoshi Automation Bot

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

[diff] [blame^]

553

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

554

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

Dmitry Frenkel

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

[diff] [blame]

555

},

556

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

557

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

558

},

Yoshi Automation Bot

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

[diff] [blame^]

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

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

565

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

566

567

Args:

568

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

569

body: object, The request body.

570

The object takes the form of:

571

572

{ # Request message for `SetIamPolicy` method.

Yoshi Automation Bot

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

[diff] [blame^]

573

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

Dmitry Frenkel

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

[diff] [blame]

574

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

575

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

Dmitry Frenkel

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

[diff] [blame]

576

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

577

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

578

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

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]

},

],

},

],

Yoshi Automation Bot

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

[diff] [blame^]

589

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

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

592

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

593

"A String",

594

],

595

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

596

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

597

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

598

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

599

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

600

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

601

},

602

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

603

},

604

],

Dmitry Frenkel

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

[diff] [blame]

605

},

Dmitry Frenkel

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

[diff] [blame]

606

}

607

608

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

615

616

{ # 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

2020-11-25 07:50:41 -0800

[diff] [blame]

617

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

Dmitry Frenkel

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

[diff] [blame]

618

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

619

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

620

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

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

],

Yoshi Automation Bot

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

[diff] [blame^]

626

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

Dmitry Frenkel

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

[diff] [blame]

},

],

},

],

Yoshi Automation Bot

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

[diff] [blame^]

631

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

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

634

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

635

"A String",

636

],

637

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

638

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

639

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

640

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

641

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

642

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

643

},

644

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

645

},

646

],

Dmitry Frenkel