Blame - docs/dyn/accesscontextmanager_v1beta.accessPolicies.accessLevels.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, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Create an Access Level. The longrunning</p>

80

81

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

82

<p class="firstline">Delete an Access Level by resource</p>

83

84

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

85

<p class="firstline">Get an Access Level by resource</p>

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">List all Access Levels for an access</p>

89

90

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

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

94

<p class="firstline">Update an Access Level. The longrunning</p>

95

<h3>Method Details</h3>

96

Dan O'Meara

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

[diff] [blame]

97

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

Bu Sun Kim

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

[diff] [blame]

98

<pre>Create an Access Level. The longrunning

99

operation from this RPC will have a successful status once the Access

100

Level has

101

propagated to long-lasting storage. Access Levels containing

102

errors will result in an error response for the first error encountered.

103

104

Args:

105

parent: string, Required. Resource name for the access policy which owns this Access

106

Level.

107

108

Format: `accessPolicies/{policy_id}` (required)

Dan O'Meara

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

[diff] [blame]

109

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

110

The object takes the form of:

111

Dan O'Meara

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

[diff] [blame]

112

{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud

Bu Sun Kim

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

[diff] [blame]

113

# services, along with a list of requirements necessary for the label to be

114

# applied.

115

"custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.

116

# to represent the necessary conditions for the level to apply to a request.

117

# See CEL spec at: https://github.com/google/cel-spec

118

"expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.

119

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

120

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

121

#

122

# Example (Comparison):

123

#

124

# title: "Summary size limit"

125

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

126

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

127

#

128

# Example (Equality):

129

#

130

# title: "Requestor is owner"

131

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

132

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

#

# Example (Logic):

#

# title: "Public documents"

137

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

138

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

139

#

140

# Example (Data Manipulation):

141

#

142

# title: "Notification string"

143

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

144

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

145

#

146

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

147

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

148

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

149

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

150

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

151

# expression.

152

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

153

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

Bu Sun Kim

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

[diff] [blame]

154

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

155

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

156

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

157

# syntax.

Bu Sun Kim

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

[diff] [blame]

158

},

159

},

160

"title": "A String", # Human readable title. Must be unique within the Policy.

161

"name": "A String", # Required. Resource name for the Access Level. The `short_name` component

162

# must begin with a letter and only include alphanumeric and '_'. Format:

163

# `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length

164

# // of the `short_name` component is 50 characters.

165

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

Bu Sun Kim

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

[diff] [blame]

166

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

167

{ # A condition necessary for an `AccessLevel` to be granted. The Condition is an

168

# AND over its fields. So a Condition is true if: 1) the request IP is from one

169

# of the listed subnetworks AND 2) the originating device complies with the

170

# listed device policy AND 3) all listed access levels are granted AND 4) the

171

# request was sent at a time allowed by the DateTimeRestriction.

Bu Sun Kim

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

[diff] [blame]

172

"devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the

173

# Condition to be true. If not specified, all devices are allowed.

174

# given access level. A `DevicePolicy` specifies requirements for requests from

175

# devices to be granted access levels, it does not do any enforcement on the

176

# device. `DevicePolicy` acts as an AND over all specified fields, and each

177

# repeated field is an OR over its elements. Any unset fields are ignored. For

178

# example, if the proto is { os_type : DESKTOP_WINDOWS, os_type :

179

# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be

180

# true for requests originating from encrypted Linux desktops and encrypted

181

# Windows desktops.

Bu Sun Kim

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

[diff] [blame]

182

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management

183

# levels.

184

"A String",

Bu Sun Kim

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

[diff] [blame]

185

],

Bu Sun Kim

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

[diff] [blame]

186

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

187

{ # A restriction on the OS type and version of devices making requests.

Bu Sun Kim

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

[diff] [blame]

188

"requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.

189

# Verifications includes requirements that the device is enterprise-managed,

190

# conformant to domain policies, and the caller has permission to call

191

# the API targeted by the request.

Bu Sun Kim

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

[diff] [blame]

192

"minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS

193

# satisfies the constraint. Format: `"major.minor.patch"`.

194

# Examples: `"10.5.301"`, `"9.2.1"`.

195

"osType": "A String", # Required. The allowed OS type.

Bu Sun Kim

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

[diff] [blame]

196

},

Bu Sun Kim

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

[diff] [blame]

197

],

Bu Sun Kim

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

[diff] [blame]

198

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

199

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

200

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.

201

# Defaults to `false`.

202

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

203

"A String",

204

],

Bu Sun Kim

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

[diff] [blame]

205

},

Bu Sun Kim

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

[diff] [blame]

206

"members": [ # The request must be made by one of the provided user or service

207

# accounts. Groups are not supported.

208

# Syntax:

209

# `user:{emailid}`

210

# `serviceAccount:{emailid}`

211

# If not specified, a request may come from any user.

212

"A String",

213

],

214

"ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for

215

# a CIDR IP address block, the specified IP address portion must be properly

216

# truncated (i.e. all the host bits must be zero) or the input is considered

217

# malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is

218

# not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas

219

# "2001:db8::1/32" is not. The originating IP of a request must be in one of

220

# the listed subnets in order for this Condition to be true. If empty, all IP

221

# addresses are allowed.

222

"A String",

223

],

224

"negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over

225

# its non-empty fields, each field must be false for the Condition overall to

226

# be satisfied. Defaults to false.

Bu Sun Kim

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

[diff] [blame]

227

"regions": [ # The request must originate from one of the provided countries/regions.

228

# Must be valid ISO 3166-1 alpha-2 codes.

229

"A String",

230

],

231

"requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by

232

# resource name. Referencing an `AccessLevel` which does not exist is an

233

# error. All access levels listed must be granted for the Condition

234

# to be true. Example:

235

# "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`

236

"A String",

237

],

Dan O'Meara

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

[diff] [blame]

238

},

Bu Sun Kim

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

[diff] [blame]

239

],

Bu Sun Kim

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

[diff] [blame]

240

"combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is

241

# granted this `AccessLevel`. If AND is used, each `Condition` in

242

# `conditions` must be satisfied for the `AccessLevel` to be applied. If OR

243

# is used, at least one `Condition` in `conditions` must be satisfied for the

244

# `AccessLevel` to be applied. Default behavior is AND.

Bu Sun Kim

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

[diff] [blame]

245

},

246

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

247

}

Bu Sun Kim

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

[diff] [blame]

248

249

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

256

257

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

258

# network API call.

Bu Sun Kim

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

[diff] [blame]

259

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

Dan O'Meara

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

[diff] [blame]

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

263

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

264

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

265

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

266

#

267

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

268

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

269

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

270

# message types for APIs to use.

271

{

272

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

273

},

274

],

275

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

276

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

277

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

278

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

279

},

280

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

281

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

282

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

283

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

284

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

285

},

286

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

287

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

288

# available.

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

# `TakeSnapshotResponse`.

297

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

298

},

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>

304

<pre>Delete an Access Level by resource

305

name. The longrunning operation from this RPC will have a successful status

306

once the Access Level has been removed

307

from long-lasting storage.

308

309

Args:

310

name: string, Required. Resource name for the Access Level.

311

312

Format:

313

`accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)

314

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

321

322

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

323

# network API call.

Bu Sun Kim

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

[diff] [blame]

324

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

Dan O'Meara

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

[diff] [blame]

325

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

326

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

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

330

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

331

#

332

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

333

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

334

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

335

# message types for APIs to use.

336

{

337

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

338

},

339

],

340

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

341

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

342

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

343

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

344

},

345

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

346

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

347

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

348

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

349

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

350

},

351

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

352

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

353

# available.

Bu Sun Kim

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

[diff] [blame]

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

# `TakeSnapshotResponse`.

362

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

363

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

369

<pre>Get an Access Level by resource

name.

Args:

name: string, Required. Resource name for the Access Level.

374

375

Format:

376

`accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)

377

accessLevelFormat: string, Whether to return `BasicLevels` in the Cloud Common Expression

378

Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where

379

Access Levels

380

are returned as `BasicLevels` or `CustomLevels` based on how they were

381

created. If set to CEL, all Access Levels are returned as

382

`CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent

383

`CustomLevels`.

384

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

391

Dan O'Meara

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

[diff] [blame]

392

{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud

Bu Sun Kim

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

[diff] [blame]

393

# services, along with a list of requirements necessary for the label to be

394

# applied.

395

"custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.

396

# to represent the necessary conditions for the level to apply to a request.

397

# See CEL spec at: https://github.com/google/cel-spec

398

"expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.

399

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

400

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

401

#

402

# Example (Comparison):

403

#

404

# title: "Summary size limit"

405

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

406

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

407

#

408

# Example (Equality):

409

#

410

# title: "Requestor is owner"

411

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

412

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

#

# Example (Logic):

#

# title: "Public documents"

417

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

418

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

419

#

420

# Example (Data Manipulation):

421

#

422

# title: "Notification string"

423

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

424

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

425

#

426

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

427

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

428

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

429

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

430

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

431

# expression.

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

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

435

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

436

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

437

# syntax.

Bu Sun Kim

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

[diff] [blame]

438

},

439

},

440

"title": "A String", # Human readable title. Must be unique within the Policy.

441

"name": "A String", # Required. Resource name for the Access Level. The `short_name` component

442

# must begin with a letter and only include alphanumeric and '_'. Format:

443

# `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length

444

# // of the `short_name` component is 50 characters.

445

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

Bu Sun Kim

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

[diff] [blame]

446

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

447

{ # A condition necessary for an `AccessLevel` to be granted. The Condition is an

448

# AND over its fields. So a Condition is true if: 1) the request IP is from one

449

# of the listed subnetworks AND 2) the originating device complies with the

450

# listed device policy AND 3) all listed access levels are granted AND 4) the

451

# request was sent at a time allowed by the DateTimeRestriction.

Bu Sun Kim

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

[diff] [blame]

452

"devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the

453

# Condition to be true. If not specified, all devices are allowed.

454

# given access level. A `DevicePolicy` specifies requirements for requests from

455

# devices to be granted access levels, it does not do any enforcement on the

456

# device. `DevicePolicy` acts as an AND over all specified fields, and each

457

# repeated field is an OR over its elements. Any unset fields are ignored. For

458

# example, if the proto is { os_type : DESKTOP_WINDOWS, os_type :

459

# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be

460

# true for requests originating from encrypted Linux desktops and encrypted

461

# Windows desktops.

Bu Sun Kim

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

[diff] [blame]

462

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management

463

# levels.

464

"A String",

Bu Sun Kim

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

[diff] [blame]

465

],

Bu Sun Kim

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

[diff] [blame]

466

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

467

{ # A restriction on the OS type and version of devices making requests.

Bu Sun Kim

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

[diff] [blame]

468

"requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.

469

# Verifications includes requirements that the device is enterprise-managed,

470

# conformant to domain policies, and the caller has permission to call

471

# the API targeted by the request.

Bu Sun Kim

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

[diff] [blame]

472

"minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS

473

# satisfies the constraint. Format: `"major.minor.patch"`.

474

# Examples: `"10.5.301"`, `"9.2.1"`.

475

"osType": "A String", # Required. The allowed OS type.

Bu Sun Kim

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

[diff] [blame]

476

},

Bu Sun Kim

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

[diff] [blame]

477

],

Bu Sun Kim

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

[diff] [blame]

478

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

479

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

480

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.

481

# Defaults to `false`.

482

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

483

"A String",

484

],

Bu Sun Kim

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

[diff] [blame]

485

},

Bu Sun Kim

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

[diff] [blame]

486

"members": [ # The request must be made by one of the provided user or service

487

# accounts. Groups are not supported.

488

# Syntax:

489

# `user:{emailid}`

490

# `serviceAccount:{emailid}`

491

# If not specified, a request may come from any user.

492

"A String",

493

],

494

"ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for

495

# a CIDR IP address block, the specified IP address portion must be properly

496

# truncated (i.e. all the host bits must be zero) or the input is considered

497

# malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is

498

# not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas

499

# "2001:db8::1/32" is not. The originating IP of a request must be in one of

500

# the listed subnets in order for this Condition to be true. If empty, all IP

501

# addresses are allowed.

502

"A String",

503

],

504

"negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over

505

# its non-empty fields, each field must be false for the Condition overall to

506

# be satisfied. Defaults to false.

Bu Sun Kim

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

[diff] [blame]

507

"regions": [ # The request must originate from one of the provided countries/regions.

508

# Must be valid ISO 3166-1 alpha-2 codes.

509

"A String",

510

],

511

"requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by

512

# resource name. Referencing an `AccessLevel` which does not exist is an

513

# error. All access levels listed must be granted for the Condition

514

# to be true. Example:

515

# "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`

516

"A String",

517

],

Dan O'Meara

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

[diff] [blame]

518

},

Bu Sun Kim

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

[diff] [blame]

519

],

Bu Sun Kim

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

[diff] [blame]

520

"combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is

521

# granted this `AccessLevel`. If AND is used, each `Condition` in

522

# `conditions` must be satisfied for the `AccessLevel` to be applied. If OR

523

# is used, at least one `Condition` in `conditions` must be satisfied for the

524

# `AccessLevel` to be applied. Default behavior is AND.

Bu Sun Kim

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

[diff] [blame]

525

},

526

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

527

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

531

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

Bu Sun Kim

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

[diff] [blame]

532

<pre>List all Access Levels for an access

policy.

Args:

parent: string, Required. Resource name for the access policy to list Access Levels from.

537

538

Format:

539

`accessPolicies/{policy_id}` (required)

Bu Sun Kim

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

[diff] [blame]

540

accessLevelFormat: string, Whether to return `BasicLevels` in the Cloud Common Expression language, as

541

`CustomLevels`, rather than as `BasicLevels`. Defaults to returning

542

`AccessLevels` in the format they were defined.

Bu Sun Kim

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

[diff] [blame]

543

pageToken: string, Next page token for the next batch of Access Level instances.

544

Defaults to the first page of results.

545

pageSize: integer, Number of Access Levels to include in

546

the list. Default 100.

Bu Sun Kim

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

[diff] [blame]

547

x__xgafv: string, V1 error format.

548

Allowed values

549

1 - v1 error format

550

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

551

552

Returns:

553

An object of the form:

554

555

{ # A response to `ListAccessLevelsRequest`.

Bu Sun Kim

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

[diff] [blame]

556

"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is

Bu Sun Kim

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

[diff] [blame]

557

# empty, no further results remain.

Bu Sun Kim

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

[diff] [blame]

558

"accessLevels": [ # List of the Access Level instances.

Dan O'Meara

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

[diff] [blame]

559

{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud

Bu Sun Kim

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

[diff] [blame]

560

# services, along with a list of requirements necessary for the label to be

561

# applied.

562

"custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.

563

# to represent the necessary conditions for the level to apply to a request.

564

# See CEL spec at: https://github.com/google/cel-spec

565

"expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.

566

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

567

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

568

#

569

# Example (Comparison):

570

#

571

# title: "Summary size limit"

572

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

573

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

574

#

575

# Example (Equality):

576

#

577

# title: "Requestor is owner"

578

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

579

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

#

# Example (Logic):

#

# title: "Public documents"

584

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

585

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

586

#

587

# Example (Data Manipulation):

588

#

589

# title: "Notification string"

590

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

591

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

592

#

593

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

594

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

595

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

598

# expression.

599

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

600

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

Bu Sun Kim

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

[diff] [blame]

601

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

602

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

603

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

604

# syntax.

Dan O'Meara

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

[diff] [blame]

605

},

Bu Sun Kim

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

[diff] [blame]

606

},

Bu Sun Kim

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

[diff] [blame]

607

"title": "A String", # Human readable title. Must be unique within the Policy.

608

"name": "A String", # Required. Resource name for the Access Level. The `short_name` component

609

# must begin with a letter and only include alphanumeric and '_'. Format:

610

# `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length

611

# // of the `short_name` component is 50 characters.

612

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

Bu Sun Kim

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

[diff] [blame]

613

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

614

{ # A condition necessary for an `AccessLevel` to be granted. The Condition is an

615

# AND over its fields. So a Condition is true if: 1) the request IP is from one

616

# of the listed subnetworks AND 2) the originating device complies with the

617

# listed device policy AND 3) all listed access levels are granted AND 4) the

618

# request was sent at a time allowed by the DateTimeRestriction.

Bu Sun Kim

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

[diff] [blame]

619

"devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the

620

# Condition to be true. If not specified, all devices are allowed.

621

# given access level. A `DevicePolicy` specifies requirements for requests from

622

# devices to be granted access levels, it does not do any enforcement on the

623

# device. `DevicePolicy` acts as an AND over all specified fields, and each

624

# repeated field is an OR over its elements. Any unset fields are ignored. For

625

# example, if the proto is { os_type : DESKTOP_WINDOWS, os_type :

626

# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be

627

# true for requests originating from encrypted Linux desktops and encrypted

628

# Windows desktops.

Bu Sun Kim

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

[diff] [blame]

629

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management

# levels.

"A String",

],

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

634

{ # A restriction on the OS type and version of devices making requests.

Bu Sun Kim

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

[diff] [blame]

635

"requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.

636

# Verifications includes requirements that the device is enterprise-managed,

637

# conformant to domain policies, and the caller has permission to call

638

# the API targeted by the request.

Bu Sun Kim

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

[diff] [blame]

639

"minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS

640

# satisfies the constraint. Format: `"major.minor.patch"`.

641

# Examples: `"10.5.301"`, `"9.2.1"`.

642

"osType": "A String", # Required. The allowed OS type.

Bu Sun Kim

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

[diff] [blame]

643

},

644

],

Bu Sun Kim

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

[diff] [blame]

645

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

646

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

647

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.

648

# Defaults to `false`.

649

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

650

"A String",

651

],

Bu Sun Kim

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

[diff] [blame]

652

},

653

"members": [ # The request must be made by one of the provided user or service

654

# accounts. Groups are not supported.

655

# Syntax:

656

# `user:{emailid}`

657

# `serviceAccount:{emailid}`

658

# If not specified, a request may come from any user.

659

"A String",

660

],

661

"ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for

662

# a CIDR IP address block, the specified IP address portion must be properly

663

# truncated (i.e. all the host bits must be zero) or the input is considered

664

# malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is

665

# not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas

666

# "2001:db8::1/32" is not. The originating IP of a request must be in one of

667

# the listed subnets in order for this Condition to be true. If empty, all IP

668

# addresses are allowed.

669

"A String",

670

],

671

"negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over

672

# its non-empty fields, each field must be false for the Condition overall to

673

# be satisfied. Defaults to false.

Bu Sun Kim

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

[diff] [blame]

674

"regions": [ # The request must originate from one of the provided countries/regions.

675

# Must be valid ISO 3166-1 alpha-2 codes.

676

"A String",

677

],

678

"requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by

679

# resource name. Referencing an `AccessLevel` which does not exist is an

680

# error. All access levels listed must be granted for the Condition

681

# to be true. Example:

682

# "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`

683

"A String",

684

],

Bu Sun Kim

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

[diff] [blame]

685

},

686

],

Bu Sun Kim

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

[diff] [blame]

687

"combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is

688

# granted this `AccessLevel`. If AND is used, each `Condition` in

689

# `conditions` must be satisfied for the `AccessLevel` to be applied. If OR

690

# is used, at least one `Condition` in `conditions` must be satisfied for the

691

# `AccessLevel` to be applied. Default behavior is AND.

Bu Sun Kim

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

[diff] [blame]

692

},

693

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

694

},

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>

701

<pre>Retrieves the next page of results.

702

703

Args:

704

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

705

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

706

707

Returns:

Bu Sun Kim

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

[diff] [blame]

708

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]

709

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]

714

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

715

<pre>Update an Access Level. The longrunning

716

operation from this RPC will have a successful status once the changes to

717

the Access Level have propagated

718

to long-lasting storage. Access Levels containing

719

errors will result in an error response for the first error encountered.

720

721

Args:

722

name: string, Required. Resource name for the Access Level. The `short_name` component

Bu Sun Kim

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

[diff] [blame]

723

must begin with a letter and only include alphanumeric and '_'. Format:

Dan O'Meara

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

[diff] [blame]

724

`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length

725

// of the `short_name` component is 50 characters. (required)

726

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

727

The object takes the form of:

728

Dan O'Meara

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

[diff] [blame]

729

{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud

Bu Sun Kim

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

[diff] [blame]

730

# services, along with a list of requirements necessary for the label to be

731

# applied.

732

"custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.

733

# to represent the necessary conditions for the level to apply to a request.

734

# See CEL spec at: https://github.com/google/cel-spec

735

"expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.

736

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

737

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

738

#

739

# Example (Comparison):

740

#

741

# title: "Summary size limit"

742

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

743

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

744

#

745

# Example (Equality):

746

#

747

# title: "Requestor is owner"

748

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

749

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

#

# Example (Logic):

#

# title: "Public documents"

754

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

755

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

756

#

757

# Example (Data Manipulation):

758

#

759

# title: "Notification string"

760

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

761

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

762

#

763

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

764

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

765

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

766

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

767

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

768

# expression.

769

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

770

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

Bu Sun Kim

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

[diff] [blame]

771

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

772

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

773

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

774

# syntax.

Bu Sun Kim

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

[diff] [blame]

775

},

776

},

777

"title": "A String", # Human readable title. Must be unique within the Policy.

778

"name": "A String", # Required. Resource name for the Access Level. The `short_name` component

779

# must begin with a letter and only include alphanumeric and '_'. Format:

780

# `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length

781

# // of the `short_name` component is 50 characters.

782

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

Bu Sun Kim

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

[diff] [blame]

783

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

784

{ # A condition necessary for an `AccessLevel` to be granted. The Condition is an

785

# AND over its fields. So a Condition is true if: 1) the request IP is from one

786

# of the listed subnetworks AND 2) the originating device complies with the

787

# listed device policy AND 3) all listed access levels are granted AND 4) the

788

# request was sent at a time allowed by the DateTimeRestriction.

Bu Sun Kim

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

[diff] [blame]

789

"devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the

790

# Condition to be true. If not specified, all devices are allowed.

791

# given access level. A `DevicePolicy` specifies requirements for requests from

792

# devices to be granted access levels, it does not do any enforcement on the

793

# device. `DevicePolicy` acts as an AND over all specified fields, and each

794

# repeated field is an OR over its elements. Any unset fields are ignored. For

795

# example, if the proto is { os_type : DESKTOP_WINDOWS, os_type :

796

# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be

797

# true for requests originating from encrypted Linux desktops and encrypted

798

# Windows desktops.

Bu Sun Kim

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

[diff] [blame]

799

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management

800

# levels.

801

"A String",

Bu Sun Kim

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

[diff] [blame]

802

],

Bu Sun Kim

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

[diff] [blame]

803

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

804

{ # A restriction on the OS type and version of devices making requests.

Bu Sun Kim

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

[diff] [blame]

805

"requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.

806

# Verifications includes requirements that the device is enterprise-managed,

807

# conformant to domain policies, and the caller has permission to call

808

# the API targeted by the request.

Bu Sun Kim

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

[diff] [blame]

809

"minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS

810

# satisfies the constraint. Format: `"major.minor.patch"`.

811

# Examples: `"10.5.301"`, `"9.2.1"`.

812

"osType": "A String", # Required. The allowed OS type.

Bu Sun Kim

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

[diff] [blame]

813

},

Bu Sun Kim

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

[diff] [blame]

814

],

Bu Sun Kim

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

[diff] [blame]

815

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

816

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

817

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.

818

# Defaults to `false`.

819

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

820

"A String",

821

],

Bu Sun Kim

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

[diff] [blame]

822

},

Bu Sun Kim

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

[diff] [blame]

823

"members": [ # The request must be made by one of the provided user or service

824

# accounts. Groups are not supported.

825

# Syntax:

826

# `user:{emailid}`

827

# `serviceAccount:{emailid}`

828

# If not specified, a request may come from any user.

829

"A String",

830

],

831

"ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for

832

# a CIDR IP address block, the specified IP address portion must be properly

833

# truncated (i.e. all the host bits must be zero) or the input is considered

834

# malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is

835

# not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas

836

# "2001:db8::1/32" is not. The originating IP of a request must be in one of

837

# the listed subnets in order for this Condition to be true. If empty, all IP

838

# addresses are allowed.

839

"A String",

840

],

841

"negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over

842

# its non-empty fields, each field must be false for the Condition overall to

843

# be satisfied. Defaults to false.

Bu Sun Kim

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

[diff] [blame]

844

"regions": [ # The request must originate from one of the provided countries/regions.

845

# Must be valid ISO 3166-1 alpha-2 codes.

846

"A String",

847

],

848

"requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by

849

# resource name. Referencing an `AccessLevel` which does not exist is an

850

# error. All access levels listed must be granted for the Condition

851

# to be true. Example:

852

# "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`

853

"A String",

854

],

Dan O'Meara

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

[diff] [blame]

855

},

Bu Sun Kim

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

[diff] [blame]

856

],

Bu Sun Kim

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

[diff] [blame]

857

"combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is

858

# granted this `AccessLevel`. If AND is used, each `Condition` in

859

# `conditions` must be satisfied for the `AccessLevel` to be applied. If OR

860

# is used, at least one `Condition` in `conditions` must be satisfied for the

861

# `AccessLevel` to be applied. Default behavior is AND.

Bu Sun Kim

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

[diff] [blame]

862

},

863

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

864

}

Bu Sun Kim

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

[diff] [blame]

865

Dan O'Meara

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

[diff] [blame]

866

updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.

Bu Sun Kim

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

[diff] [blame]

867

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

874

875

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

876

# network API call.

Bu Sun Kim

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

[diff] [blame]

877

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

Dan O'Meara

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

[diff] [blame]

878

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

879

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

Bu Sun Kim

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

[diff] [blame]

880

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

881

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

882

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

883

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

884

#

885

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

886

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

887

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

888

# message types for APIs to use.

889

{

890

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

891

},

892

],

893

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

894

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

895

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

896

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

897

},

898

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

899

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

900

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

901

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

902

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

903

},

904

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

905

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

906

# available.

Bu Sun Kim

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

[diff] [blame]

907

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

908

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

909

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

910

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

911

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

912

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

913

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

914

# `TakeSnapshotResponse`.

915

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

916

},

Bu Sun Kim