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

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a new Data Fusion instance in the specified project and location.</p>

80

81

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

82

<p class="firstline">Deletes a single Date Fusion instance.</p>

83

84

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

85

<p class="firstline">Gets details of a single Data Fusion instance.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Gets the access control policy for a resource.</p>

89

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

90

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

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

92

93

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

94

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

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

107

108

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

109

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

110

<h3>Method Details</h3>

111

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<pre>Creates a new Data Fusion instance in the specified project and location.

114

115

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

parent: string, The instance's project and location in the format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

117

projects/{project}/locations/{location}. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

118

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

The object takes the form of:

120

121

{ # Represents a Data Fusion instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

122

# Next available ID: 23

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"options": { # Map of additional options used to configure the behavior of

125

# Data Fusion instance.

126

"a_key": "A String",

127

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

128

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

129

# UpdateInstanceRequest.

130

{ # The Data Fusion version.

131

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

132

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

133

},

134

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

136

# Fusion instance is to be created.

137

# are used for peering with the customer network. Configurations are optional

138

# when a public Data Fusion instance is to be created. However, providing

139

# these configurations allows several benefits, such as reduced network latency

140

# while accessing the customer resources from managed Data Fusion instance

141

# nodes, as well as access to the customer on-prem resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"network": "A String", # Name of the network in the customer project with which the Tenant Project

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

143

# will be peered for executing pipelines. In case of shared VPC where the

144

# network resides in another host project the network should specified in

145

# the form of projects/{host-project-id}/global/networks/{network}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

146

"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

147

# nodes. This range must not overlap with any other ranges used in the Data

148

# Fusion instance network.

149

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

150

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

151

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

153

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

154

"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to

155

# true, all Data Fusion nodes will have private IP addresses and will not be

156

# able to access the public internet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

157

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

158

"serviceAccount": "A String", # Output only. Service account which will be used to access resources in

159

# the customer project."

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

160

"labels": { # The resource labels for instance to use to annotate any related underlying

161

# resources such as Compute Engine VMs. The character '=' is not allowed to

162

# be used within the labels.

163

"a_key": "A String",

164

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

165

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

166

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

167

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

168

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

169

"name": "A String", # Output only. The name of this instance is in the form of

170

# projects/{project}/locations/{location}/instances/{instance}.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

171

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

172

"version": "A String", # Current version of Data Fusion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

173

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

174

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

175

{ # Identifies Data Fusion accelerators for an instance.

176

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

177

},

178

],

179

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

180

# Fusion instance if available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

181

}

182

183

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

184

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

191

192

{ # This resource represents a long-running operation that is the result of a

193

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

194

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

195

# different programming environments, including REST APIs and RPC APIs. It is

196

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

197

# three pieces of data: error code, error message, and error details.

198

#

199

# You can find out more about this error model and how to work with it in the

200

# [API Design Guide](https://cloud.google.com/apis/design/errors).

201

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

202

"message": "A String", # A developer-facing error message, which should be in English. Any

203

# user-facing error message should be localized and sent in the

204

# google.rpc.Status.details field, or localized by the client.

205

"details": [ # A list of messages that carry the error details. There is a common set of

206

# message types for APIs to use.

207

{

208

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

213

# If `true`, the operation is completed, and either `error` or `response` is

214

# available.

215

"metadata": { # Service-specific metadata associated with the operation. It typically

216

# contains progress information and common metadata such as create time.

217

# Some services might not provide such metadata. Any method that returns a

218

# long-running operation should document the metadata type, if any.

219

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

220

},

221

"name": "A String", # The server-assigned name, which is only unique within the same service that

222

# originally returns it. If you use the default HTTP mapping, the

223

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

224

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

225

# method returns no data on success, such as `Delete`, the response is

226

# `google.protobuf.Empty`. If the original method is standard

227

# `Get`/`Create`/`Update`, the response should be the resource. For other

228

# methods, the response should have the type `XxxResponse`, where `Xxx`

229

# is the original method name. For example, if the original method name

230

# is `TakeSnapshot()`, the inferred response type is

231

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

233

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

239

<pre>Deletes a single Date Fusion instance.

Args:

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

{ # This resource represents a long-running operation that is the result of a

253

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

254

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

255

# different programming environments, including REST APIs and RPC APIs. It is

256

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

257

# three pieces of data: error code, error message, and error details.

258

#

259

# You can find out more about this error model and how to work with it in the

260

# [API Design Guide](https://cloud.google.com/apis/design/errors).

261

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

262

"message": "A String", # A developer-facing error message, which should be in English. Any

263

# user-facing error message should be localized and sent in the

264

# google.rpc.Status.details field, or localized by the client.

265

"details": [ # A list of messages that carry the error details. There is a common set of

266

# message types for APIs to use.

267

{

268

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

273

# If `true`, the operation is completed, and either `error` or `response` is

274

# available.

275

"metadata": { # Service-specific metadata associated with the operation. It typically

276

# contains progress information and common metadata such as create time.

277

# Some services might not provide such metadata. Any method that returns a

278

# long-running operation should document the metadata type, if any.

279

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

280

},

281

"name": "A String", # The server-assigned name, which is only unique within the same service that

282

# originally returns it. If you use the default HTTP mapping, the

283

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

284

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

285

# method returns no data on success, such as `Delete`, the response is

286

# `google.protobuf.Empty`. If the original method is standard

287

# `Get`/`Create`/`Update`, the response should be the resource. For other

288

# methods, the response should have the type `XxxResponse`, where `Xxx`

289

# is the original method name. For example, if the original method name

290

# is `TakeSnapshot()`, the inferred response type is

291

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

292

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

293

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

299

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

Args:

projects/{project}/locations/{location}/instances/{instance}. (required)

304

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

311

312

{ # Represents a Data Fusion instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

313

# Next available ID: 23

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

314

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"options": { # Map of additional options used to configure the behavior of

316

# Data Fusion instance.

317

"a_key": "A String",

318

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

319

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

320

# UpdateInstanceRequest.

321

{ # The Data Fusion version.

322

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

323

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

324

},

325

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

326

"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

327

# Fusion instance is to be created.

328

# are used for peering with the customer network. Configurations are optional

329

# when a public Data Fusion instance is to be created. However, providing

330

# these configurations allows several benefits, such as reduced network latency

331

# while accessing the customer resources from managed Data Fusion instance

332

# nodes, as well as access to the customer on-prem resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

"network": "A String", # Name of the network in the customer project with which the Tenant Project

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

334

# will be peered for executing pipelines. In case of shared VPC where the

335

# network resides in another host project the network should specified in

336

# the form of projects/{host-project-id}/global/networks/{network}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

338

# nodes. This range must not overlap with any other ranges used in the Data

339

# Fusion instance network.

340

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

341

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

342

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

344

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

345

"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to

346

# true, all Data Fusion nodes will have private IP addresses and will not be

347

# able to access the public internet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

348

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

349

"serviceAccount": "A String", # Output only. Service account which will be used to access resources in

350

# the customer project."

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

351

"labels": { # The resource labels for instance to use to annotate any related underlying

352

# resources such as Compute Engine VMs. The character '=' is not allowed to

353

# be used within the labels.

354

"a_key": "A String",

355

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

356

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

357

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

358

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

359

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

360

"name": "A String", # Output only. The name of this instance is in the form of

361

# projects/{project}/locations/{location}/instances/{instance}.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

362

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

363

"version": "A String", # Current version of Data Fusion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

364

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

365

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

366

{ # Identifies Data Fusion accelerators for an instance.

367

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

368

},

369

],

370

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

371

# Fusion instance if available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

376

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

377

<pre>Gets the access control policy for a resource.

378

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

383

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

384

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.

385

386

Valid values are 0, 1, and 3. Requests specifying an invalid value will be

387

rejected.

388

389

Requests for policies with any conditional bindings must specify version 3.

390

Policies without any conditional bindings may specify any valid value or

391

leave the field unset.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

392

393

To learn which resources support conditions in their IAM policies, see the

394

[IAM

395

documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

403

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

404

{ # An Identity and Access Management (IAM) policy, which specifies access

405

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

406

#

407

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

408

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

409

# `members` to a single `role`. Members can be user accounts, service accounts,

410

# Google groups, and domains (such as G Suite). A `role` is a named list of

411

# permissions; each `role` can be an IAM predefined role or a user-created

412

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

413

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

414

# For some types of Google Cloud resources, a `binding` can also specify a

415

# `condition`, which is a logical expression that allows access to a resource

416

# only if the expression evaluates to `true`. A condition can add constraints

417

# based on attributes of the request, the resource, or both. To learn which

418

# resources support conditions in their IAM policies, see the

419

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

420

#

421

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

422

#

423

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

424

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

425

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

# "role": "roles/resourcemanager.organizationAdmin",

427

# "members": [

428

# "user:mike@example.com",

429

# "group:admins@example.com",

430

# "domain:google.com",

431

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

432

# ]

433

# },

434

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

435

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

436

# "members": [

437

# "user:eve@example.com"

438

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

# "condition": {

440

# "title": "expirable access",

441

# "description": "Does not grant access after Sep 2020",

442

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

443

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

444

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

445

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

446

# "etag": "BwWWja0YfJA=",

447

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

448

# }

449

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

450

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

455

# - group:admins@example.com

456

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

457

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

458

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

459

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

460

# - user:eve@example.com

461

# role: roles/resourcemanager.organizationViewer

462

# condition:

463

# title: expirable access

464

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

466

# - etag: BwWWja0YfJA=

467

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

468

#

469

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

470

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

471

"version": 42, # Specifies the format of the policy.

472

#

473

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

474

# are rejected.

475

#

476

# Any operation that affects conditional role bindings must specify version

477

# `3`. This requirement applies to the following operations:

478

#

479

# * Getting a policy that includes a conditional role binding

480

# * Adding a conditional role binding to a policy

481

# * Changing a conditional role binding in a policy

482

# * Removing any role binding, with or without a condition, from a policy

483

# that includes conditions

484

#

485

# **Important:** If you use IAM Conditions, you must include the `etag` field

486

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

487

# you to overwrite a version `3` policy with a version `1` policy, and all of

488

# the conditions in the version `3` policy are lost.

489

#

490

# If a policy does not include any conditions, operations on that policy may

491

# specify any valid version or leave the field unset.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

492

#

493

# To learn which resources support conditions in their IAM policies, see the

494

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

495

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

496

# prevent simultaneous updates of a policy from overwriting each other.

497

# It is strongly suggested that systems make use of the `etag` in the

498

# read-modify-write cycle to perform policy updates in order to avoid race

499

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

500

# systems are expected to put that etag in the request to `setIamPolicy` to

501

# ensure that their change will be applied to the same version of the policy.

502

#

503

# **Important:** If you use IAM Conditions, you must include the `etag` field

504

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

505

# you to overwrite a version `3` policy with a version `1` policy, and all of

506

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

507

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

508

{ # Specifies the audit configuration for a service.

509

# The configuration determines which permission types are logged, and what

510

# identities, if any, are exempted from logging.

511

# An AuditConfig must have one or more AuditLogConfigs.

512

#

513

# If there are AuditConfigs for both `allServices` and a specific service,

514

# the union of the two AuditConfigs is used for that service: the log_types

515

# specified in each AuditConfig are enabled, and the exempted_members in each

516

# AuditLogConfig are exempted.

517

#

518

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

523

# "service": "allServices",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

524

# "audit_log_configs": [

525

# {

526

# "log_type": "DATA_READ",

527

# "exempted_members": [

528

# "user:jose@example.com"

529

# ]

530

# },

531

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

532

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

533

# },

534

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

535

# "log_type": "ADMIN_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

540

# "service": "sampleservice.googleapis.com",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

541

# "audit_log_configs": [

542

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

543

# "log_type": "DATA_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

544

# },

545

# {

546

# "log_type": "DATA_WRITE",

547

# "exempted_members": [

548

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

557

# logging. It also exempts jose@example.com from DATA_READ logging, and

558

# aliya@example.com from DATA_WRITE logging.

559

"service": "A String", # Specifies a service that will be enabled for audit logging.

560

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

561

# `allServices` is a special value that covers all services.

562

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

563

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

568

# {

569

# "log_type": "DATA_READ",

570

# "exempted_members": [

571

# "user:jose@example.com"

572

# ]

573

# },

574

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

575

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

581

# jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

582

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

583

# permission.

584

# Follows the same format of Binding.members.

585

"A String",

586

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

587

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

593

# `condition` that determines how and when the `bindings` are applied. Each

594

# of the `bindings` must contain at least one member.

595

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

596

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

597

#

598

# If the condition evaluates to `true`, then this binding applies to the

599

# current request.

600

#

601

# If the condition evaluates to `false`, then this binding does not apply to

602

# the current request. However, a different role binding might grant the same

603

# role to one or more of the members in this binding.

604

#

605

# To learn which resources support conditions in their IAM policies, see the

606

# [IAM

607

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

608

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

609

# are documented at https://github.com/google/cel-spec.

610

#

611

# Example (Comparison):

612

#

613

# title: "Summary size limit"

614

# description: "Determines if a summary is less than 100 chars"

615

# expression: "document.summary.size() < 100"

616

#

617

# Example (Equality):

618

#

619

# title: "Requestor is owner"

620

# description: "Determines if requestor is the document owner"

621

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

626

# description: "Determine whether the document should be publicly visible"

627

# expression: "document.type != 'private' && document.type != 'internal'"

628

#

629

# Example (Data Manipulation):

630

#

631

# title: "Notification string"

632

# description: "Create a notification string with a timestamp."

633

# expression: "'New message received at ' + string(document.create_time)"

634

#

635

# The exact variables and functions that may be referenced within an expression

636

# are determined by the service that evaluates it. See the service

637

# documentation for additional information.

638

"location": "A String", # Optional. String indicating the location of the expression for error

639

# reporting, e.g. a file name and a position in the file.

640

"description": "A String", # Optional. Description of the expression. This is a longer text which

641

# describes the expression, e.g. when hovered over it in a UI.

642

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

643

# syntax.

644

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

645

# its purpose. This can be used e.g. in UIs which allow to enter the

646

# expression.

647

},

648

"role": "A String", # Role that is assigned to `members`.

649

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

650

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

651

# `members` can have the following values:

652

#

653

# * `allUsers`: A special identifier that represents anyone who is

654

# on the internet; with or without a Google account.

655

#

656

# * `allAuthenticatedUsers`: A special identifier that represents anyone

657

# who is authenticated with a Google account or a service account.

658

#

659

# * `user:{emailid}`: An email address that represents a specific Google

660

# account. For example, `alice@example.com` .

661

#

662

#

663

# * `serviceAccount:{emailid}`: An email address that represents a service

664

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

665

#

666

# * `group:{emailid}`: An email address that represents a Google group.

667

# For example, `admins@example.com`.

668

#

669

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

670

# identifier) representing a user that has been recently deleted. For

671

# example, `alice@example.com?uid=123456789012345678901`. If the user is

672

# recovered, this value reverts to `user:{emailid}` and the recovered user

673

# retains the role in the binding.

674

#

675

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

676

# unique identifier) representing a service account that has been recently

677

# deleted. For example,

678

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

679

# If the service account is undeleted, this value reverts to

680

# `serviceAccount:{emailid}` and the undeleted service account retains the

681

# role in the binding.

682

#

683

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

684

# identifier) representing a Google group that has been recently

685

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

686

# the group is recovered, this value reverts to `group:{emailid}` and the

687

# recovered group retains the role in the binding.

688

#

689

#

690

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

691

# users of that domain. For example, `google.com` or `example.com`.

692

#

693

"A String",

694

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

695

},

696

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

701

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

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

703

704

Args:

705

parent: string, The project and location for which to retrieve instance information

706

in the format projects/{project}/locations/{location}. If the location is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

707

specified as '-' (wildcard), then all regions available to the project

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

708

are queried, and the results are aggregated. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

709

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

710

pageToken: string, The next_page_token value to use if there are additional

711

results to retrieve for this list request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

712

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

713

filter: string, List filter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

714

x__xgafv: string, V1 error format.

715

Allowed values

716

1 - v1 error format

717

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

718

719

Returns:

720

An object of the form:

721

722

{ # Response message for the list instance request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

724

{ # Represents a Data Fusion instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

725

# Next available ID: 23

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

726

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

727

"options": { # Map of additional options used to configure the behavior of

728

# Data Fusion instance.

729

"a_key": "A String",

730

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

731

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

732

# UpdateInstanceRequest.

733

{ # The Data Fusion version.

734

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

735

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

736

},

737

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

738

"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

739

# Fusion instance is to be created.

740

# are used for peering with the customer network. Configurations are optional

741

# when a public Data Fusion instance is to be created. However, providing

742

# these configurations allows several benefits, such as reduced network latency

743

# while accessing the customer resources from managed Data Fusion instance

744

# nodes, as well as access to the customer on-prem resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

745

"network": "A String", # Name of the network in the customer project with which the Tenant Project

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

746

# will be peered for executing pipelines. In case of shared VPC where the

747

# network resides in another host project the network should specified in

748

# the form of projects/{host-project-id}/global/networks/{network}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

749

"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

750

# nodes. This range must not overlap with any other ranges used in the Data

751

# Fusion instance network.

752

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

753

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

754

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

755

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

756

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to

758

# true, all Data Fusion nodes will have private IP addresses and will not be

759

# able to access the public internet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

760

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

761

"serviceAccount": "A String", # Output only. Service account which will be used to access resources in

762

# the customer project."

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

763

"labels": { # The resource labels for instance to use to annotate any related underlying

764

# resources such as Compute Engine VMs. The character '=' is not allowed to

765

# be used within the labels.

766

"a_key": "A String",

767

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

768

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

769

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

770

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

771

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

772

"name": "A String", # Output only. The name of this instance is in the form of

773

# projects/{project}/locations/{location}/instances/{instance}.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

774

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

775

"version": "A String", # Current version of Data Fusion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

776

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

777

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

778

{ # Identifies Data Fusion accelerators for an instance.

779

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

780

},

781

],

782

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

783

# Fusion instance if available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

784

},

785

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

786

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

787

# results in the list.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

788

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

789

"A String",

790

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

796

<pre>Retrieves the next page of results.

797

798

Args:

799

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

800

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

801

802

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

803

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

804

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

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

809

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

810

<pre>Updates a single Data Fusion instance.

Args:

projects/{project}/locations/{location}/instances/{instance}. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

815

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

816

The object takes the form of:

817

818

{ # Represents a Data Fusion instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

819

# Next available ID: 23

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

820

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

821

"options": { # Map of additional options used to configure the behavior of

822

# Data Fusion instance.

823

"a_key": "A String",

824

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

825

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

826

# UpdateInstanceRequest.

827

{ # The Data Fusion version.

828

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

829

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

830

},

831

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

832

"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

833

# Fusion instance is to be created.

834

# are used for peering with the customer network. Configurations are optional

835

# when a public Data Fusion instance is to be created. However, providing

836

# these configurations allows several benefits, such as reduced network latency

837

# while accessing the customer resources from managed Data Fusion instance

838

# nodes, as well as access to the customer on-prem resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

839

"network": "A String", # Name of the network in the customer project with which the Tenant Project

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

840

# will be peered for executing pipelines. In case of shared VPC where the

841

# network resides in another host project the network should specified in

842

# the form of projects/{host-project-id}/global/networks/{network}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

843

"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

844

# nodes. This range must not overlap with any other ranges used in the Data

845

# Fusion instance network.

846

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

847

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

848

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

849

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

850

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

851

"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to

852

# true, all Data Fusion nodes will have private IP addresses and will not be

853

# able to access the public internet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

854

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

855

"serviceAccount": "A String", # Output only. Service account which will be used to access resources in

856

# the customer project."

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

857

"labels": { # The resource labels for instance to use to annotate any related underlying

858

# resources such as Compute Engine VMs. The character '=' is not allowed to

859

# be used within the labels.

860

"a_key": "A String",

861

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

862

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

863

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

864

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

865

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

866

"name": "A String", # Output only. The name of this instance is in the form of

867

# projects/{project}/locations/{location}/instances/{instance}.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

868

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

869

"version": "A String", # Current version of Data Fusion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

870

"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

871

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

872

{ # Identifies Data Fusion accelerators for an instance.

873

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

874

},

875

],

876

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

877

# Fusion instance if available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

878

}

879

880

updateMask: string, Field mask is used to specify the fields that the update will overwrite

881

in an instance resource. The fields specified in the update_mask are

882

relative to the resource, not the full request.

883

A field will be overwritten if it is in the mask.

884

If the user does not provide a mask, all the supported fields (labels and

885

options currently) will be overwritten.

886

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

893

894

{ # This resource represents a long-running operation that is the result of a

895

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

896

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

897

# different programming environments, including REST APIs and RPC APIs. It is

898

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

899

# three pieces of data: error code, error message, and error details.

900

#

901

# You can find out more about this error model and how to work with it in the

902

# [API Design Guide](https://cloud.google.com/apis/design/errors).

903

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

904

"message": "A String", # A developer-facing error message, which should be in English. Any

905

# user-facing error message should be localized and sent in the

906

# google.rpc.Status.details field, or localized by the client.

907

"details": [ # A list of messages that carry the error details. There is a common set of

908

# message types for APIs to use.

909

{

910

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

915

# If `true`, the operation is completed, and either `error` or `response` is

916

# available.

917

"metadata": { # Service-specific metadata associated with the operation. It typically

918

# contains progress information and common metadata such as create time.

919

# Some services might not provide such metadata. Any method that returns a

920

# long-running operation should document the metadata type, if any.

921

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

922

},

923

"name": "A String", # The server-assigned name, which is only unique within the same service that

924

# originally returns it. If you use the default HTTP mapping, the

925

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

926

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

927

# method returns no data on success, such as `Delete`, the response is

928

# `google.protobuf.Empty`. If the original method is standard

929

# `Get`/`Create`/`Update`, the response should be the resource. For other

930

# methods, the response should have the type `XxxResponse`, where `Xxx`

931

# is the original method name. For example, if the original method name

932

# is `TakeSnapshot()`, the inferred response type is

933

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

934

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

935

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

941

<pre>Restart a single Data Fusion instance.

942

At the end of an operation instance is fully restarted.

943

944

Args:

945

name: string, Name of the Data Fusion instance which need to be restarted in the form of

946

projects/{project}/locations/{location}/instances/{instance} (required)

947

body: object, The request body.

948

The object takes the form of:

949

950

{ # Request message for restarting a Data Fusion instance.

951

}

952

953

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

960

961

{ # This resource represents a long-running operation that is the result of a

962

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

963

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

964

# different programming environments, including REST APIs and RPC APIs. It is

965

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

966

# three pieces of data: error code, error message, and error details.

967

#

968

# You can find out more about this error model and how to work with it in the

969

# [API Design Guide](https://cloud.google.com/apis/design/errors).

970

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

971

"message": "A String", # A developer-facing error message, which should be in English. Any

972

# user-facing error message should be localized and sent in the

973

# google.rpc.Status.details field, or localized by the client.

974

"details": [ # A list of messages that carry the error details. There is a common set of

975

# message types for APIs to use.

976

{

977

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

982

# If `true`, the operation is completed, and either `error` or `response` is

983

# available.

984

"metadata": { # Service-specific metadata associated with the operation. It typically

985

# contains progress information and common metadata such as create time.

986

# Some services might not provide such metadata. Any method that returns a

987

# long-running operation should document the metadata type, if any.

988

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

989

},

990

"name": "A String", # The server-assigned name, which is only unique within the same service that

991

# originally returns it. If you use the default HTTP mapping, the

992

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

993

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

994

# method returns no data on success, such as `Delete`, the response is

995

# `google.protobuf.Empty`. If the original method is standard

996

# `Get`/`Create`/`Update`, the response should be the resource. For other

997

# methods, the response should have the type `XxxResponse`, where `Xxx`

998

# is the original method name. For example, if the original method name

999

# is `TakeSnapshot()`, the inferred response type is

1000

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1001

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1002

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1007

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1008

<pre>Sets the access control policy on the specified resource. Replaces any

1009

existing policy.

1010

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1011

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1012

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1013

Args:

1014

resource: string, REQUIRED: The resource for which the policy is being specified.

1015

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1016

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1017

The object takes the form of:

1018

1019

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1020

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1021

# the policy is limited to a few 10s of KB. An empty policy is a

1022

# valid policy but certain Cloud Platform services (such as Projects)

1023

# might reject them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1024

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1025

#

1026

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1027

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1028

# `members` to a single `role`. Members can be user accounts, service accounts,

1029

# Google groups, and domains (such as G Suite). A `role` is a named list of

1030

# permissions; each `role` can be an IAM predefined role or a user-created

1031

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1032

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1033

# For some types of Google Cloud resources, a `binding` can also specify a

1034

# `condition`, which is a logical expression that allows access to a resource

1035

# only if the expression evaluates to `true`. A condition can add constraints

1036

# based on attributes of the request, the resource, or both. To learn which

1037

# resources support conditions in their IAM policies, see the

1038

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1039

#

1040

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1041

#

1042

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1043

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1044

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1045

# "role": "roles/resourcemanager.organizationAdmin",

1046

# "members": [

1047

# "user:mike@example.com",

1048

# "group:admins@example.com",

1049

# "domain:google.com",

1050

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1051

# ]

1052

# },

1053

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1054

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1055

# "members": [

1056

# "user:eve@example.com"

1057

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1058

# "condition": {

1059

# "title": "expirable access",

1060

# "description": "Does not grant access after Sep 2020",

1061

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1062

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1063

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1064

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1065

# "etag": "BwWWja0YfJA=",

1066

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1067

# }

1068

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1069

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1074

# - group:admins@example.com

1075

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1076

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1077

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1078

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1079

# - user:eve@example.com

1080

# role: roles/resourcemanager.organizationViewer

1081

# condition:

1082

# title: expirable access

1083

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1084

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1085

# - etag: BwWWja0YfJA=

1086

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1087

#

1088

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1089

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1090

"version": 42, # Specifies the format of the policy.

1091

#

1092

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1093

# are rejected.

1094

#

1095

# Any operation that affects conditional role bindings must specify version

1096

# `3`. This requirement applies to the following operations:

1097

#

1098

# * Getting a policy that includes a conditional role binding

1099

# * Adding a conditional role binding to a policy

1100

# * Changing a conditional role binding in a policy

1101

# * Removing any role binding, with or without a condition, from a policy

1102

# that includes conditions

1103

#

1104

# **Important:** If you use IAM Conditions, you must include the `etag` field

1105

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1106

# you to overwrite a version `3` policy with a version `1` policy, and all of

1107

# the conditions in the version `3` policy are lost.

1108

#

1109

# If a policy does not include any conditions, operations on that policy may

1110

# specify any valid version or leave the field unset.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1111

#

1112

# To learn which resources support conditions in their IAM policies, see the

1113

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1114

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1115

# prevent simultaneous updates of a policy from overwriting each other.

1116

# It is strongly suggested that systems make use of the `etag` in the

1117

# read-modify-write cycle to perform policy updates in order to avoid race

1118

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1119

# systems are expected to put that etag in the request to `setIamPolicy` to

1120

# ensure that their change will be applied to the same version of the policy.

1121

#

1122

# **Important:** If you use IAM Conditions, you must include the `etag` field

1123

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1124

# you to overwrite a version `3` policy with a version `1` policy, and all of

1125

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1126

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

1127

{ # Specifies the audit configuration for a service.

1128

# The configuration determines which permission types are logged, and what

1129

# identities, if any, are exempted from logging.

1130

# An AuditConfig must have one or more AuditLogConfigs.

1131

#

1132

# If there are AuditConfigs for both `allServices` and a specific service,

1133

# the union of the two AuditConfigs is used for that service: the log_types

1134

# specified in each AuditConfig are enabled, and the exempted_members in each

1135

# AuditLogConfig are exempted.

1136

#

1137

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1142

# "service": "allServices",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1143

# "audit_log_configs": [

1144

# {

1145

# "log_type": "DATA_READ",

1146

# "exempted_members": [

1147

# "user:jose@example.com"

1148

# ]

1149

# },

1150

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1151

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1152

# },

1153

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1154

# "log_type": "ADMIN_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1159

# "service": "sampleservice.googleapis.com",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1160

# "audit_log_configs": [

1161

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1162

# "log_type": "DATA_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1163

# },

1164

# {

1165

# "log_type": "DATA_WRITE",

1166

# "exempted_members": [

1167

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1176

# logging. It also exempts jose@example.com from DATA_READ logging, and

1177

# aliya@example.com from DATA_WRITE logging.

1178

"service": "A String", # Specifies a service that will be enabled for audit logging.

1179

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1180

# `allServices` is a special value that covers all services.

1181

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

1182

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1187

# {

1188

# "log_type": "DATA_READ",

1189

# "exempted_members": [

1190

# "user:jose@example.com"

1191

# ]

1192

# },

1193

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1194

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1200

# jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1201

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1202

# permission.

1203

# Follows the same format of Binding.members.

1204

"A String",

1205

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1206

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1212

# `condition` that determines how and when the `bindings` are applied. Each

1213

# of the `bindings` must contain at least one member.

1214

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1215

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1216

#

1217

# If the condition evaluates to `true`, then this binding applies to the

1218

# current request.

1219

#

1220

# If the condition evaluates to `false`, then this binding does not apply to

1221

# the current request. However, a different role binding might grant the same

1222

# role to one or more of the members in this binding.

1223

#

1224

# To learn which resources support conditions in their IAM policies, see the

1225

# [IAM

1226

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1227

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1228

# are documented at https://github.com/google/cel-spec.

1229

#

1230

# Example (Comparison):

1231

#

1232

# title: "Summary size limit"

1233

# description: "Determines if a summary is less than 100 chars"

1234

# expression: "document.summary.size() < 100"

1235

#

1236

# Example (Equality):

1237

#

1238

# title: "Requestor is owner"

1239

# description: "Determines if requestor is the document owner"

1240

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1245

# description: "Determine whether the document should be publicly visible"

1246

# expression: "document.type != 'private' && document.type != 'internal'"

1247

#

1248

# Example (Data Manipulation):

1249

#

1250

# title: "Notification string"

1251

# description: "Create a notification string with a timestamp."

1252

# expression: "'New message received at ' + string(document.create_time)"

1253

#

1254

# The exact variables and functions that may be referenced within an expression

1255

# are determined by the service that evaluates it. See the service

1256

# documentation for additional information.

1257

"location": "A String", # Optional. String indicating the location of the expression for error

1258

# reporting, e.g. a file name and a position in the file.

1259

"description": "A String", # Optional. Description of the expression. This is a longer text which

1260

# describes the expression, e.g. when hovered over it in a UI.

1261

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

1262

# syntax.

1263

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1264

# its purpose. This can be used e.g. in UIs which allow to enter the

1265

# expression.

1266

},

1267

"role": "A String", # Role that is assigned to `members`.

1268

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1269

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1270

# `members` can have the following values:

1271

#

1272

# * `allUsers`: A special identifier that represents anyone who is

1273

# on the internet; with or without a Google account.

1274

#

1275

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1276

# who is authenticated with a Google account or a service account.

1277

#

1278

# * `user:{emailid}`: An email address that represents a specific Google

1279

# account. For example, `alice@example.com` .

1280

#

1281

#

1282

# * `serviceAccount:{emailid}`: An email address that represents a service

1283

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1284

#

1285

# * `group:{emailid}`: An email address that represents a Google group.

1286

# For example, `admins@example.com`.

1287

#

1288

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1289

# identifier) representing a user that has been recently deleted. For

1290

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1291

# recovered, this value reverts to `user:{emailid}` and the recovered user

1292

# retains the role in the binding.

1293

#

1294

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1295

# unique identifier) representing a service account that has been recently

1296

# deleted. For example,

1297

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1298

# If the service account is undeleted, this value reverts to

1299

# `serviceAccount:{emailid}` and the undeleted service account retains the

1300

# role in the binding.

1301

#

1302

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1303

# identifier) representing a Google group that has been recently

1304

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1305

# the group is recovered, this value reverts to `group:{emailid}` and the

1306

# recovered group retains the role in the binding.

1307

#

1308

#

1309

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1310

# users of that domain. For example, `google.com` or `example.com`.

1311

#

1312

"A String",

1313

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1314

},

1315

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1317

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1318

# the fields in the mask will be modified. If no mask is provided, the

1319

# following default mask is used:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1320

#

1321

# `paths: "bindings, etag"`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1322

}

1323

1324

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1331

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1332

{ # An Identity and Access Management (IAM) policy, which specifies access

1333

# controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1334

#

1335

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1336

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1337

# `members` to a single `role`. Members can be user accounts, service accounts,

1338

# Google groups, and domains (such as G Suite). A `role` is a named list of

1339

# permissions; each `role` can be an IAM predefined role or a user-created

1340

# custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1341

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1342

# For some types of Google Cloud resources, a `binding` can also specify a

1343

# `condition`, which is a logical expression that allows access to a resource

1344

# only if the expression evaluates to `true`. A condition can add constraints

1345

# based on attributes of the request, the resource, or both. To learn which

1346

# resources support conditions in their IAM policies, see the

1347

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1348

#

1349

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1350

#

1351

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1352

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1353

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1354

# "role": "roles/resourcemanager.organizationAdmin",

1355

# "members": [

1356

# "user:mike@example.com",

1357

# "group:admins@example.com",

1358

# "domain:google.com",

1359

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1360

# ]

1361

# },

1362

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1364

# "members": [

1365

# "user:eve@example.com"

1366

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1367

# "condition": {

1368

# "title": "expirable access",

1369

# "description": "Does not grant access after Sep 2020",

1370

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1371

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1372

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1373

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1374

# "etag": "BwWWja0YfJA=",

1375

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1376

# }

1377

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1378

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1383

# - group:admins@example.com

1384

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1385

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1386

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1387

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1388

# - user:eve@example.com

1389

# role: roles/resourcemanager.organizationViewer

1390

# condition:

1391

# title: expirable access

1392

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1393

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1394

# - etag: BwWWja0YfJA=

1395

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1396

#

1397

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1398

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1399

"version": 42, # Specifies the format of the policy.

1400

#

1401

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1402

# are rejected.

1403

#

1404

# Any operation that affects conditional role bindings must specify version

1405

# `3`. This requirement applies to the following operations:

1406

#

1407

# * Getting a policy that includes a conditional role binding

1408

# * Adding a conditional role binding to a policy

1409

# * Changing a conditional role binding in a policy

1410

# * Removing any role binding, with or without a condition, from a policy

1411

# that includes conditions

1412

#

1413

# **Important:** If you use IAM Conditions, you must include the `etag` field

1414

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1415

# you to overwrite a version `3` policy with a version `1` policy, and all of

1416

# the conditions in the version `3` policy are lost.

1417

#

1418

# If a policy does not include any conditions, operations on that policy may

1419

# specify any valid version or leave the field unset.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1420

#

1421

# To learn which resources support conditions in their IAM policies, see the

1422

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1423

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1424

# prevent simultaneous updates of a policy from overwriting each other.

1425

# It is strongly suggested that systems make use of the `etag` in the

1426

# read-modify-write cycle to perform policy updates in order to avoid race

1427

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1428

# systems are expected to put that etag in the request to `setIamPolicy` to

1429

# ensure that their change will be applied to the same version of the policy.

1430

#

1431

# **Important:** If you use IAM Conditions, you must include the `etag` field

1432

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1433

# you to overwrite a version `3` policy with a version `1` policy, and all of

1434

# the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1435

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

1436

{ # Specifies the audit configuration for a service.

1437

# The configuration determines which permission types are logged, and what

1438

# identities, if any, are exempted from logging.

1439

# An AuditConfig must have one or more AuditLogConfigs.

1440

#

1441

# If there are AuditConfigs for both `allServices` and a specific service,

1442

# the union of the two AuditConfigs is used for that service: the log_types

1443

# specified in each AuditConfig are enabled, and the exempted_members in each

1444

# AuditLogConfig are exempted.

1445

#

1446

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1451

# "service": "allServices",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1452

# "audit_log_configs": [

1453

# {

1454

# "log_type": "DATA_READ",

1455

# "exempted_members": [

1456

# "user:jose@example.com"

1457

# ]

1458

# },

1459

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1460

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

# },

1462

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1463

# "log_type": "ADMIN_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# },

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1468

# "service": "sampleservice.googleapis.com",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1469

# "audit_log_configs": [

1470

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1471

# "log_type": "DATA_READ"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

# },

1473

# {

1474

# "log_type": "DATA_WRITE",

1475

# "exempted_members": [

1476

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1485

# logging. It also exempts jose@example.com from DATA_READ logging, and

1486

# aliya@example.com from DATA_WRITE logging.

1487

"service": "A String", # Specifies a service that will be enabled for audit logging.

1488

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1489

# `allServices` is a special value that covers all services.

1490

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

1491

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1496

# {

1497

# "log_type": "DATA_READ",

1498

# "exempted_members": [

1499

# "user:jose@example.com"

1500

# ]

1501

# },

1502

# {

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1503

# "log_type": "DATA_WRITE"

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1509

# jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1510

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1511

# permission.

1512

# Follows the same format of Binding.members.

1513

"A String",

1514

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1515

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1521

# `condition` that determines how and when the `bindings` are applied. Each

1522

# of the `bindings` must contain at least one member.

1523

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1524

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1525

#

1526

# If the condition evaluates to `true`, then this binding applies to the

1527

# current request.

1528

#

1529

# If the condition evaluates to `false`, then this binding does not apply to

1530

# the current request. However, a different role binding might grant the same

1531

# role to one or more of the members in this binding.

1532

#

1533

# To learn which resources support conditions in their IAM policies, see the

1534

# [IAM

1535

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1536

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1537

# are documented at https://github.com/google/cel-spec.

1538

#

1539

# Example (Comparison):

1540

#

1541

# title: "Summary size limit"

1542

# description: "Determines if a summary is less than 100 chars"

1543

# expression: "document.summary.size() < 100"

1544

#

1545

# Example (Equality):

1546

#

1547

# title: "Requestor is owner"

1548

# description: "Determines if requestor is the document owner"

1549

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1554

# description: "Determine whether the document should be publicly visible"

1555

# expression: "document.type != 'private' && document.type != 'internal'"

1556

#

1557

# Example (Data Manipulation):

1558

#

1559

# title: "Notification string"

1560

# description: "Create a notification string with a timestamp."

1561

# expression: "'New message received at ' + string(document.create_time)"

1562

#

1563

# The exact variables and functions that may be referenced within an expression

1564

# are determined by the service that evaluates it. See the service

1565

# documentation for additional information.

1566

"location": "A String", # Optional. String indicating the location of the expression for error

1567

# reporting, e.g. a file name and a position in the file.

1568

"description": "A String", # Optional. Description of the expression. This is a longer text which

1569

# describes the expression, e.g. when hovered over it in a UI.

1570

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

1571

# syntax.

1572

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1573

# its purpose. This can be used e.g. in UIs which allow to enter the

1574

# expression.

1575

},

1576

"role": "A String", # Role that is assigned to `members`.

1577

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1578

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1579

# `members` can have the following values:

1580

#

1581

# * `allUsers`: A special identifier that represents anyone who is

1582

# on the internet; with or without a Google account.

1583

#

1584

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1585

# who is authenticated with a Google account or a service account.

1586

#

1587

# * `user:{emailid}`: An email address that represents a specific Google

1588

# account. For example, `alice@example.com` .

1589

#

1590

#

1591

# * `serviceAccount:{emailid}`: An email address that represents a service

1592

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1593

#

1594

# * `group:{emailid}`: An email address that represents a Google group.

1595

# For example, `admins@example.com`.

1596

#

1597

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1598

# identifier) representing a user that has been recently deleted. For

1599

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1600

# recovered, this value reverts to `user:{emailid}` and the recovered user

1601

# retains the role in the binding.

1602

#

1603

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1604

# unique identifier) representing a service account that has been recently

1605

# deleted. For example,

1606

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1607

# If the service account is undeleted, this value reverts to

1608

# `serviceAccount:{emailid}` and the undeleted service account retains the

1609

# role in the binding.

1610

#

1611

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1612

# identifier) representing a Google group that has been recently

1613

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1614

# the group is recovered, this value reverts to `group:{emailid}` and the

1615

# recovered group retains the role in the binding.

1616

#

1617

#

1618

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1619

# users of that domain. For example, `google.com` or `example.com`.

1620

#

1621

"A String",

1622

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1623

},

1624

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1629

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1630

<pre>Returns permissions that a caller has on the specified resource.

1631

If the resource does not exist, this will return an empty set of

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1632

permissions, not a `NOT_FOUND` error.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1633

1634

Note: This operation is designed to be used for building permission-aware

1635

UIs and command-line tools, not for authorization checking. This operation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1636

may "fail open" without warning.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1637

1638

Args:

1639

resource: string, REQUIRED: The resource for which the policy detail is being requested.

1640

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1642

The object takes the form of:

1643

1644

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1645

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1646

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1647

# information see

1648

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1649

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1660

1661

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1662

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1663

# allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1664

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

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

1671

<pre>Upgrade a single Data Fusion instance.

1672

At the end of an operation instance is fully upgraded.

1673

1674

Args:

1675

name: string, Name of the Data Fusion instance which need to be upgraded in the form of

1676

projects/{project}/locations/{location}/instances/{instance}

1677

Instance will be upgraded with the latest stable version of the Data

1678

Fusion. (required)

1679

body: object, The request body.

1680

The object takes the form of:

1681

1682

{ # Request message for upgrading a Data Fusion instance.

1683

# To change the instance properties, instance update should be used.

1684

}

1685

1686

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1693

1694

{ # This resource represents a long-running operation that is the result of a

1695

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1696

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1697

# different programming environments, including REST APIs and RPC APIs. It is

1698

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1699

# three pieces of data: error code, error message, and error details.

1700

#

1701

# You can find out more about this error model and how to work with it in the

1702

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1703

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

1704

"message": "A String", # A developer-facing error message, which should be in English. Any

1705

# user-facing error message should be localized and sent in the

1706

# google.rpc.Status.details field, or localized by the client.

1707

"details": [ # A list of messages that carry the error details. There is a common set of

1708

# message types for APIs to use.

1709

{

1710

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1715

# If `true`, the operation is completed, and either `error` or `response` is

1716

# available.

1717

"metadata": { # Service-specific metadata associated with the operation. It typically

1718

# contains progress information and common metadata such as create time.

1719

# Some services might not provide such metadata. Any method that returns a

1720

# long-running operation should document the metadata type, if any.

1721

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

1722

},

1723

"name": "A String", # The server-assigned name, which is only unique within the same service that

1724

# originally returns it. If you use the default HTTP mapping, the

1725

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1726

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1727

# method returns no data on success, such as `Delete`, the response is

1728

# `google.protobuf.Empty`. If the original method is standard

1729

# `Get`/`Create`/`Update`, the response should be the resource. For other

1730

# methods, the response should have the type `XxxResponse`, where `Xxx`

1731

# is the original method name. For example, if the original method name

1732

# is `TakeSnapshot()`, the inferred response type is

1733

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1734

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1735

},

Bu Sun Kim