Blame - docs/dyn/servicemanagement_v1.services.html - platform/external/python/google-api-python-client

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

[diff] [blame]

188

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

189

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

190

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

191

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

Bu Sun Kim

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

[diff] [blame]

192

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

193

},

Bu Sun Kim

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

[diff] [blame]

194

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

Dan O'Meara

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

[diff] [blame]

195

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

196

# available.

Bu Sun Kim

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

[diff] [blame]

197

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

Dan O'Meara

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

[diff] [blame]

198

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

199

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

200

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

201

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

202

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

203

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

204

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

205

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

Dan O'Meara

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

[diff] [blame]

206

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

211

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

212

<pre>Deletes a managed service. This method will change the service to the

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

213

`Soft-Delete` state for 30 days. Within this period, service producers may

214

call UndeleteService to restore the service.

215

After 30 days, the service will be permanently deleted.

216

Dan O'Meara

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

[diff] [blame]

217

Operation<response: google.protobuf.Empty>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

218

219

Args:

Dan O'Meara

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

[diff] [blame]

220

serviceName: string, Required. The name of the service. See the [overview](/service-management/overview)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

221

for naming requirements. For example: `example.googleapis.com`. (required)

222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

229

230

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

231

# network API call.

Bu Sun Kim

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

[diff] [blame]

232

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

233

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

234

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

235

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

236

#

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

# message types for APIs to use.

245

{

246

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

},

],

},

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

251

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

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

254

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

255

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

256

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

Bu Sun Kim

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

[diff] [blame]

257

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

258

},

Bu Sun Kim

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

[diff] [blame]

259

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

Dan O'Meara

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

[diff] [blame]

260

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

261

# available.

Bu Sun Kim

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

[diff] [blame]

262

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

Dan O'Meara

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

[diff] [blame]

263

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

264

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

265

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

266

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

267

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

268

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

269

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

270

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

Dan O'Meara

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

[diff] [blame]

271

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

276

<code class="details" id="disable">disable(serviceName, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

277

<pre>Disables a service for a project, so it can no longer be

278

be used for the project. It prevents accidental usage that may cause

279

unexpected billing charges or security leaks.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

280

Dan O'Meara

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

[diff] [blame]

281

Operation<response: DisableServiceResponse>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

282

283

Args:

Dan O'Meara

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

[diff] [blame]

284

serviceName: string, Required. Name of the service to disable. Specifying an unknown service name

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

285

will cause the request to fail. (required)

Dan O'Meara

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

[diff] [blame]

286

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

287

The object takes the form of:

288

289

{ # Request message for DisableService method.

Bu Sun Kim

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

[diff] [blame]

290

"consumerId": "A String", # Required. The identity of consumer resource which service disablement will be

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

291

# applied to.

292

#

293

# The Google Service Management implementation accepts the following

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

294

# forms:

Bu Sun Kim

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

[diff] [blame]

295

# - "project:<project_id>"

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

296

#

297

# Note: this is made compatible with

298

# google.api.servicecontrol.v1.Operation.consumer_id.

299

}

300

301

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

308

309

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

310

# network API call.

Bu Sun Kim

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

[diff] [blame]

311

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

312

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

313

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

314

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

315

#

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

# message types for APIs to use.

324

{

325

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

},

],

},

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

330

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

331

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

Bu Sun Kim

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

[diff] [blame]

332

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

333

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

334

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

335

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

Bu Sun Kim

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

[diff] [blame]

336

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

337

},

Bu Sun Kim

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

[diff] [blame]

338

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

Dan O'Meara

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

[diff] [blame]

339

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

340

# available.

Bu Sun Kim

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

[diff] [blame]

341

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

Dan O'Meara

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

[diff] [blame]

342

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

343

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

344

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

345

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

346

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

347

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

348

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

349

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

Dan O'Meara

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

[diff] [blame]

350

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

355

<code class="details" id="enable">enable(serviceName, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

356

<pre>Enables a service for a project, so it can be used

357

for the project. See

358

[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for

359

more information.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

360

Dan O'Meara

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

[diff] [blame]

361

Operation<response: EnableServiceResponse>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

362

363

Args:

Dan O'Meara

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

[diff] [blame]

364

serviceName: string, Required. Name of the service to enable. Specifying an unknown service name will

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

365

cause the request to fail. (required)

Dan O'Meara

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

[diff] [blame]

366

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

367

The object takes the form of:

368

369

{ # Request message for EnableService method.

Bu Sun Kim

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

[diff] [blame]

370

"consumerId": "A String", # Required. The identity of consumer resource which service enablement will be

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

371

# applied to.

372

#

373

# The Google Service Management implementation accepts the following

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

374

# forms:

Bu Sun Kim

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

[diff] [blame]

375

# - "project:<project_id>"

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

376

#

377

# Note: this is made compatible with

378

# google.api.servicecontrol.v1.Operation.consumer_id.

379

}

380

381

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

388

389

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

390

# network API call.

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

393

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

394

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

395

#

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

# message types for APIs to use.

404

{

405

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

},

],

},

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

410

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

411

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

Bu Sun Kim

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

[diff] [blame]

412

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

413

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

414

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

415

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

Bu Sun Kim

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

[diff] [blame]

416

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

417

},

Bu Sun Kim

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

[diff] [blame]

418

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

Dan O'Meara

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

[diff] [blame]

419

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

420

# available.

Bu Sun Kim

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

[diff] [blame]

421

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

Dan O'Meara

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

[diff] [blame]

422

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

423

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

424

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

425

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

426

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

427

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

428

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

429

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

Dan O'Meara

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

[diff] [blame]

430

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

435

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

436

<pre>Generates and returns a report (errors, warnings and changes from

437

existing configurations) associated with

438

GenerateConfigReportRequest.new_value

439

440

If GenerateConfigReportRequest.old_value is specified,

441

GenerateConfigReportRequest will contain a single ChangeReport based on the

442

comparison between GenerateConfigReportRequest.new_value and

443

GenerateConfigReportRequest.old_value.

444

If GenerateConfigReportRequest.old_value is not specified, this method

445

will compare GenerateConfigReportRequest.new_value with the last pushed

446

service configuration.

447

448

Args:

Dan O'Meara

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

[diff] [blame]

449

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

450

The object takes the form of:

451

452

{ # Request message for GenerateConfigReport method.

Bu Sun Kim

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

[diff] [blame]

453

"oldConfig": { # Optional. Service configuration against which the comparison will be done.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

454

# For this version of API, the supported types are

455

# google.api.servicemanagement.v1.ConfigRef,

456

# google.api.servicemanagement.v1.ConfigSource,

457

# and google.api.Service

Bu Sun Kim

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

[diff] [blame]

458

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

459

},

Bu Sun Kim

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

[diff] [blame]

460

"newConfig": { # Required. Service configuration for which we want to generate the report.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

461

# For this version of API, the supported types are

462

# google.api.servicemanagement.v1.ConfigRef,

463

# google.api.servicemanagement.v1.ConfigSource,

464

# and google.api.Service

Bu Sun Kim

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

[diff] [blame]

465

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

Jon Wayne Parrott

2016-08-16 12:44:29 -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:

476

477

{ # Response message for GenerateConfigReport method.

Bu Sun Kim

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

[diff] [blame]

478

"changeReports": [ # list of ChangeReport, each corresponding to comparison between two

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

479

# service configurations.

480

{ # Change report associated with a particular service configuration.

481

#

482

# It contains a list of ConfigChanges based on the comparison between

483

# two service configurations.

Bu Sun Kim

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

[diff] [blame]

484

"configChanges": [ # List of changes between two service configurations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

485

# The changes will be alphabetically sorted based on the identifier

486

# of each change.

487

# A ConfigChange identifier is a dot separated path to the configuration.

Bu Sun Kim

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

[diff] [blame]

488

# Example: visibility.rules[selector='LibraryService.CreateBook'].restriction

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

489

{ # Output generated from semantically comparing two versions of a service

490

# configuration.

491

#

492

# Includes detailed information about a field that have changed with

493

# applicable advice about potential consequences for the change, such as

494

# backwards-incompatibility.

Bu Sun Kim

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

[diff] [blame]

495

"changeType": "A String", # The type for this change, either ADDED, REMOVED, or MODIFIED.

496

"newValue": "A String", # Value of the changed object in the new Service configuration,

497

# in JSON format. This field will not be populated if ChangeType == REMOVED.

498

"advices": [ # Collection of advice provided for this change, useful for determining the

499

# possible impact of this change.

500

{ # Generated advice about this change, used for providing more

501

# information about how a change will affect the existing service.

502

"description": "A String", # Useful description for why this advice was applied and what actions should

503

# be taken to mitigate any implied risks.

504

},

505

],

506

"oldValue": "A String", # Value of the changed object in the old Service configuration,

507

# in JSON format. This field will not be populated if ChangeType == ADDED.

Bu Sun Kim

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

[diff] [blame]

508

"element": "A String", # Object hierarchy path to the change, with levels separated by a '.'

509

# character. For repeated fields, an applicable unique identifier field is

510

# used for the index (usually selector, name, or id). For maps, the term

511

# 'key' is used. If the field has no unique identifier, the numeric index

512

# is used.

513

# Examples:

514

# - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction

515

# - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value

516

# - logging.producer_destinations[0]

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame]

521

"serviceName": "A String", # Name of the service this report belongs to.

Bu Sun Kim

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

[diff] [blame]

522

"diagnostics": [ # Errors / Linter warnings associated with the service definition this

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

523

# report

524

# belongs to.

525

{ # Represents a diagnostic message (error or warning)

Bu Sun Kim

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

[diff] [blame]

526

"message": "A String", # Message describing the error or warning.

527

"location": "A String", # File name and line number of the error or warning.

Bu Sun Kim

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

[diff] [blame]

528

"kind": "A String", # The kind of diagnostic information provided.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

529

},

530

],

Bu Sun Kim

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

[diff] [blame]

531

"id": "A String", # ID of the service configuration this report belongs to.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

536

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

537

<pre>Gets a managed service. Authentication is required unless the service is

538

public.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

539

540

Args:

Dan O'Meara

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

[diff] [blame]

541

serviceName: string, Required. The name of the service. See the `ServiceManager` overview for naming

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

542

requirements. For example: `example.googleapis.com`. (required)

543

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

550

551

{ # The full representation of a Service that is managed by

552

# Google Service Management.

Bu Sun Kim

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

[diff] [blame]

553

"serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

554

# for naming requirements.

Bu Sun Kim

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

[diff] [blame]

555

"producerProjectId": "A String", # ID of the project that produces and owns this service.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

560

<code class="details" id="getConfig">getConfig(serviceName, configId=None, view=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

561

<pre>Gets a service configuration (version) for a managed service.

562

563

Args:

Dan O'Meara

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

[diff] [blame]

564

serviceName: string, Required. The name of the service. See the [overview](/service-management/overview)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

565

for naming requirements. For example: `example.googleapis.com`. (required)

Dan O'Meara

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

[diff] [blame]

566

configId: string, Required. The id of the service configuration resource.

Bu Sun Kim

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

[diff] [blame]

567

568

This field must be specified for the server to return all fields, including

569

`SourceInfo`.

Bu Sun Kim

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

[diff] [blame]

570

view: string, Specifies which parts of the Service Config should be returned in the

571

response.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

572

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

579

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

580

{ # `Service` is the root object of Google service configuration schema. It

581

# describes basic information about a service, such as the name and the

582

# title, and delegates other aspects to sub-sections. Each sub-section is

583

# either a proto message or a repeated proto message that configures a

584

# specific aspect, such as auth. See each proto message definition for details.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

#

# Example:

#

# type: google.api.Service

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

589

# config_version: 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

590

# name: calendar.googleapis.com

591

# title: Google Calendar API

592

# apis:

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

593

# - name: google.calendar.v3.Calendar

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

594

# authentication:

595

# providers:

596

# - id: google_calendar_auth

597

# jwks_uri: https://www.googleapis.com/oauth2/v1/certs

598

# issuer: https://securetoken.google.com

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

599

# rules:

Bu Sun Kim

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

[diff] [blame]

600

# - selector: "*"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

601

# requirements:

602

# provider_id: google_calendar_auth

Bu Sun Kim

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

[diff] [blame]

603

"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.

604

# service controller handles features like abuse, quota, billing, logging,

605

# monitoring, etc.

606

"environment": "A String", # The service control environment to use. If empty, no control plane

607

# feature (like quota and billing) will be enabled.

Bu Sun Kim

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

[diff] [blame]

608

},

Bu Sun Kim

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

[diff] [blame]

609

"types": [ # A list of all proto message types included in this API service.

610

# Types referenced directly or indirectly by the `apis` are

611

# automatically included. Messages which are not referenced but

612

# shall be included, such as types used by the `google.protobuf.Any` type,

613

# should be listed here by name. Example:

614

#

615

# types:

616

# - name: google.protobuf.Int32

Bu Sun Kim

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

[diff] [blame]

617

{ # A protocol buffer message type.

Bu Sun Kim

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

[diff] [blame]

618

"fields": [ # The list of fields.

619

{ # A single field of a message type.

Bu Sun Kim

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

[diff] [blame]

620

"number": 42, # The field number.

Bu Sun Kim

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

[diff] [blame]

621

"name": "A String", # The field name.

Bu Sun Kim

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

[diff] [blame]

622

"kind": "A String", # The field type.

623

"jsonName": "A String", # The field JSON name.

Bu Sun Kim

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

[diff] [blame]

624

"cardinality": "A String", # The field cardinality.

Bu Sun Kim

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

[diff] [blame]

625

"options": [ # The protocol buffer options.

626

{ # A protocol buffer option, which can be attached to a message, field,

627

# enumeration, etc.

Bu Sun Kim

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

[diff] [blame]

628

"name": "A String", # The option's name. For protobuf built-in options (options defined in

629

# descriptor.proto), this is the short name. For example, `"map_entry"`.

630

# For custom options, it should be the fully-qualified name. For example,

631

# `"google.api.http"`.

Bu Sun Kim

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

[diff] [blame]

632

"value": { # The option's value packed in an Any message. If the value is a primitive,

633

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

634

# should be used. If the value is an enum, it should be stored as an int32

635

# value using the google.protobuf.Int32Value type.

636

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

637

},

Bu Sun Kim

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

[diff] [blame]

638

},

639

],

Bu Sun Kim

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

[diff] [blame]

640

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

641

"packed": True or False, # Whether to use alternative packed wire representation.

Bu Sun Kim

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

[diff] [blame]

642

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

643

# types. The first type has index 1; zero means the type is not in the list.

Bu Sun Kim

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

[diff] [blame]

644

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

645

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

Bu Sun Kim

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

[diff] [blame]

646

},

647

],

Bu Sun Kim

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

[diff] [blame]

648

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

649

"A String",

650

],

Bu Sun Kim

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

[diff] [blame]

651

"name": "A String", # The fully qualified message name.

652

"options": [ # The protocol buffer options.

653

{ # A protocol buffer option, which can be attached to a message, field,

654

# enumeration, etc.

655

"name": "A String", # The option's name. For protobuf built-in options (options defined in

656

# descriptor.proto), this is the short name. For example, `"map_entry"`.

657

# For custom options, it should be the fully-qualified name. For example,

658

# `"google.api.http"`.

659

"value": { # The option's value packed in an Any message. If the value is a primitive,

660

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

661

# should be used. If the value is an enum, it should be stored as an int32

662

# value using the google.protobuf.Int32Value type.

663

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

664

},

665

},

666

],

Bu Sun Kim

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

[diff] [blame]

667

"syntax": "A String", # The source syntax.

668

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

669

# protobuf element, like the file in which it is defined.

670

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

671

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

672

},

673

},

674

],

Bu Sun Kim

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

[diff] [blame]

675

"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.

676

"sourceFiles": [ # All files used during config generation.

677

{

678

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

"name": "A String", # The service name, which is a DNS-like logical identifier for the

683

# service, such as `calendar.googleapis.com`. The service name

684

# typically goes through DNS verification to make sure the owner

685

# of the service also owns the DNS name.

Bu Sun Kim

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

[diff] [blame]

686

"title": "A String", # The product title for this service.

Bu Sun Kim

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

[diff] [blame]

687

"logs": [ # Defines the logs used by this service.

688

{ # A description of a log type. Example in YAML format:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

689

#

Bu Sun Kim

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

[diff] [blame]

690

# - name: library.googleapis.com/activity_history

691

# description: The history of borrowing and returning library items.

692

# display_name: Activity

693

# labels:

694

# - key: /customer_id

695

# description: Identifier of a library customer

696

"labels": [ # The set of labels that are available to describe a specific log entry.

697

# Runtime requests that contain labels not specified here are

698

# considered invalid.

699

{ # A description of a label.

Bu Sun Kim

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

[diff] [blame]

700

"valueType": "A String", # The type of data that can be assigned to the label.

Bu Sun Kim

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

[diff] [blame]

701

"key": "A String", # The label key.

702

"description": "A String", # A human-readable description for the label.

Bu Sun Kim

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

[diff] [blame]

703

},

704

],

Bu Sun Kim

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

[diff] [blame]

705

"description": "A String", # A human-readable description of this log. This information appears in

706

# the documentation and can contain details.

707

"displayName": "A String", # The human-readable name for this log. This information appears on

708

# the user interface and should be concise.

Bu Sun Kim

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

[diff] [blame]

709

"name": "A String", # The name of the log. It must be less than 512 characters long and can

710

# include the following characters: upper- and lower-case alphanumeric

711

# characters [A-Za-z0-9], and punctuation characters including

712

# slash, underscore, hyphen, period [/_-.].

Bu Sun Kim

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

[diff] [blame]

713

},

714

],

Bu Sun Kim

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

[diff] [blame]

715

"metrics": [ # Defines the metrics used by this service.

716

{ # Defines a metric type and its schema. Once a metric descriptor is created,

717

# deleting or altering it stops data collection and makes the metric type's

718

# existing data unusable.

719

"type": "A String", # The metric type, including its DNS name prefix. The type is not

720

# URL-encoded. All user-defined metric types have the DNS name

721

# `custom.googleapis.com` or `external.googleapis.com`. Metric types should

722

# use a natural hierarchical grouping. For example:

723

#

724

# "custom.googleapis.com/invoice/paid/amount"

725

# "external.googleapis.com/prometheus/up"

726

# "appengine.googleapis.com/http/server/response_latencies"

727

"labels": [ # The set of labels that can be used to describe a specific

728

# instance of this metric type. For example, the

729

# `appengine.googleapis.com/http/server/response_latencies` metric

730

# type has a label for the HTTP response code, `response_code`, so

731

# you can look at latencies for successful responses or just

732

# for responses that failed.

733

{ # A description of a label.

734

"valueType": "A String", # The type of data that can be assigned to the label.

735

"key": "A String", # The label key.

736

"description": "A String", # A human-readable description for the label.

737

},

738

],

739

"description": "A String", # A detailed description of the metric, which can be used in documentation.

740

"monitoredResourceTypes": [ # Read-only. If present, then a time

741

# series, which is identified partially by

742

# a metric type and a MonitoredResourceDescriptor, that is associated

743

# with this metric type can only be associated with one of the monitored

744

# resource types listed here.

745

"A String",

746

],

747

"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.

748

# Use sentence case without an ending period, for example "Request count".

749

# This field is optional but it is recommended to be set for any metrics

750

# associated with user-visible concepts, such as Quota.

751

"metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric.

752

"launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead.

753

"ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this

754

# age are guaranteed to be ingested and available to be read, excluding

755

# data loss due to errors.

756

"samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written

757

# periodically, consecutive data points are stored at this time interval,

758

# excluding data loss due to errors. Metrics with a higher granularity have

759

# a smaller sampling period.

760

},

761

"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.

762

# Some combinations of `metric_kind` and `value_type` might not be supported.

763

"unit": "A String", # The units in which the metric value is reported. It is only applicable

764

# if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`

765

# defines the representation of the stored metric values.

766

#

767

# Different systems may scale the values to be more easily displayed (so a

768

# value of `0.02KBy` _might_ be displayed as `20By`, and a value of

769

# `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is

770

# `KBy`, then the value of the metric is always in thousands of bytes, no

771

# matter how it may be displayed..

772

#

773

# If you want a custom metric to record the exact number of CPU-seconds used

774

# by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is

775

# `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005

776

# CPU-seconds, then the value is written as `12005`.

777

#

778

# Alternatively, if you want a custom metric to record data in a more

779

# granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is

780

# `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),

781

# or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).

782

#

783

# The supported units are a subset of [The Unified Code for Units of

784

# Measure](http://unitsofmeasure.org/ucum.html) standard:

785

#

786

# **Basic units (UNIT)**

#

# * `bit` bit

# * `By` byte

# * `s` second

# * `min` minute

# * `h` hour

# * `d` day

#

# **Prefixes (PREFIX)**

#

# * `k` kilo (10^3)

# * `M` mega (10^6)

# * `G` giga (10^9)

# * `T` tera (10^12)

# * `P` peta (10^15)

# * `E` exa (10^18)

# * `Z` zetta (10^21)

804

# * `Y` yotta (10^24)

805

#

806

# * `m` milli (10^-3)

807

# * `u` micro (10^-6)

808

# * `n` nano (10^-9)

809

# * `p` pico (10^-12)

810

# * `f` femto (10^-15)

811

# * `a` atto (10^-18)

812

# * `z` zepto (10^-21)

813

# * `y` yocto (10^-24)

#

# * `Ki` kibi (2^10)

# * `Mi` mebi (2^20)

# * `Gi` gibi (2^30)

# * `Ti` tebi (2^40)

# * `Pi` pebi (2^50)

#

# **Grammar**

#

# The grammar also includes these connectors:

824

#

825

# * `/` division or ratio (as an infix operator). For examples,

826

# `kBy/{email}` or `MiBy/10ms` (although you should almost never

827

# have `/s` in a metric `unit`; rates should always be computed at

828

# query time from the underlying cumulative or delta value).

829

# * `.` multiplication or composition (as an infix operator). For

830

# examples, `GBy.d` or `k{watt}.h`.

831

#

832

# The grammar for a unit is as follows:

833

#

834

# Expression = Component { "." Component } { "/" Component } ;

835

#

836

# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]

# | Annotation

# | "1"

# ;

#

# Annotation = "{" NAME "}" ;

#

# Notes:

#

# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation

846

# is used alone, then the unit is equivalent to `1`. For examples,

847

# `{request}/s == 1/s`, `By{transmitted}/s == By/s`.

848

# * `NAME` is a sequence of non-blank printable ASCII characters not

849

# containing `{` or `}`.

850

# * `1` represents a unitary [dimensionless

851

# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such

852

# as in `1/s`. It is typically used when none of the basic units are

853

# appropriate. For example, "new users per day" can be represented as

854

# `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new

855

# users). Alternatively, "thousands of page views per day" would be

856

# represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric

857

# value of `5.3` would mean "5300 page views per day").

858

# * `%` represents dimensionless value of 1/100, and annotates values giving

859

# a percentage (so the metric values are typically in the range of 0..100,

860

# and a metric value `3` means "3 percent").

861

# * `10^2.%` indicates a metric contains a ratio, typically in the range

862

# 0..1, that will be multiplied by 100 and displayed as a percentage

863

# (so a metric value `0.03` means "3 percent").

864

"launchStage": "A String", # Optional. The launch stage of the metric definition.

865

"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.

866

# Some combinations of `metric_kind` and `value_type` might not be supported.

867

"name": "A String", # The resource name of the metric descriptor.

868

},

869

],

870

"enums": [ # A list of all enum types included in this API service. Enums

871

# referenced directly or indirectly by the `apis` are automatically

872

# included. Enums which are not referenced but shall be included

873

# should be listed here by name. Example:

874

#

875

# enums:

876

# - name: google.someapi.v1.SomeEnum

877

{ # Enum type definition.

878

"options": [ # Protocol buffer options.

879

{ # A protocol buffer option, which can be attached to a message, field,

880

# enumeration, etc.

881

"name": "A String", # The option's name. For protobuf built-in options (options defined in

882

# descriptor.proto), this is the short name. For example, `"map_entry"`.

883

# For custom options, it should be the fully-qualified name. For example,

884

# `"google.api.http"`.

885

"value": { # The option's value packed in an Any message. If the value is a primitive,

886

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

887

# should be used. If the value is an enum, it should be stored as an int32

888

# value using the google.protobuf.Int32Value type.

889

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

},

},

],

"name": "A String", # Enum type name.

894

"syntax": "A String", # The source syntax.

895

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

896

# protobuf element, like the file in which it is defined.

897

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

898

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

899

},

900

"enumvalue": [ # Enum value definitions.

901

{ # Enum value definition.

902

"name": "A String", # Enum value name.

903

"number": 42, # Enum value number.

904

"options": [ # Protocol buffer options.

905

{ # A protocol buffer option, which can be attached to a message, field,

906

# enumeration, etc.

907

"name": "A String", # The option's name. For protobuf built-in options (options defined in

908

# descriptor.proto), this is the short name. For example, `"map_entry"`.

909

# For custom options, it should be the fully-qualified name. For example,

910

# `"google.api.http"`.

911

"value": { # The option's value packed in an Any message. If the value is a primitive,

912

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

913

# should be used. If the value is an enum, it should be stored as an int32

914

# value using the google.protobuf.Int32Value type.

915

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

},

},

],

},

],

},

],

"authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.

924

#

925

# Example for an API targeted for external use:

926

#

927

# name: calendar.googleapis.com

928

# authentication:

929

# providers:

930

# - id: google_calendar_auth

931

# jwks_uri: https://www.googleapis.com/oauth2/v1/certs

932

# issuer: https://securetoken.google.com

# rules:

# - selector: "*"

# requirements:

# provider_id: google_calendar_auth

937

"rules": [ # A list of authentication rules that apply to individual API methods.

938

#

939

# **NOTE:** All service configuration rules follow "last one wins" order.

940

{ # Authentication rules for the service.

941

#

942

# By default, if a method has any authentication requirements, every request

943

# must include a valid credential matching one of the requirements.

944

# It's an error to include more than one kind of credential in a single

945

# request.

946

#

947

# If a method doesn't have any auth requirements, request credentials will be

948

# ignored.

949

"oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.

950

# there are scopes defined for "Read-only access to Google Calendar" and

951

# "Access to Cloud Platform". Users can consent to a scope for an application,

952

# giving it permission to access that data on their behalf.

953

#

954

# OAuth scope specifications should be fairly coarse grained; a user will need

955

# to see and understand the text description of what your scope means.

956

#

957

# In most cases: use one or at most two OAuth scopes for an entire family of

958

# products. If your product has multiple APIs, you should probably be sharing

959

# the OAuth scope across all of those APIs.

960

#

961

# When you need finer grained OAuth consent screens: talk with your product

962

# management about how developers will use them in practice.

963

#

964

# Please note that even though each of the canonical scopes is enough for a

965

# request to be accepted and passed to the backend, a request can still fail

966

# due to the backend requiring additional scopes or permissions.

967

"canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An

968

# OAuth token containing any of these scopes will be accepted.

#

# Example:

#

# canonical_scopes: https://www.googleapis.com/auth/calendar,

973

# https://www.googleapis.com/auth/calendar.read

974

},

975

"requirements": [ # Requirements for additional authentication providers.

976

{ # User-defined authentication requirements, including support for

977

# [JSON Web Token

978

# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

979

"audiences": "A String", # NOTE: This will be deprecated soon, once AuthProvider.audiences is

980

# implemented and accepted in all the runtime components.

981

#

982

# The list of JWT

983

# [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).

984

# that are allowed to access. A JWT containing any of these audiences will

985

# be accepted. When this setting is absent, only JWTs with audience

986

# "https://Service_name/API_name"

987

# will be accepted. For example, if no audiences are in the setting,

988

# LibraryService API will only accept JWTs with the following audience

989

# "https://library-example.googleapis.com/google.example.library.v1.LibraryService".

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

994

# bookstore_web.apps.googleusercontent.com

995

"providerId": "A String", # id from authentication provider.

#

# Example:

#

# provider_id: bookstore_auth

1000

},

1001

],

1002

"allowWithoutCredential": True or False, # If true, the service accepts API keys without any other credential.

1003

"selector": "A String", # Selects the methods to which this rule applies.

1004

#

1005

# Refer to selector for syntax details.

1006

},

1007

],

1008

"providers": [ # Defines a set of authentication providers that a service supports.

1009

{ # Configuration for an authentication provider, including support for

1010

# [JSON Web Token

1011

# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

1012

"audiences": "A String", # The list of JWT

1013

# [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).

1014

# that are allowed to access. A JWT containing any of these audiences will

1015

# be accepted. When this setting is absent, JWTs with audiences:

1016

# - "https://[service.name]/[google.protobuf.Api.name]"

1017

# - "https://[service.name]/"

1018

# will be accepted.

1019

# For example, if no audiences are in the setting, LibraryService API will

1020

# accept JWTs with the following audiences:

1021

# -

1022

# https://library-example.googleapis.com/google.example.library.v1.LibraryService

1023

# - https://library-example.googleapis.com/

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

1028

# bookstore_web.apps.googleusercontent.com

1029

"jwtLocations": [ # Defines the locations to extract the JWT.

1030

#

1031

# JWT locations can be either from HTTP headers or URL query parameters.

1032

# The rule is that the first match wins. The checking order is: checking

1033

# all headers first, then URL query parameters.

1034

#

1035

# If not specified, default to use following 3 locations:

1036

# 1) Authorization: Bearer

1037

# 2) x-goog-iap-jwt-assertion

1038

# 3) access_token query parameter

1039

#

1040

# Default locations can be specified as followings:

1041

# jwt_locations:

1042

# - header: Authorization

1043

# value_prefix: "Bearer "

1044

# - header: x-goog-iap-jwt-assertion

1045

# - query: access_token

1046

{ # Specifies a location to extract JWT from an API request.

1047

"query": "A String", # Specifies URL query parameter name to extract JWT token.

1048

"header": "A String", # Specifies HTTP header name to extract JWT token.

1049

"valuePrefix": "A String", # The value prefix. The value format is "value_prefix{token}"

1050

# Only applies to "in" header type. Must be empty for "in" query type.

1051

# If not empty, the header value has to match (case sensitive) this prefix.

1052

# If not matched, JWT will not be extracted. If matched, JWT will be

1053

# extracted after the prefix is removed.

1054

#

1055

# For example, for "Authorization: Bearer {JWT}",

1056

# value_prefix="Bearer " with a space at the end.

1057

},

1058

],

1059

"issuer": "A String", # Identifies the principal that issued the JWT. See

1060

# https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1

1061

# Usually a URL or an email address.

1062

#

1063

# Example: https://securetoken.google.com

1064

# Example: 1234567-compute@developer.gserviceaccount.com

1065

"id": "A String", # The unique identifier of the auth provider. It will be referred to by

1066

# `AuthRequirement.provider_id`.

1067

#

1068

# Example: "bookstore_auth".

1069

"jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See

1070

# [OpenID

1071

# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).

1072

# Optional if the key set document:

1073

# - can be retrieved from

1074

# [OpenID

1075

# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of

1076

# the issuer.

1077

# - can be inferred from the email domain of the issuer (e.g. a Google

1078

# service account).

1079

#

1080

# Example: https://www.googleapis.com/oauth2/v1/certs

1081

"authorizationUrl": "A String", # Redirect URL if JWT token is required but not present or is expired.

1082

# Implement authorizationUrl of securityDefinitions in OpenAPI spec.

},

],

},

"documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.

1087

#

1088

# Example:

1089

# <pre><code>documentation:

1090

# summary: >

1091

# The Google Calendar API gives access

1092

# to most calendar features.

1093

# pages:

1094

# - name: Overview

1095

# content: &#40;== include google/foo/overview.md ==&#41;

1096

# - name: Tutorial

1097

# content: &#40;== include google/foo/tutorial.md ==&#41;

1098

# subpages;

1099

# - name: Java

1100

# content: &#40;== include google/foo/tutorial_java.md ==&#41;

1101

# rules:

1102

# - selector: google.calendar.Calendar.Get

1103

# description: >

1104

# ...

1105

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1110

# standard markdown features, definition lists, tables and fenced

1111

# code blocks are supported. Section headers can be provided and are

1112

# interpreted relative to the section nesting of the context where

1113

# a documentation fragment is embedded.

1114

#

1115

# Documentation from the IDL is merged with documentation defined

1116

# via the config at normalization time, where documentation provided

1117

# by config rules overrides IDL provided.

1118

#

1119

# A number of constructs specific to the API platform are supported

1120

# in documentation text.

1121

#

1122

# In order to reference a proto element, the following

1123

# notation can be used:

1124

# <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>

1125

# To override the display text used for the link, this can be used:

1126

# <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>

1127

# Text can be excluded from doc using the following notation:

1128

# <pre><code>&#40;-- internal comment --&#41;</code></pre>

1129

#

1130

# A few directives are available in documentation. Note that

1131

# directives must appear on a single line to be properly

1132

# identified. The `include` directive includes a markdown file from

1133

# an external source:

1134

# <pre><code>&#40;== include path/to/file ==&#41;</code></pre>

1135

# The `resource_for` directive marks a message to be the resource of

1136

# a collection in REST view. If it is not specified, tools attempt

1137

# to infer the resource from the operations in a collection:

1138

# <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>

1139

# The directive `suppress_warning` does not directly affect documentation

1140

# and is documented together with service config validation.

1141

"documentationRootUrl": "A String", # The URL to the root of documentation.

1142

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name

1143

# from the yaml file) is not suitable. This can be seen in any fully

1144

# specified service urls as well as sections that show a base that other

1145

# urls are relative to.

1146

"rules": [ # A list of documentation rules that apply to individual API elements.

1147

#

1148

# **NOTE:** All service configuration rules follow "last one wins" order.

1149

{ # A documentation rule provides information about individual API elements.

1150

"description": "A String", # Description of the selected API(s).

1151

"deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if

1152

# an element is marked as `deprecated`.

1153

"selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a

1154

# qualified name of the element which may end in "*", indicating a wildcard.

1155

# Wildcards are only allowed at the end and for a whole component of the

1156

# qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A

1157

# wildcard will match one or more components. To specify a default for all

1158

# applicable elements, the whole pattern "*" is used.

1159

},

1160

],

1161

"pages": [ # The top level pages for the documentation set.

1162

{ # Represents a documentation page. A page can contain subpages to represent

1163

# nested documentation set structure.

1164

"name": "A String", # The name of the page. It will be used as an identity of the page to

1165

# generate URI of the page, text of the link to this page in navigation,

1166

# etc. The full page name (start from the root page name to this page

1167

# concatenated with `.`) can be used as reference to the page in your

1168

# documentation. For example:

1169

# <pre><code>pages:

1170

# - name: Tutorial

1171

# content: &#40;== include tutorial.md ==&#41;

1172

# subpages:

1173

# - name: Java

1174

# content: &#40;== include tutorial_java.md ==&#41;

1175

# </code></pre>

1176

# You can reference `Java` page using Markdown reference link syntax:

1177

# `Java`.

1178

"subpages": [ # Subpages of this page. The order of subpages specified here will be

1179

# honored in the generated docset.

1180

# Object with schema name: Page

1181

],

1182

"content": "A String", # The Markdown content of the page. You can use <code>&#40;== include {path}

1183

# ==&#41;</code> to include content from a Markdown file.

1184

},

1185

],

1186

"summary": "A String", # A short summary of what the service does. Can only be provided by

1187

# plain text.

1188

"overview": "A String", # Declares a single overview page. For example:

1189

# <pre><code>documentation:

1190

# summary: ...

1191

# overview: &#40;== include overview.md ==&#41;

1192

# </code></pre>

1193

# This is a shortcut for the following declaration (using pages style):

1194

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

# content: &#40;== include overview.md ==&#41;

1199

# </code></pre>

1200

# Note: you cannot specify both `overview` field and `pages` field.

1201

},

Bu Sun Kim

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

[diff] [blame]

1202

"apis": [ # A list of API interfaces exported by this service. Only the `name` field

1203

# of the google.protobuf.Api needs to be provided by the configuration

1204

# author, as the remaining fields will be derived from the IDL during the

1205

# normalization process. It is an error to specify an API interface here

1206

# which cannot be resolved against the associated IDL files.

1207

{ # Api is a light-weight descriptor for an API Interface.

1208

#

1209

# Interfaces are also described as "protocol buffer services" in some contexts,

1210

# such as by the "service" keyword in a .proto file, but they are different

1211

# from API Services, which represent a concrete implementation of an interface

1212

# as opposed to simply a description of methods and bindings. They are also

1213

# sometimes simply referred to as "APIs" in other contexts, such as the name of

1214

# this message itself. See https://cloud.google.com/apis/design/glossary for

1215

# detailed terminology.

1216

"options": [ # Any metadata attached to the interface.

1217

{ # A protocol buffer option, which can be attached to a message, field,

1218

# enumeration, etc.

Bu Sun Kim

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

[diff] [blame]

1219

"name": "A String", # The option's name. For protobuf built-in options (options defined in

1220

# descriptor.proto), this is the short name. For example, `"map_entry"`.

1221

# For custom options, it should be the fully-qualified name. For example,

1222

# `"google.api.http"`.

Bu Sun Kim

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

[diff] [blame]

1223

"value": { # The option's value packed in an Any message. If the value is a primitive,

1224

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

1225

# should be used. If the value is an enum, it should be stored as an int32

1226

# value using the google.protobuf.Int32Value type.

1227

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

1228

},

Bu Sun Kim

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

[diff] [blame]

1229

},

1230

],

Bu Sun Kim

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

[diff] [blame]

1231

"syntax": "A String", # The source syntax of the service.

Bu Sun Kim

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

[diff] [blame]

1232

"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this

1233

# message.

1234

# protobuf element, like the file in which it is defined.

1235

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1236

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1237

},

Bu Sun Kim

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

[diff] [blame]

1238

"mixins": [ # Included interfaces. See Mixin.

1239

{ # Declares an API Interface to be included in this interface. The including

1240

# interface must redeclare all the methods from the included interface, but

1241

# documentation and options are inherited as follows:

1242

#

1243

# - If after comment and whitespace stripping, the documentation

1244

# string of the redeclared method is empty, it will be inherited

1245

# from the original method.

1246

#

1247

# - Each annotation belonging to the service config (http,

1248

# visibility) which is not set in the redeclared method will be

1249

# inherited.

1250

#

1251

# - If an http annotation is inherited, the path pattern will be

1252

# modified as follows. Any version prefix will be replaced by the

1253

# version of the including interface plus the root path if

1254

# specified.

1255

#

1256

# Example of a simple mixin:

1257

#

1258

# package google.acl.v1;

1259

# service AccessControl {

1260

# // Get the underlying ACL object.

1261

# rpc GetAcl(GetAclRequest) returns (Acl) {

1262

# option (google.api.http).get = "/v1/{resource=**}:getAcl";

# }

# }

#

# package google.storage.v2;

1267

# service Storage {

1268

# // rpc GetAcl(GetAclRequest) returns (Acl);

1269

#

1270

# // Get a data record.

1271

# rpc GetData(GetDataRequest) returns (Data) {

1272

# option (google.api.http).get = "/v2/{resource=**}";

# }

# }

#

# Example of a mixin configuration:

1277

#

1278

# apis:

1279

# - name: google.storage.v2.Storage

1280

# mixins:

1281

# - name: google.acl.v1.AccessControl

1282

#

1283

# The mixin construct implies that all methods in `AccessControl` are

1284

# also declared with same name and request/response types in

1285

# `Storage`. A documentation generator or annotation processor will

1286

# see the effective `Storage.GetAcl` method after inherting

1287

# documentation and annotations as follows:

1288

#

1289

# service Storage {

1290

# // Get the underlying ACL object.

1291

# rpc GetAcl(GetAclRequest) returns (Acl) {

1292

# option (google.api.http).get = "/v2/{resource=**}:getAcl";

# }

# ...

# }

#

# Note how the version in the path pattern changed from `v1` to `v2`.

1298

#

1299

# If the `root` field in the mixin is specified, it should be a

1300

# relative path under which inherited HTTP paths are placed. Example:

1301

#

1302

# apis:

1303

# - name: google.storage.v2.Storage

1304

# mixins:

1305

# - name: google.acl.v1.AccessControl

1306

# root: acls

1307

#

1308

# This implies the following inherited HTTP annotation:

1309

#

1310

# service Storage {

1311

# // Get the underlying ACL object.

1312

# rpc GetAcl(GetAclRequest) returns (Acl) {

1313

# option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";

# }

# ...

# }

"name": "A String", # The fully qualified name of the interface which is included.

1318

"root": "A String", # If non-empty specifies a path under which inherited HTTP paths

1319

# are rooted.

1320

},

1321

],

Bu Sun Kim

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

[diff] [blame]

1322

"version": "A String", # A version string for this interface. If specified, must have the form

1323

# `major-version.minor-version`, as in `1.10`. If the minor version is

1324

# omitted, it defaults to zero. If the entire version field is empty, the

1325

# major version is derived from the package name, as outlined below. If the

1326

# field is not empty, the version in the package name will be verified to be

1327

# consistent with what is provided here.

1328

#

1329

# The versioning schema uses [semantic

1330

# versioning](http://semver.org) where the major version number

1331

# indicates a breaking change and the minor version an additive,

1332

# non-breaking change. Both version numbers are signals to users

1333

# what to expect from different versions, and should be carefully

1334

# chosen based on the product plan.

1335

#

1336

# The major version is also reflected in the package name of the

1337

# interface, which must end in `v<major-version>`, as in

1338

# `google.feature.v1`. For major versions 0 and 1, the suffix can

1339

# be omitted. Zero major versions must only be used for

1340

# experimental, non-GA interfaces.

1341

"methods": [ # The methods of this interface, in unspecified order.

1342

{ # Method represents a method of an API interface.

1343

"requestTypeUrl": "A String", # A URL of the input message type.

1344

"name": "A String", # The simple name of this method.

1345

"responseStreaming": True or False, # If true, the response is streamed.

1346

"requestStreaming": True or False, # If true, the request is streamed.

1347

"options": [ # Any metadata attached to the method.

Bu Sun Kim

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

[diff] [blame]

1348

{ # A protocol buffer option, which can be attached to a message, field,

1349

# enumeration, etc.

Bu Sun Kim

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

[diff] [blame]

1350

"name": "A String", # The option's name. For protobuf built-in options (options defined in

1351

# descriptor.proto), this is the short name. For example, `"map_entry"`.

1352

# For custom options, it should be the fully-qualified name. For example,

1353

# `"google.api.http"`.

Bu Sun Kim

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

[diff] [blame]

1354

"value": { # The option's value packed in an Any message. If the value is a primitive,

1355

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

1356

# should be used. If the value is an enum, it should be stored as an int32

1357

# value using the google.protobuf.Int32Value type.

1358

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

1359

},

Bu Sun Kim

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

[diff] [blame]

1360

},

1361

],

Bu Sun Kim

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

[diff] [blame]

1362

"syntax": "A String", # The source syntax of this method.

1363

"responseTypeUrl": "A String", # The URL of the output message type.

Bu Sun Kim

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

[diff] [blame]

1364

},

1365

],

Bu Sun Kim

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

[diff] [blame]

1366

"name": "A String", # The fully qualified name of this interface, including package name

1367

# followed by the interface's simple name.

Bu Sun Kim

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

[diff] [blame]

1368

},

1369

],

Bu Sun Kim

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

[diff] [blame]

1370

"customError": { # Customize service error responses. For example, list any service # Custom error configuration.

1371

# specific protobuf types that can appear in error detail lists of

# error responses.

#

# Example:

#

# custom_error:

# types:

# - google.foo.v1.CustomError

1379

# - google.foo.v1.AnotherError

1380

"types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

1381

"A String",

1382

],

1383

"rules": [ # The list of custom error rules that apply to individual API messages.

1384

#

1385

# **NOTE:** All service configuration rules follow "last one wins" order.

1386

{ # A custom error rule.

1387

"isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,

1388

# objects of this type will be filtered when they appear in error payload.

1389

"selector": "A String", # Selects messages to which this rule applies.

1390

#

1391

# Refer to selector for syntax details.

Bu Sun Kim

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

[diff] [blame]

1392

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1393

],

1394

},

Bu Sun Kim

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

[diff] [blame]

1395

"id": "A String", # A unique ID for a specific instance of this message, typically assigned

1396

# by the client for tracking purpose. Must be no longer than 63 characters

1397

# and only lower case letters, digits, '.', '_' and '-' are allowed. If

1398

# empty, the server may choose to generate one instead.

1399

"usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.

1400

"requirements": [ # Requirements that must be satisfied before a consumer project can use the

1401

# service. Each requirement is of the form <service.name>/<requirement-id>;

1402

# for example 'serviceusage.googleapis.com/billing-enabled'.

1403

"A String",

1404

],

1405

"rules": [ # A list of usage rules that apply to individual API methods.

1406

#

1407

# **NOTE:** All service configuration rules follow "last one wins" order.

1408

{ # Usage configuration rules for the service.

1409

#

1410

# NOTE: Under development.

1411

#

1412

#

1413

# Use this rule to configure unregistered calls for the service. Unregistered

1414

# calls are calls that do not contain consumer project identity.

1415

# (Example: calls that do not contain an API key).

1416

# By default, API methods do not allow unregistered calls, and each method call

1417

# must be identified by a consumer project identity. Use this rule to

1418

# allow/disallow unregistered calls.

1419

#

1420

# Example of an API that wants to allow unregistered calls for entire service.

#

# usage:

# rules:

# - selector: "*"

# allow_unregistered_calls: true

1426

#

1427

# Example of a method that wants to allow unregistered calls.

#

# usage:

# rules:

# - selector: "google.example.library.v1.LibraryService.CreateBook"

1432

# allow_unregistered_calls: true

1433

"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all

1434

# methods in all APIs.

1435

#

1436

# Refer to selector for syntax details.

1437

"allowUnregisteredCalls": True or False, # If true, the selected method allows unregistered calls, e.g. calls

1438

# that don't identify any user or application.

1439

"skipServiceControl": True or False, # If true, the selected method should skip service control and the control

1440

# plane features, such as quota and billing, will not be available.

1441

# This flag is used by Google Cloud Endpoints to bypass checks for internal

1442

# methods, such as service health check methods.

1443

},

1444

],

1445

"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the

1446

# service producer.

1447

#

1448

# Google Service Management currently only supports

1449

# [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification

1450

# channel. To use Google Cloud Pub/Sub as the channel, this must be the name

1451

# of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format

1452

# documented in https://cloud.google.com/pubsub/docs/overview.

1453

"serviceIdentity": { # The per-product per-project service identity for a service. # The configuration of a per-product per-project service identity.

1454

#

1455

#

1456

# Use this field to configure per-product per-project service identity.

1457

# Example of a service identity configuration.

#

# usage:

# service_identity:

# - service_account_parent: "projects/123456789"

1462

# display_name: "Cloud XXX Service Agent"

1463

# description: "Used as the identity of Cloud XXX to access resources"

1464

"displayName": "A String", # Optional. A user-specified name for the service account.

1465

# Must be less than or equal to 100 UTF-8 bytes.

1466

"description": "A String", # Optional. A user-specified opaque description of the service account.

1467

# Must be less than or equal to 256 UTF-8 bytes.

1468

"serviceAccountParent": "A String", # A service account project that hosts the service accounts.

1469

#

1470

# An example name would be:

1471

# `projects/123456789`

1472

},

1473

},

1474

"endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint

1475

# with the same name as the service is automatically generated to service all

1476

# defined APIs.

1477

{ # `Endpoint` describes a network endpoint that serves a set of APIs.

1478

# A service may expose any number of endpoints, and all endpoints share the

1479

# same service configuration, such as quota configuration and monitoring

1480

# configuration.

1481

#

1482

# Example service configuration:

1483

#

1484

# name: library-example.googleapis.com

1485

# endpoints:

1486

# # Below entry makes 'google.example.library.v1.Library'

1487

# # API be served from endpoint address library-example.googleapis.com.

1488

# # It also allows HTTP OPTIONS calls to be passed to the backend, for

1489

# # it to decide whether the subsequent cross-origin request is

1490

# # allowed to proceed.

1491

# - name: library-example.googleapis.com

1492

# allow_cors: true

1493

"name": "A String", # The canonical name of this endpoint.

1494

"target": "A String", # The specification of an Internet routable address of API frontend that will

1495

# handle requests to this [API

1496

# Endpoint](https://cloud.google.com/apis/design/glossary). It should be

1497

# either a valid IPv4 address or a fully-qualified domain name. For example,

1498

# "8.8.8.8" or "myservice.appspot.com".

1499

"allowCors": True or False, # Allowing

1500

# [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka

1501

# cross-domain traffic, would allow the backends served from this endpoint to

1502

# receive and respond to HTTP OPTIONS requests. The response will be used by

1503

# the browser to determine whether the subsequent cross-origin request is

1504

# allowed to proceed.

1505

"features": [ # The list of features enabled on this endpoint.

1506

"A String",

1507

],

1508

"aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,

1509

# please specify multiple google.api.Endpoint for each of the intended

1510

# aliases.

1511

#

1512

# Additional names that this endpoint will be hosted on.

"A String",

],

},

],

"configVersion": 42, # The semantic version of the service configuration. The config version

1518

# affects the interpretation of the service configuration. For example,

1519

# certain features are enabled by default for certain config versions.

1520

#

1521

# The latest config version is `3`.

Bu Sun Kim

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

[diff] [blame]

1522

"http": { # Defines the HTTP configuration for an API service. It contains a list of # HTTP configuration.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1523

# HttpRule, each specifying the mapping of an RPC method

1524

# to one or more HTTP REST API methods.

Bu Sun Kim

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

[diff] [blame]

1525

"rules": [ # A list of HTTP configuration rules that apply to individual API methods.

1526

#

1527

# **NOTE:** All service configuration rules follow "last one wins" order.

Bu Sun Kim

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

[diff] [blame]

1528

{ # # gRPC Transcoding

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1529

#

Bu Sun Kim

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

[diff] [blame]

1530

# gRPC Transcoding is a feature for mapping between a gRPC method and one or

1531

# more HTTP REST endpoints. It allows developers to build a single API service

1532

# that supports both gRPC APIs and REST APIs. Many systems, including [Google

1533

# APIs](https://github.com/googleapis/googleapis),

1534

# [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC

1535

# Gateway](https://github.com/grpc-ecosystem/grpc-gateway),

1536

# and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature

1537

# and use it for large scale production services.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1538

#

Bu Sun Kim

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

[diff] [blame]

1539

# `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies

1540

# how different portions of the gRPC request message are mapped to the URL

1541

# path, URL query parameters, and HTTP request body. It also controls how the

1542

# gRPC response message is mapped to the HTTP response body. `HttpRule` is

1543

# typically specified as an `google.api.http` annotation on the gRPC method.

1544

#

1545

# Each mapping specifies a URL path template and an HTTP method. The path

1546

# template may refer to one or more fields in the gRPC request message, as long

1547

# as each field is a non-repeated field with a primitive (non-message) type.

1548

# The path template controls how fields of the request message are mapped to

1549

# the URL path.

1550

#

1551

# Example:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1552

#

1553

# service Messaging {

1554

# rpc GetMessage(GetMessageRequest) returns (Message) {

Bu Sun Kim

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

[diff] [blame]

1555

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame]

1556

# get: "/v1/{name=messages/*}"

Bu Sun Kim

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

[diff] [blame]

1557

# };

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1558

# }

1559

# }

1560

# message GetMessageRequest {

Bu Sun Kim

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

[diff] [blame]

1561

# string name = 1; // Mapped to URL path.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1562

# }

1563

# message Message {

Bu Sun Kim

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

[diff] [blame]

1564

# string text = 1; // The resource content.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1565

# }

1566

#

Bu Sun Kim

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

[diff] [blame]

1567

# This enables an HTTP REST to gRPC mapping as below:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1568

#

Bu Sun Kim

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

[diff] [blame]

1569

# HTTP | gRPC

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1570

# -----|-----

Bu Sun Kim

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

[diff] [blame]

1571

# `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1572

#

Bu Sun Kim

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

[diff] [blame]

1573

# Any fields in the request message which are not bound by the path template

1574

# automatically become HTTP query parameters if there is no HTTP request body.

1575

# For example:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1576

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1577

# service Messaging {

1578

# rpc GetMessage(GetMessageRequest) returns (Message) {

Bu Sun Kim

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

[diff] [blame]

1579

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame]

1580

# get:"/v1/messages/{message_id}"

Bu Sun Kim

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

[diff] [blame]

1581

# };

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1582

# }

1583

# }

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1584

# message GetMessageRequest {

1585

# message SubMessage {

1586

# string subfield = 1;

1587

# }

Bu Sun Kim

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

[diff] [blame]

1588

# string message_id = 1; // Mapped to URL path.

1589

# int64 revision = 2; // Mapped to URL query parameter `revision`.

1590

# SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1591

# }

1592

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1593

# This enables a HTTP JSON to RPC mapping as below:

1594

#

Bu Sun Kim

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

[diff] [blame]

1595

# HTTP | gRPC

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1596

# -----|-----

Dan O'Meara

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

[diff] [blame]

1597

# `GET /v1/messages/123456?revision=2&sub.subfield=foo` |

Bu Sun Kim

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

[diff] [blame]

1598

# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:

1599

# "foo"))`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1600

#

Bu Sun Kim

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

[diff] [blame]

1601

# Note that fields which are mapped to URL query parameters must have a

1602

# primitive type or a repeated primitive type or a non-repeated message type.

1603

# In the case of a repeated type, the parameter can be repeated in the URL

Dan O'Meara

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

[diff] [blame]

1604

# as `...?param=A&param=B`. In the case of a message type, each field of the

Bu Sun Kim

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

[diff] [blame]

1605

# message is mapped to a separate parameter, such as

Dan O'Meara

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

[diff] [blame]

1606

# `...?foo.a=A&foo.b=B&foo.c=C`.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1607

#

Bu Sun Kim

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

[diff] [blame]

1608

# For HTTP methods that allow a request body, the `body` field

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1609

# specifies the mapping. Consider a REST update method on the

1610

# message resource collection:

1611

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1612

# service Messaging {

1613

# rpc UpdateMessage(UpdateMessageRequest) returns (Message) {

1614

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame]

1615

# patch: "/v1/messages/{message_id}"

1616

# body: "message"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

# };

# }

# }

# message UpdateMessageRequest {

1621

# string message_id = 1; // mapped to the URL

1622

# Message message = 2; // mapped to the body

1623

# }

1624

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1625

# The following HTTP JSON to RPC mapping is enabled, where the

1626

# representation of the JSON in the request body is determined by

1627

# protos JSON encoding:

1628

#

Bu Sun Kim

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

[diff] [blame]

1629

# HTTP | gRPC

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1630

# -----|-----

Bu Sun Kim

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

[diff] [blame]

1631

# `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:

1632

# "123456" message { text: "Hi!" })`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1633

#

1634

# The special name `*` can be used in the body mapping to define that

1635

# every field not bound by the path template should be mapped to the

1636

# request body. This enables the following alternative definition of

1637

# the update method:

1638

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1639

# service Messaging {

1640

# rpc UpdateMessage(Message) returns (Message) {

1641

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame]

1642

# patch: "/v1/messages/{message_id}"

1643

# body: "*"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

# };

# }

# }

# message Message {

# string message_id = 1;

1649

# string text = 2;

1650

# }

1651

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1652

#

1653

# The following HTTP JSON to RPC mapping is enabled:

1654

#

Bu Sun Kim

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

[diff] [blame]

1655

# HTTP | gRPC

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1656

# -----|-----

Bu Sun Kim

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

[diff] [blame]

1657

# `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:

1658

# "123456" text: "Hi!")`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1659

#

1660

# Note that when using `*` in the body mapping, it is not possible to

1661

# have HTTP parameters, as all fields not bound by the path end in

Bu Sun Kim

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

[diff] [blame]

1662

# the body. This makes this option more rarely used in practice when

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1663

# defining REST APIs. The common usage of `*` is in custom methods

Bu Sun Kim

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

[diff] [blame]

1664

# which don't use the URL at all for transferring data.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1665

#

1666

# It is possible to define multiple HTTP methods for one RPC by using

1667

# the `additional_bindings` option. Example:

1668

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1669

# service Messaging {

1670

# rpc GetMessage(GetMessageRequest) returns (Message) {

1671

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame]

1672

# get: "/v1/messages/{message_id}"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1673

# additional_bindings {

Bu Sun Kim

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

[diff] [blame]

1674

# get: "/v1/users/{user_id}/messages/{message_id}"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1675

# }

1676

# };

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1677

# }

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1678

# }

1679

# message GetMessageRequest {

1680

# string message_id = 1;

1681

# string user_id = 2;

1682

# }

1683

#

Bu Sun Kim

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

[diff] [blame]

1684

# This enables the following two alternative HTTP JSON to RPC mappings:

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1685

#

Bu Sun Kim

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

[diff] [blame]

1686

# HTTP | gRPC

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1687

# -----|-----

Bu Sun Kim

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

[diff] [blame]

1688

# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`

1689

# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:

1690

# "123456")`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1691

#

Bu Sun Kim

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

[diff] [blame]

1692

# ## Rules for HTTP mapping

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1693

#

Bu Sun Kim

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

[diff] [blame]

1694

# 1. Leaf request fields (recursive expansion nested messages in the request

1695

# message) are classified into three categories:

1696

# - Fields referred by the path template. They are passed via the URL path.

1697

# - Fields referred by the HttpRule.body. They are passed via the HTTP

1698

# request body.

1699

# - All other fields are passed via the URL query parameters, and the

1700

# parameter name is the field path in the request message. A repeated

1701

# field can be represented as multiple query parameters under the same

1702

# name.

Bu Sun Kim

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

[diff] [blame]

1703

# 2. If HttpRule.body is "*", there is no URL query parameter, all fields

Bu Sun Kim

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

[diff] [blame]

1704

# are passed via URL path and HTTP request body.

1705

# 3. If HttpRule.body is omitted, there is no HTTP request body, all

1706

# fields are passed via URL path and URL query parameters.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1707

#

Bu Sun Kim

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

[diff] [blame]

1708

# ### Path template syntax

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1709

#

Bu Sun Kim

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

[diff] [blame]

1710

# Template = "/" Segments [ Verb ] ;

1711

# Segments = Segment { "/" Segment } ;

1712

# Segment = "*" | "**" | LITERAL | Variable ;

1713

# Variable = "{" FieldPath [ "=" Segments ] "}" ;

1714

# FieldPath = IDENT { "." IDENT } ;

1715

# Verb = ":" LITERAL ;

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1716

#

Bu Sun Kim

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

[diff] [blame]

1717

# The syntax `*` matches a single URL path segment. The syntax `**` matches

1718

# zero or more URL path segments, which must be the last part of the URL path

1719

# except the `Verb`.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1720

#

Bu Sun Kim

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

[diff] [blame]

1721

# The syntax `Variable` matches part of the URL path as specified by its

1722

# template. A variable template must not contain other variables. If a variable

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1723

# matches a single path segment, its template may be omitted, e.g. `{var}`

1724

# is equivalent to `{var=*}`.

1725

#

Bu Sun Kim

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

[diff] [blame]

1726

# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`

1727

# contains any reserved character, such characters should be percent-encoded

1728

# before the matching.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1729

#

Bu Sun Kim

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

[diff] [blame]

1730

# If a variable contains exactly one path segment, such as `"{var}"` or

1731

# `"{var=*}"`, when such a variable is expanded into a URL path on the client

Bu Sun Kim

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

[diff] [blame]

1732

# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The

1733

# server side does the reverse decoding. Such variables show up in the

1734

# [Discovery

1735

# Document](https://developers.google.com/discovery/v1/reference/apis) as

1736

# `{var}`.

1737

#

Bu Sun Kim

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

[diff] [blame]

1738

# If a variable contains multiple path segments, such as `"{var=foo/*}"`

1739

# or `"{var=**}"`, when such a variable is expanded into a URL path on the

Bu Sun Kim

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

[diff] [blame]

1740

# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.

Bu Sun Kim

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

[diff] [blame]

1741

# The server side does the reverse decoding, except "%2F" and "%2f" are left

Bu Sun Kim

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

[diff] [blame]

1742

# unchanged. Such variables show up in the

1743

# [Discovery

1744

# Document](https://developers.google.com/discovery/v1/reference/apis) as

1745

# `{+var}`.

1746

#

1747

# ## Using gRPC API Service Configuration

1748

#

1749

# gRPC API Service Configuration (service config) is a configuration language

1750

# for configuring a gRPC service to become a user-facing product. The

1751

# service config is simply the YAML representation of the `google.api.Service`

1752

# proto message.

1753

#

1754

# As an alternative to annotating your proto file, you can configure gRPC

1755

# transcoding in your service config YAML files. You do this by specifying a

1756

# `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same

1757

# effect as the proto annotation. This can be particularly useful if you

1758

# have a proto that is reused in multiple services. Note that any transcoding

1759

# specified in the service config will override any matching transcoding

1760

# configuration in the proto.

#

# Example:

#

# http:

# rules:

# # Selects a gRPC method and applies HttpRule to it.

1767

# - selector: example.v1.Messaging.GetMessage

1768

# get: /v1/messages/{message_id}/{sub.subfield}

#

# ## Special notes

#

# When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the

1773

# proto to JSON conversion must follow the [proto3

1774

# specification](https://developers.google.com/protocol-buffers/docs/proto3#json).

1775

#

1776

# While the single segment variable follows the semantics of

1777

# [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String

1778

# Expansion, the multi segment variable **does not** follow RFC 6570 Section

1779

# 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion

1780

# does not expand special characters like `?` and `#`, which would lead

1781

# to invalid URLs. As the result, gRPC Transcoding uses a custom encoding

1782

# for multi segment variables.

1783

#

1784

# The path variables **must not** refer to any repeated or mapped field,

1785

# because client libraries are not capable of handling such variable expansion.

1786

#

Bu Sun Kim

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

[diff] [blame]

1787

# The path variables **must not** capture the leading "/" character. The reason

1788

# is that the most common use case "{var}" does not capture the leading "/"

Bu Sun Kim

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

[diff] [blame]

1789

# character. For consistency, all path variables must share the same behavior.

1790

#

1791

# Repeated message fields must not be mapped to URL query parameters, because

1792

# no client library can support such complicated mapping.

1793

#

1794

# If an API needs to use a JSON array for request or response body, it can map

1795

# the request or response body to a repeated field. However, some gRPC

1796

# Transcoding implementations may not support this feature.

Bu Sun Kim

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

[diff] [blame]

1797

"selector": "A String", # Selects a method to which this rule applies.

1798

#

1799

# Refer to selector for syntax details.

1800

"put": "A String", # Maps to HTTP PUT. Used for replacing a resource.

1801

"custom": { # A custom pattern is used for defining custom HTTP verb. # The custom pattern is used for specifying an HTTP method that is not

1802

# included in the `pattern` field, such as HEAD, or "*" to leave the

1803

# HTTP method unspecified for this rule. The wild-card rule is useful

1804

# for services that provide content to Web (HTML) clients.

1805

"path": "A String", # The path matched by this custom verb.

1806

"kind": "A String", # The name of this custom HTTP verb.

1807

},

Bu Sun Kim

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

[diff] [blame]

1808

"responseBody": "A String", # Optional. The name of the response field whose value is mapped to the HTTP

Dan O'Meara

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

[diff] [blame]

1809

# response body. When omitted, the entire response message will be used

1810

# as the HTTP response body.

1811

#

1812

# NOTE: The referred field must be present at the top-level of the response

1813

# message type.

Bu Sun Kim

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

[diff] [blame]

1814

"allowHalfDuplex": True or False, # When this flag is set to true, HTTP requests will be allowed to invoke a

1815

# half-duplex streaming method.

1816

"additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must

1817

# not contain an `additional_bindings` field themselves (that is,

1818

# the nesting may only be one level deep).

1819

# Object with schema name: HttpRule

1820

],

1821

"patch": "A String", # Maps to HTTP PATCH. Used for updating a resource.

1822

"get": "A String", # Maps to HTTP GET. Used for listing and getting information about

1823

# resources.

1824

"post": "A String", # Maps to HTTP POST. Used for creating a resource or performing an action.

Bu Sun Kim

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

[diff] [blame]

1825

"body": "A String", # The name of the request field whose value is mapped to the HTTP request

1826

# body, or `*` for mapping all request fields not captured by the path

1827

# pattern to the HTTP body, or omitted for not having any HTTP request body.

1828

#

1829

# NOTE: the referred field must be present at the top-level of the request

1830

# message type.

Bu Sun Kim

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

[diff] [blame]

1831

"delete": "A String", # Maps to HTTP DELETE. Used for deleting a resource.

1832

},

1833

],

1834

"fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in

1835

# cases of single segment matches in reserved expansion, where "%2F" will be

1836

# left encoded.

1837

#

1838

# The default behavior is to not decode RFC 6570 reserved characters in multi

1839

# segment matches.

1840

},

1841

"billing": { # Billing related configuration of the service. # Billing configuration.

1842

#

1843

# The following example shows how to configure monitored resources and metrics

1844

# for billing, `consumer_destinations` is the only supported destination and

1845

# the monitored resources need at least one label key

1846

# `cloud.googleapis.com/location` to indicate the location of the billing

1847

# usage, using different monitored resources between monitoring and billing is

1848

# recommended so they can be evolved independently:

1849

#

1850

#

1851

# monitored_resources:

1852

# - type: library.googleapis.com/billing_branch

1853

# labels:

1854

# - key: cloud.googleapis.com/location

1855

# description: |

1856

# Predefined label to support billing location restriction.

1857

# - key: city

1858

# description: |

1859

# Custom label to define the city where the library branch is located

1860

# in.

1861

# - key: name

1862

# description: Custom label to define the name of the library branch.

1863

# metrics:

1864

# - name: library.googleapis.com/book/borrowed_count

# metric_kind: DELTA

# value_type: INT64

# unit: "1"

# billing:

# consumer_destinations:

1870

# - monitored_resource: library.googleapis.com/billing_branch

1871

# metrics:

1872

# - library.googleapis.com/book/borrowed_count

1873

"consumerDestinations": [ # Billing configurations for sending metrics to the consumer project.

1874

# There can be multiple consumer destinations per service, each one must have

1875

# a different monitored resource type. A metric can be used in at most

1876

# one consumer destination.

1877

{ # Configuration of a specific billing destination (Currently only support

1878

# bill against consumer project).

1879

"metrics": [ # Names of the metrics to report to this billing destination.

1880

# Each name must be defined in Service.metrics section.

1881

"A String",

1882

],

1883

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1884

# Service.monitored_resources section.

},

],

},

"systemTypes": [ # A list of all proto message types included in this API service.

1889

# It serves similar purpose as [google.api.Service.types], except that

1890

# these types are not needed by user-defined APIs. Therefore, they will not

1891

# show up in the generated discovery doc. This field should only be used

1892

# to define system APIs in ESF.

1893

{ # A protocol buffer message type.

1894

"fields": [ # The list of fields.

1895

{ # A single field of a message type.

1896

"number": 42, # The field number.

1897

"name": "A String", # The field name.

1898

"kind": "A String", # The field type.

1899

"jsonName": "A String", # The field JSON name.

1900

"cardinality": "A String", # The field cardinality.

1901

"options": [ # The protocol buffer options.

1902

{ # A protocol buffer option, which can be attached to a message, field,

1903

# enumeration, etc.

1904

"name": "A String", # The option's name. For protobuf built-in options (options defined in

1905

# descriptor.proto), this is the short name. For example, `"map_entry"`.

1906

# For custom options, it should be the fully-qualified name. For example,

1907

# `"google.api.http"`.

1908

"value": { # The option's value packed in an Any message. If the value is a primitive,

1909

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

1910

# should be used. If the value is an enum, it should be stored as an int32

1911

# value using the google.protobuf.Int32Value type.

1912

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

},

},

],

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1917

"packed": True or False, # Whether to use alternative packed wire representation.

1918

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1919

# types. The first type has index 1; zero means the type is not in the list.

1920

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1921

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

1922

},

Bu Sun Kim

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

[diff] [blame]

1923

],

1924

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1925

"A String",

1926

],

1927

"name": "A String", # The fully qualified message name.

1928

"options": [ # The protocol buffer options.

1929

{ # A protocol buffer option, which can be attached to a message, field,

1930

# enumeration, etc.

1931

"name": "A String", # The option's name. For protobuf built-in options (options defined in

1932

# descriptor.proto), this is the short name. For example, `"map_entry"`.

1933

# For custom options, it should be the fully-qualified name. For example,

1934

# `"google.api.http"`.

1935

"value": { # The option's value packed in an Any message. If the value is a primitive,

1936

# the corresponding wrapper type defined in google/protobuf/wrappers.proto

1937

# should be used. If the value is an enum, it should be stored as an int32

1938

# value using the google.protobuf.Int32Value type.

1939

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

},

},

],

"syntax": "A String", # The source syntax.

1944

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1945

# protobuf element, like the file in which it is defined.

1946

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1947

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

},

},

],

"logging": { # Logging configuration of the service. # Logging configuration.

1952

#

1953

# The following example shows how to configure logs to be sent to the

1954

# producer and consumer projects. In the example, the `activity_history`

1955

# log is sent to both the producer and consumer projects, whereas the

1956

# `purchase_history` log is only sent to the producer project.

1957

#

1958

# monitored_resources:

1959

# - type: library.googleapis.com/branch

1960

# labels:

1961

# - key: /city

1962

# description: The city where the library branch is located in.

1963

# - key: /name

1964

# description: The name of the branch.

1965

# logs:

1966

# - name: activity_history

1967

# labels:

1968

# - key: /customer_id

1969

# - name: purchase_history

1970

# logging:

1971

# producer_destinations:

1972

# - monitored_resource: library.googleapis.com/branch

# logs:

# - activity_history

# - purchase_history

# consumer_destinations:

1977

# - monitored_resource: library.googleapis.com/branch

1978

# logs:

1979

# - activity_history

1980

"consumerDestinations": [ # Logging configurations for sending logs to the consumer project.

1981

# There can be multiple consumer destinations, each one must have a

1982

# different monitored resource type. A log can be used in at most

1983

# one consumer destination.

1984

{ # Configuration of a specific logging destination (the producer project

1985

# or the consumer project).

1986

"monitoredResource": "A String", # The monitored resource type. The type must be defined in the

1987

# Service.monitored_resources section.

1988

"logs": [ # Names of the logs to be sent to this destination. Each name must

1989

# be defined in the Service.logs section. If the log name is

1990

# not a domain scoped name, it will be automatically prefixed with

1991

# the service name followed by "/".

"A String",

],

},

],

"producerDestinations": [ # Logging configurations for sending logs to the producer project.

1997

# There can be multiple producer destinations, each one must have a

1998

# different monitored resource type. A log can be used in at most

1999

# one producer destination.

2000

{ # Configuration of a specific logging destination (the producer project

2001

# or the consumer project).

2002

"monitoredResource": "A String", # The monitored resource type. The type must be defined in the

2003

# Service.monitored_resources section.

2004

"logs": [ # Names of the logs to be sent to this destination. Each name must

2005

# be defined in the Service.logs section. If the log name is

2006

# not a domain scoped name, it will be automatically prefixed with

2007

# the service name followed by "/".

"A String",

],

},

],

},

"monitoredResources": [ # Defines the monitored resources used by this service. This is required

2014

# by the Service.monitoring and Service.logging configurations.

2015

{ # An object that describes the schema of a MonitoredResource object using a

2016

# type name and a set of labels. For example, the monitored resource

2017

# descriptor for Google Compute Engine VM instances has a type of

2018

# `"gce_instance"` and specifies the use of the labels `"instance_id"` and

2019

# `"zone"` to identify particular VM instances.

2020

#

2021

# Different APIs can support different monitored resource types. APIs generally

2022

# provide a `list` method that returns the monitored resource descriptors used

2023

# by the API.

2024

"launchStage": "A String", # Optional. The launch stage of the monitored resource definition.

2025

"name": "A String", # Optional. The resource name of the monitored resource descriptor:

2026

# `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where

2027

# {type} is the value of the `type` field in this object and

2028

# {project_id} is a project ID that provides API-specific context for

2029

# accessing the type. APIs that do not use project information can use the

2030

# resource name format `"monitoredResourceDescriptors/{type}"`.

2031

"labels": [ # Required. A set of labels used to describe instances of this monitored

2032

# resource type. For example, an individual Google Cloud SQL database is

2033

# identified by values for the labels `"database_id"` and `"zone"`.

2034

{ # A description of a label.

2035

"valueType": "A String", # The type of data that can be assigned to the label.

2036

"key": "A String", # The label key.

2037

"description": "A String", # A human-readable description for the label.

2038

},

2039

],

2040

"type": "A String", # Required. The monitored resource type. For example, the type

2041

# `"cloudsql_database"` represents databases in Google Cloud SQL.

2042

# The maximum length of this value is 256 characters.

2043

"description": "A String", # Optional. A detailed description of the monitored resource type that might

2044

# be used in documentation.

2045

"displayName": "A String", # Optional. A concise name for the monitored resource type that might be

2046

# displayed in user interfaces. It should be a Title Cased Noun Phrase,

2047

# without any article or other determiners. For example,

2048

# `"Google Cloud SQL Database"`.

2049

},

2050

],

2051

"monitoring": { # Monitoring configuration of the service. # Monitoring configuration.

2052

#

2053

# The example below shows how to configure monitored resources and metrics

2054

# for monitoring. In the example, a monitored resource and two metrics are

2055

# defined. The `library.googleapis.com/book/returned_count` metric is sent

2056

# to both producer and consumer projects, whereas the

2057

# `library.googleapis.com/book/overdue_count` metric is only sent to the

2058

# consumer project.

2059

#

2060

# monitored_resources:

2061

# - type: library.googleapis.com/branch

2062

# labels:

2063

# - key: /city

2064

# description: The city where the library branch is located in.

2065

# - key: /name

2066

# description: The name of the branch.

2067

# metrics:

2068

# - name: library.googleapis.com/book/returned_count

# metric_kind: DELTA

# value_type: INT64

# labels:

# - key: /customer_id

2073

# - name: library.googleapis.com/book/overdue_count

# metric_kind: GAUGE

# value_type: INT64

# labels:

# - key: /customer_id

2078

# monitoring:

2079

# producer_destinations:

2080

# - monitored_resource: library.googleapis.com/branch

2081

# metrics:

2082

# - library.googleapis.com/book/returned_count

2083

# consumer_destinations:

2084

# - monitored_resource: library.googleapis.com/branch

2085

# metrics:

2086

# - library.googleapis.com/book/returned_count

2087

# - library.googleapis.com/book/overdue_count

2088

"producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.

2089

# There can be multiple producer destinations. A monitored resouce type may

2090

# appear in multiple monitoring destinations if different aggregations are

2091

# needed for different sets of metrics associated with that monitored

2092

# resource type. A monitored resource and metric pair may only be used once

2093

# in the Monitoring configuration.

2094

{ # Configuration of a specific monitoring destination (the producer project

2095

# or the consumer project).

2096

"metrics": [ # Types of the metrics to report to this monitoring destination.

2097

# Each type must be defined in Service.metrics section.

2098

"A String",

2099

],

2100

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

2101

# Service.monitored_resources section.

2102

},

2103

],

2104

"consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.

2105

# There can be multiple consumer destinations. A monitored resouce type may

2106

# appear in multiple monitoring destinations if different aggregations are

2107

# needed for different sets of metrics associated with that monitored

2108

# resource type. A monitored resource and metric pair may only be used once

2109

# in the Monitoring configuration.

2110

{ # Configuration of a specific monitoring destination (the producer project

2111

# or the consumer project).

2112

"metrics": [ # Types of the metrics to report to this monitoring destination.

2113

# Each type must be defined in Service.metrics section.

2114

"A String",

2115

],

2116

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

2117

# Service.monitored_resources section.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2118

},

2119

],

2120

},

Bu Sun Kim

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

[diff] [blame]

2121

"systemParameters": { # ### System parameter configuration # System parameter configuration.

2122

#

2123

# A system parameter is a special kind of parameter defined by the API

2124

# system, not by an individual API. It is typically mapped to an HTTP header

2125

# and/or a URL query parameter. This configuration specifies which methods

2126

# change the names of the system parameters.

2127

"rules": [ # Define system parameters.

Bu Sun Kim

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

[diff] [blame]

2128

#

Bu Sun Kim

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

[diff] [blame]

2129

# The parameters defined here will override the default parameters

2130

# implemented by the system. If this field is missing from the service

2131

# config, default system parameters will be used. Default system parameters

2132

# and names is implementation-dependent.

2133

#

2134

# Example: define api key for all methods

#

# system_parameters

# rules:

# - selector: "*"

# parameters:

# - name: api_key

# url_query_parameter: api_key

2142

#

2143

#

2144

# Example: define 2 api key names for a specific method.

#

# system_parameters

# rules:

# - selector: "/ListShelves"

2149

# parameters:

2150

# - name: api_key

2151

# http_header: Api-Key1

2152

# - name: api_key

2153

# http_header: Api-Key2

2154

#

2155

# **NOTE:** All service configuration rules follow "last one wins" order.

2156

{ # Define a system parameter rule mapping system parameter definitions to

2157

# methods.

2158

"parameters": [ # Define parameters. Multiple names may be defined for a parameter.

2159

# For a given method call, only one of them should be used. If multiple

2160

# names are used the behavior is implementation-dependent.

2161

# If none of the specified names are present the behavior is

2162

# parameter-dependent.

2163

{ # Define a parameter's name and location. The parameter may be passed as either

2164

# an HTTP header or a URL query parameter, and if both are passed the behavior

2165

# is implementation-dependent.

Bu Sun Kim

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

[diff] [blame]

2166

"name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.

2167

"urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case

2168

# sensitive.

Bu Sun Kim

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

[diff] [blame]

2169

"httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case

2170

# insensitive.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2171

},

Bu Sun Kim

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

[diff] [blame]

2172

],

2173

"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all

2174

# methods in all APIs.

2175

#

2176

# Refer to selector for syntax details.

2177

},

2178

],

2179

},

Bu Sun Kim

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

[diff] [blame]

2180

"quota": { # Quota configuration helps to achieve fairness and budgeting in service # Quota configuration.

2181

# usage.

2182

#

2183

# The metric based quota configuration works this way:

2184

# - The service configuration defines a set of metrics.

2185

# - For API calls, the quota.metric_rules maps methods to metrics with

2186

# corresponding costs.

2187

# - The quota.limits defines limits on the metrics, which will be used for

2188

# quota checks at runtime.

2189

#

2190

# An example quota configuration in yaml format:

#

# quota:

# limits:

#

# - name: apiWriteQpsPerProject

2196

# metric: library.googleapis.com/write_calls

2197

# unit: "1/min/{project}" # rate limit for consumer projects

# values:

# STANDARD: 10000

#

#

# # The metric rules bind all methods to the read_calls metric,

2203

# # except for the UpdateBook and DeleteBook methods. These two methods

2204

# # are mapped to the write_calls metric, with the UpdateBook method

2205

# # consuming at twice rate as the DeleteBook method.

# metric_rules:

# - selector: "*"

# metric_costs:

# library.googleapis.com/read_calls: 1

2210

# - selector: google.example.library.v1.LibraryService.UpdateBook

2211

# metric_costs:

2212

# library.googleapis.com/write_calls: 2

2213

# - selector: google.example.library.v1.LibraryService.DeleteBook

2214

# metric_costs:

2215

# library.googleapis.com/write_calls: 1

2216

#

2217

# Corresponding Metric definition:

2218

#

2219

# metrics:

2220

# - name: library.googleapis.com/read_calls

2221

# display_name: Read requests

# metric_kind: DELTA

# value_type: INT64

#

# - name: library.googleapis.com/write_calls

2226

# display_name: Write requests

# metric_kind: DELTA

# value_type: INT64

#

"limits": [ # List of `QuotaLimit` definitions for the service.

2231

{ # `QuotaLimit` defines a specific limit that applies over a specified duration

2232

# for a limit type. There can be at most one limit for a duration and limit

2233

# type combination defined within a `QuotaGroup`.

2234

"displayName": "A String", # User-visible display name for this limit.

2235

# Optional. If not set, the UI will provide a default display name based on

2236

# the quota configuration. This field can be used to override the default

2237

# display name generated from the configuration.

2238

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified

2239

# duration. Client application developers can override the default limit up

2240

# to this maximum. If specified, this value cannot be set to a value less

2241

# than the default limit. If not specified, it is set to the default limit.

Bu Sun Kim

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

[diff] [blame]

2242

#

Bu Sun Kim

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

[diff] [blame]

2243

# To allow clients to apply overrides with no upper bound, set this to -1,

2244

# indicating unlimited maximum quota.

Bu Sun Kim

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

[diff] [blame]

2245

#

Bu Sun Kim

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

[diff] [blame]

2246

# Used by group-based quotas only.

2247

"duration": "A String", # Duration of this limit in textual notation. Must be "100s" or "1d".

Bu Sun Kim

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

[diff] [blame]

2248

#

Bu Sun Kim

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

[diff] [blame]

2249

# Used by group-based quotas only.

2250

"freeTier": "A String", # Free tier value displayed in the Developers Console for this limit.

2251

# The free tier is the number of tokens that will be subtracted from the

2252

# billed amount when billing is enabled.

2253

# This field can only be set on a limit with duration "1d", in a billable

2254

# group; it is invalid on any other limit. If this field is not set, it

2255

# defaults to 0, indicating that there is no free tier for this service.

Bu Sun Kim

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

[diff] [blame]

2256

#

Bu Sun Kim

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

[diff] [blame]

2257

# Used by group-based quotas only.

2258

"unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as

2259

# Metric.unit. The supported unit kinds are determined by the quota

2260

# backend system.

Bu Sun Kim

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

[diff] [blame]

2261

#

Bu Sun Kim

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

[diff] [blame]

2262

# Here are some examples:

2263

# * "1/min/{project}" for quota per minute per project.

2264

#

2265

# Note: the order of unit components is insignificant.

2266

# The "1" at the beginning is required to follow the metric unit syntax.

2267

"defaultLimit": "A String", # Default number of tokens that can be consumed during the specified

2268

# duration. This is the number of tokens assigned when a client

2269

# application developer activates the service for his/her project.

2270

#

2271

# Specifying a value of 0 will block all requests. This can be used if you

2272

# are provisioning quota to selected consumers and blocking others.

2273

# Similarly, a value of -1 will indicate an unlimited quota. No other

2274

# negative values are allowed.

2275

#

2276

# Used by group-based quotas only.

2277

"values": { # Tiered limit values. You must specify this as a key:value pair, with an

2278

# integer value that is the maximum number of requests allowed for the

2279

# specified unit. Currently only STANDARD is supported.

2280

"a_key": "A String",

2281

},

2282

"name": "A String", # Name of the quota limit.

2283

#

2284

# The name must be provided, and it must be unique within the service. The

2285

# name can only include alphanumeric characters as well as '-'.

2286

#

2287

# The maximum length of the limit name is 64 characters.

2288

"metric": "A String", # The name of the metric this quota limit applies to. The quota limits with

2289

# the same metric will be checked together during runtime. The metric must be

2290

# defined within the service config.

2291

"description": "A String", # Optional. User-visible, extended description for this quota limit.

2292

# Should be used only when more context is needed to understand this limit

2293

# than provided by the limit's display name (see: `display_name`).

2294

},

2295

],

2296

"metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one

2297

# or more metrics.

2298

{ # Bind API methods to metrics. Binding a method to a metric causes that

2299

# metric's configured quota behaviors to apply to the method call.

2300

"metricCosts": { # Metrics to update when the selected methods are called, and the associated

2301

# cost applied to each metric.

2302

#

2303

# The key of the map is the metric name, and the values are the amount

2304

# increased for the metric against which the quota limits are defined.

2305

# The value must not be negative.

2306

"a_key": "A String",

2307

},

Bu Sun Kim

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

[diff] [blame]

2308

"selector": "A String", # Selects the methods to which this rule applies.

2309

#

2310

# Refer to selector for syntax details.

Bu Sun Kim

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

[diff] [blame]

2311

},

2312

],

2313

},

Bu Sun Kim

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

[diff] [blame]

2314

"context": { # `Context` defines which contexts an API requests. # Context configuration.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2315

#

2316

# Example:

2317

#

Bu Sun Kim

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

[diff] [blame]

# context:

# rules:

# - selector: "*"

# requested:

# - google.rpc.context.ProjectContext

2323

# - google.rpc.context.OriginContext

2324

#

2325

# The above specifies that all methods in the API request

2326

# `google.rpc.context.ProjectContext` and

2327

# `google.rpc.context.OriginContext`.

2328

#

2329

# Available context types are defined in package

2330

# `google.rpc.context`.

2331

#

2332

# This also provides mechanism to whitelist any protobuf message extension that

2333

# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and

2334

# “x-goog-ext-<extension_id>-jspb” format. For example, list any service

2335

# specific protobuf types that can appear in grpc metadata as follows in your

# yaml file:

#

# Example:

#

# context:

# rules:

# - selector: "google.example.library.v1.LibraryService.CreateBook"

2343

# allowed_request_extensions:

2344

# - google.foo.v1.NewExtension

2345

# allowed_response_extensions:

2346

# - google.foo.v1.NewExtension

2347

#

2348

# You can also specify extension ID instead of fully qualified extension name

2349

# here.

2350

"rules": [ # A list of RPC context rules that apply to individual API methods.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2351

#

Bu Sun Kim

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

[diff] [blame]

2352

# **NOTE:** All service configuration rules follow "last one wins" order.

2353

{ # A context rule provides information about the context for an individual API

2354

# element.

Bu Sun Kim

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

[diff] [blame]

2355

"allowedRequestExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc

2356

# side channel from client to backend.

2357

"A String",

2358

],

2359

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc

2360

# side channel from backend to client.

2361

"A String",

2362

],

2363

"selector": "A String", # Selects the methods to which this rule applies.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2364

#

2365

# Refer to selector for syntax details.

Bu Sun Kim

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

[diff] [blame]

2366

"requested": [ # A list of full type names of requested contexts.

2367

"A String",

2368

],

Bu Sun Kim

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

[diff] [blame]

2369

"provided": [ # A list of full type names of provided contexts.

2370

"A String",

2371

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2372

},

2373

],

2374

},

Bu Sun Kim

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

[diff] [blame]

2375

"producerProjectId": "A String", # The Google project that owns this service.

2376

"backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.

2377

"rules": [ # A list of API backend rules that apply to individual API methods.

Bu Sun Kim

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

[diff] [blame]

2378

#

2379

# **NOTE:** All service configuration rules follow "last one wins" order.

Bu Sun Kim

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

[diff] [blame]

2380

{ # A backend rule provides configuration for an individual API element.

2381

"operationDeadline": 3.14, # The number of seconds to wait for the completion of a long running

2382

# operation. The default is no deadline.

2383

"minDeadline": 3.14, # Minimum deadline in seconds needed for this method. Calls having deadline

2384

# value lower than this will be rejected.

2385

"address": "A String", # The address of the API backend.

Bu Sun Kim

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

[diff] [blame]

2386

#

Bu Sun Kim

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

[diff] [blame]

2387

# The scheme is used to determine the backend protocol and security.

2388

# The following schemes are accepted:

2389

#

2390

# SCHEME PROTOCOL SECURITY

# http:// HTTP None

# https:// HTTP TLS

# grpc:// gRPC None

# grpcs:// gRPC TLS

#

# It is recommended to explicitly include a scheme. Leaving out the scheme

2397

# may cause constrasting behaviors across platforms.

2398

#

2399

# If the port is unspecified, the default is:

2400

# - 80 for schemes without TLS

2401

# - 443 for schemes with TLS

2402

#

2403

# For HTTP backends, use protocol

2404

# to specify the protocol version.

2405

"pathTranslation": "A String",

Bu Sun Kim

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

[diff] [blame]

2406

"selector": "A String", # Selects the methods to which this rule applies.

Dan O'Meara

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

[diff] [blame]

2407

#

2408

# Refer to selector for syntax details.

Bu Sun Kim

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

[diff] [blame]

2409

"jwtAudience": "A String", # The JWT audience is used when generating a JWT ID token for the backend.

2410

# This ID token will be added in the HTTP "authorization" header, and sent

2411

# to the backend.

2412

"disableAuth": True or False, # When disable_auth is true, a JWT ID token won't be generated and the

2413

# original "Authorization" HTTP header will be preserved. If the header is

2414

# used to carry the original token and is expected by the backend, this

2415

# field must be set to true to preserve the header.

2416

"deadline": 3.14, # The number of seconds to wait for a response from a request. The default

2417

# varies based on the request protocol and deployment environment.

2418

"protocol": "A String", # The protocol used for sending a request to the backend.

2419

# The supported values are "http/1.1" and "h2".

Bu Sun Kim

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

[diff] [blame]

2420

#

Bu Sun Kim

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

[diff] [blame]

2421

# The default value is inferred from the scheme in the

2422

# address field:

Bu Sun Kim

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

[diff] [blame]

2423

#

Bu Sun Kim

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

[diff] [blame]

# SCHEME PROTOCOL

# http:// http/1.1

# https:// http/1.1

# grpc:// h2

# grpcs:// h2

Bu Sun Kim

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

[diff] [blame]

2429

#

Bu Sun Kim

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

[diff] [blame]

2430

# For secure HTTP backends (https://) that support HTTP/2, set this field

2431

# to "h2" for improved performance.

Bu Sun Kim

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

[diff] [blame]

2432

#

Bu Sun Kim

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

[diff] [blame]

2433

# Configuring this field to non-default values is only supported for secure

2434

# HTTP backends. This field will be ignored for all other backends.

Bu Sun Kim

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

[diff] [blame]

2435

#

Bu Sun Kim

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

[diff] [blame]

2436

# See

2437

# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids

2438

# for more details on the supported values.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2439

},

2440

],

2441

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

2446

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2447

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

2448

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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2453

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

Bu Sun Kim

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

[diff] [blame]

2454

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2455

The object takes the form of:

2456

2457

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

2458

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

2459

# `GetIamPolicy`.

2460

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

Dan O'Meara

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

[diff] [blame]

2461

#

2462

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

2463

# rejected.

2464

#

2465

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

2466

# Policies without any conditional bindings may specify any valid value or

2467

# leave the field unset.

Bu Sun Kim

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

[diff] [blame]

2468

#

2469

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

2470

# [IAM

2471

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

Dan O'Meara

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

[diff] [blame]

2472

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2473

}

2474

2475

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2482

Dan O'Meara

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

[diff] [blame]

2483

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

2484

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2485

#

2486

#

Dan O'Meara

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

[diff] [blame]

2487

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

2488

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

2489

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

2490

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

2491

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2492

#

Bu Sun Kim

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

[diff] [blame]

2493

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

2494

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

2495

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

2496

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

2497

# resources support conditions in their IAM policies, see the

2498

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

Dan O'Meara

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

[diff] [blame]

2499

#

2500

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2501

#

2502

# {

Bu Sun Kim

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

[diff] [blame]

2503

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2504

# {

Bu Sun Kim

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

[diff] [blame]

2505

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

2506

# "members": [

2507

# "user:mike@example.com",

2508

# "group:admins@example.com",

2509

# "domain:google.com",

2510

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2511

# ]

2512

# },

2513

# {

Bu Sun Kim

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

[diff] [blame]

2514

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

2515

# "members": [

2516

# "user:eve@example.com"

2517

# ],

2518

# "condition": {

2519

# "title": "expirable access",

2520

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

2521

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

Dan O'Meara

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

[diff] [blame]

2522

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2523

# }

Dan O'Meara

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

[diff] [blame]

2524

# ],

Bu Sun Kim

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

[diff] [blame]

2525

# "etag": "BwWWja0YfJA=",

2526

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2527

# }

2528

#

Dan O'Meara

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

[diff] [blame]

2529

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

2534

# - group:admins@example.com

2535

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

2536

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

2537

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

2538

# - members:

Dan O'Meara

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

[diff] [blame]

2539

# - user:eve@example.com

2540

# role: roles/resourcemanager.organizationViewer

2541

# condition:

2542

# title: expirable access

2543

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

2544

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

Dan O'Meara

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

[diff] [blame]

2545

# - etag: BwWWja0YfJA=

2546

# - version: 3

Bu Sun Kim

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

[diff] [blame]

2547

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2548

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

Dan O'Meara

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

[diff] [blame]

2549

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

Bu Sun Kim

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

[diff] [blame]

2550

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

2551

#

2552

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

2553

# are rejected.

2554

#

2555

# Any operation that affects conditional role bindings must specify version

2556

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

2557

#

2558

# * Getting a policy that includes a conditional role binding

2559

# * Adding a conditional role binding to a policy

2560

# * Changing a conditional role binding in a policy

2561

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

2562

# that includes conditions

2563

#

2564

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

2565

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

2566

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

2567

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

2568

#

2569

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

2570

# specify any valid version or leave the field unset.

2571

#

2572

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

2573

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

Bu Sun Kim

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

[diff] [blame]

2574

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

2575

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

2576

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

2577

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

2578

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

2579

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

2580

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

2581

#

2582

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

2583

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

2584

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

2585

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

2586

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

2587

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

2588

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

2589

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

2590

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

2591

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

2592

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

2593

#

2594

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

2595

# current request.

2596

#

2597

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

2598

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

2599

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

2600

#

2601

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

2602

# [IAM

2603

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

2604

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

2605

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

2606

#

2607

# Example (Comparison):

2608

#

2609

# title: "Summary size limit"

2610

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

2611

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

2612

#

2613

# Example (Equality):

2614

#

2615

# title: "Requestor is owner"

2616

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

2617

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

#

# Example (Logic):

#

# title: "Public documents"

2622

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

2623

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

2624

#

2625

# Example (Data Manipulation):

2626

#

2627

# title: "Notification string"

2628

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

2629

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

2630

#

2631

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

2632

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

2633

# documentation for additional information.

2634

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

2635

# syntax.

2636

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

2637

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

2638

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

2639

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

2640

# expression.

2641

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

2642

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

2643

},

2644

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

2645

# `members` can have the following values:

2646

#

2647

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

2648

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

2649

#

2650

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

2651

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

2652

#

2653

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

2654

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

2655

#

2656

#

2657

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

2658

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

2659

#

2660

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

2661

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

2662

#

2663

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

2664

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

2665

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

2666

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

2667

# retains the role in the binding.

2668

#

2669

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

2670

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

2671

# deleted. For example,

2672

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

2673

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

2674

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

2675

# role in the binding.

2676

#

2677

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

2678

# identifier) representing a Google group that has been recently

2679

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

2680

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

2681

# recovered group retains the role in the binding.

2682

#

2683

#

2684

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

2685

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

#

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

2691

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

2692

{ # Specifies the audit configuration for a service.

2693

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

2694

# identities, if any, are exempted from logging.

2695

# An AuditConfig must have one or more AuditLogConfigs.

2696

#

2697

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

2698

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

2699

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

2700

# AuditLogConfig are exempted.

2701

#

2702

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

2708

# "audit_log_configs": [

2709

# {

2710

# "log_type": "DATA_READ",

2711

# "exempted_members": [

2712

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

2717

# },

2718

# {

2719

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

2725

# "audit_log_configs": [

2726

# {

2727

# "log_type": "DATA_READ",

2728

# },

2729

# {

2730

# "log_type": "DATA_WRITE",

2731

# "exempted_members": [

2732

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

2741

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

2742

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

2743

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

2744

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

2745

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

Bu Sun Kim

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

[diff] [blame]

2746

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

2747

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

# Example:

#

# {

# "audit_log_configs": [

2752

# {

2753

# "log_type": "DATA_READ",

2754

# "exempted_members": [

2755

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

2765

# jose@example.com from DATA_READ logging.

2766

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

2767

# permission.

2768

# Follows the same format of Binding.members.

2769

"A String",

2770

],

2771

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

2772

},

2773

],

Bu Sun Kim

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

[diff] [blame]

2774

},

2775

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

2780

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2781

<pre>Lists managed services.

2782

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2783

Returns all public services. For authenticated users, also returns all

Bu Sun Kim

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

[diff] [blame]

2784

services the calling user has "servicemanagement.services.get" permission

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2785

for.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2786

2787

**BETA:** If the caller specifies the `consumer_id`, it returns only the

2788

services enabled on the consumer. The `consumer_id` must have the format

Bu Sun Kim

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

[diff] [blame]

2789

of "project:{PROJECT-ID}".

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2790

2791

Args:

Bu Sun Kim

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

[diff] [blame]

2792

producerProjectId: string, Include services produced by the specified project.

2793

pageSize: integer, The max number of items to include in the response list. Page size is 50

2794

if not specified. Maximum value is 100.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2795

consumerId: string, Include services consumed by the specified consumer.

2796

2797

The Google Service Management implementation accepts the following

2798

forms:

Dan O'Meara

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

[diff] [blame]

2799

- project:<project_id>

Bu Sun Kim

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

[diff] [blame]

2800

pageToken: string, Token identifying which result to start with; returned by a previous list

2801

call.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2802

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2809

2810

{ # Response message for `ListServices` method.

Bu Sun Kim

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

[diff] [blame]

2811

"services": [ # The returned services will only have the name field set.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2812

{ # The full representation of a Service that is managed by

2813

# Google Service Management.

Bu Sun Kim

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

[diff] [blame]

2814

"serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2815

# for naming requirements.

Bu Sun Kim

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

[diff] [blame]

2816

"producerProjectId": "A String", # ID of the project that produces and owns this service.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2817

},

2818

],

Bu Sun Kim

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

[diff] [blame]

2819

"nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

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

2825

<pre>Retrieves the next page of results.

2826

2827

Args:

2828

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

2829

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

2830

2831

Returns:

Bu Sun Kim

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

[diff] [blame]

2832

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2833

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]

2838

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2839

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

2840

existing policy.

2841

Bu Sun Kim

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

[diff] [blame]

2842

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

Dan O'Meara

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

[diff] [blame]

2843

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2844

Args:

2845

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2846

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

Dan O'Meara

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

[diff] [blame]

2847

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2848

The object takes the form of:

2849

2850

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

2851

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2852

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

2853

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

2854

# might reject them.

Dan O'Meara

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

[diff] [blame]

2855

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2856

#

2857

#

Dan O'Meara

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

[diff] [blame]

2858

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

2859

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

2860

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

2861

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

2862

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2863

#

Bu Sun Kim

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

[diff] [blame]

2864

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

2865

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

2866

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

2867

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

2868

# resources support conditions in their IAM policies, see the

2869

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

Dan O'Meara

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

[diff] [blame]

2870

#

2871

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2872

#

2873

# {

Bu Sun Kim

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

[diff] [blame]

2874

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2875

# {

Bu Sun Kim

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

[diff] [blame]

2876

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

2877

# "members": [

2878

# "user:mike@example.com",

2879

# "group:admins@example.com",

2880

# "domain:google.com",

2881

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2882

# ]

2883

# },

2884

# {

Bu Sun Kim

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

[diff] [blame]

2885

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

2886

# "members": [

2887

# "user:eve@example.com"

2888

# ],

2889

# "condition": {

2890

# "title": "expirable access",

2891

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

2892

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

Dan O'Meara

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

[diff] [blame]

2893

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2894

# }

Dan O'Meara

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

[diff] [blame]

2895

# ],

Bu Sun Kim

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

[diff] [blame]

2896

# "etag": "BwWWja0YfJA=",

2897

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2898

# }

2899

#

Dan O'Meara

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

[diff] [blame]

2900

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

2905

# - group:admins@example.com

2906

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

2907

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

2908

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

2909

# - members:

Dan O'Meara

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

[diff] [blame]

2910

# - user:eve@example.com

2911

# role: roles/resourcemanager.organizationViewer

2912

# condition:

2913

# title: expirable access

2914

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

2915

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

Dan O'Meara

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

[diff] [blame]

2916

# - etag: BwWWja0YfJA=

2917

# - version: 3

Bu Sun Kim

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

[diff] [blame]

2918

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2919

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

Dan O'Meara

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

[diff] [blame]

2920

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

Bu Sun Kim

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

[diff] [blame]

2921

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

2922

#

2923

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

2924

# are rejected.

2925

#

2926

# Any operation that affects conditional role bindings must specify version

2927

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

2928

#

2929

# * Getting a policy that includes a conditional role binding

2930

# * Adding a conditional role binding to a policy

2931

# * Changing a conditional role binding in a policy

2932

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

2933

# that includes conditions

2934

#

2935

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

2936

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

2937

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

2938

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

2939

#

2940

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

2941

# specify any valid version or leave the field unset.

2942

#

2943

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

2944

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

Bu Sun Kim

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

[diff] [blame]

2945

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

2946

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

2947

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

2948

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

2949

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

2950

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

2951

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

2952

#

2953

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

2954

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

2955

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

2956

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

2957

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

2958

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

2959

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

2960

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

2961

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

2962

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

2963

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

2964

#

2965

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

2966

# current request.

2967

#

2968

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

2969

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

2970

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

2971

#

2972

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

2973

# [IAM

2974

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

2975

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

2976

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

2977

#

2978

# Example (Comparison):

2979

#

2980

# title: "Summary size limit"

2981

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

2982

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

2983

#

2984

# Example (Equality):

2985

#

2986

# title: "Requestor is owner"

2987

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

2988

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

#

# Example (Logic):

#

# title: "Public documents"

2993

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

2994

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

2995

#

2996

# Example (Data Manipulation):

2997

#

2998

# title: "Notification string"

2999

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

3000

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

3001

#

3002

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

3003

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

3004

# documentation for additional information.

3005

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

3006

# syntax.

3007

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

3008

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

3009

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

3010

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

3011

# expression.

3012

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

3013

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

3014

},

3015

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

3016

# `members` can have the following values:

3017

#

3018

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

3019

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

3020

#

3021

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

3022

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

3023

#

3024

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

3025

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

3026

#

3027

#

3028

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

3029

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

3030

#

3031

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

3032

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

3033

#

3034

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

3035

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

3036

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

3037

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

3038

# retains the role in the binding.

3039

#

3040

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

3041

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

3042

# deleted. For example,

3043

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

3044

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

3045

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

3046

# role in the binding.

3047

#

3048

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

3049

# identifier) representing a Google group that has been recently

3050

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

3051

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

3052

# recovered group retains the role in the binding.

3053

#

3054

#

3055

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

3056

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

#

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

3062

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

3063

{ # Specifies the audit configuration for a service.

3064

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

3065

# identities, if any, are exempted from logging.

3066

# An AuditConfig must have one or more AuditLogConfigs.

3067

#

3068

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

3069

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

3070

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

3071

# AuditLogConfig are exempted.

3072

#

3073

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

3079

# "audit_log_configs": [

3080

# {

3081

# "log_type": "DATA_READ",

3082

# "exempted_members": [

3083

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

3088

# },

3089

# {

3090

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

3096

# "audit_log_configs": [

3097

# {

3098

# "log_type": "DATA_READ",

3099

# },

3100

# {

3101

# "log_type": "DATA_WRITE",

3102

# "exempted_members": [

3103

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

3112

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

3113

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

3114

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

3115

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

3116

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

Bu Sun Kim

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

[diff] [blame]

3117

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

3118

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

# Example:

#

# {

# "audit_log_configs": [

3123

# {

3124

# "log_type": "DATA_READ",

3125

# "exempted_members": [

3126

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

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

3136

# jose@example.com from DATA_READ logging.

3137

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

3138

# permission.

3139

# Follows the same format of Binding.members.

3140

"A String",

3141

],

3142

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

3143

},

3144

],

Bu Sun Kim

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

[diff] [blame]

3145

},

3146

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3147

},

Bu Sun Kim

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

[diff] [blame]

3148

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

3149

# the fields in the mask will be modified. If no mask is provided, the

3150

# following default mask is used:

3151

#

3152

# `paths: "bindings, etag"`

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3153

}

3154

3155

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3162

Dan O'Meara

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

[diff] [blame]

3163

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

3164

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3165

#

3166

#

Dan O'Meara

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

[diff] [blame]

3167

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

3168

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

3169

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

3170

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

3171

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3172

#

Bu Sun Kim

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

[diff] [blame]

3173

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

3174

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

3175

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

3176

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

3177

# resources support conditions in their IAM policies, see the

3178

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

Dan O'Meara

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

[diff] [blame]

3179

#

3180

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3181

#

3182

# {

Bu Sun Kim

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

[diff] [blame]

3183

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3184

# {

Bu Sun Kim

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

[diff] [blame]

3185

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

3186

# "members": [

3187

# "user:mike@example.com",

3188

# "group:admins@example.com",

3189

# "domain:google.com",

3190

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3191

# ]

3192

# },

3193

# {

Bu Sun Kim

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

[diff] [blame]

3194

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

3195

# "members": [

3196

# "user:eve@example.com"

3197

# ],

3198

# "condition": {

3199

# "title": "expirable access",

3200

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

3201

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

Dan O'Meara

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

[diff] [blame]

3202

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3203

# }

Dan O'Meara

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

[diff] [blame]

3204

# ],

Bu Sun Kim

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

[diff] [blame]

3205

# "etag": "BwWWja0YfJA=",

3206

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3207

# }

3208

#

Dan O'Meara

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

[diff] [blame]

3209

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

3214

# - group:admins@example.com

3215

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

3216

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

3217

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

3218

# - members:

Dan O'Meara

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

[diff] [blame]

3219

# - user:eve@example.com

3220

# role: roles/resourcemanager.organizationViewer

3221

# condition:

3222

# title: expirable access

3223

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

3224

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

Dan O'Meara

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

[diff] [blame]

3225

# - etag: BwWWja0YfJA=

3226

# - version: 3

Bu Sun Kim

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

[diff] [blame]

3227

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3228

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

Dan O'Meara

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

[diff] [blame]

3229

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

Bu Sun Kim

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

[diff] [blame]

3230

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

3231

#

3232

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

3233

# are rejected.

3234

#

3235

# Any operation that affects conditional role bindings must specify version

3236

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

3237

#

3238

# * Getting a policy that includes a conditional role binding

3239

# * Adding a conditional role binding to a policy

3240

# * Changing a conditional role binding in a policy

3241

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

3242

# that includes conditions

3243

#

3244

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

3245

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

3246

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

3247

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

3248

#

3249

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

3250

# specify any valid version or leave the field unset.

3251

#

3252

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

3253

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

Bu Sun Kim

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

[diff] [blame]

3254

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

3255

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

3256

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

3257

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

3258

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

3259

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

3260

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

3261

#

3262

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

3263

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

3264

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

3265

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

3266

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

3267

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

3268

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

3269

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

3270

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

3271

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

3272

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

3273

#

3274

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

3275

# current request.

3276

#

3277

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

3278

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

3279

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

3280

#

3281

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

3282

# [IAM

3283

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

3284

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

3285

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

3286

#

3287

# Example (Comparison):

3288

#

3289

# title: "Summary size limit"

3290

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

3291

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

3292

#

3293

# Example (Equality):

3294

#

3295

# title: "Requestor is owner"

3296

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

3297

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

#

# Example (Logic):

#

# title: "Public documents"

3302

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

3303

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

3304

#

3305

# Example (Data Manipulation):

3306

#

3307

# title: "Notification string"

3308

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

3309

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

3310

#

3311

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

3312

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

3313

# documentation for additional information.

3314

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

3315

# syntax.

3316

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

3317

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

3318

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

3319

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

3320

# expression.

3321

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

3322

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

3323

},

3324

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

3325

# `members` can have the following values:

3326

#

3327

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

3328

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

3329

#

3330

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

3331

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

3332

#

3333

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

3334

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

3335

#

3336

#

3337

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

3338

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

3339

#

3340

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

3341

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

3342

#

3343

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

3344

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

3345

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

3346

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

3347

# retains the role in the binding.

3348

#

3349

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

3350

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

3351

# deleted. For example,

3352

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

3353

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

3354

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

3355

# role in the binding.

3356

#

3357

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

3358

# identifier) representing a Google group that has been recently

3359

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

3360

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

3361

# recovered group retains the role in the binding.

3362

#

3363

#

3364

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

3365

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

#

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

3371

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

3372

{ # Specifies the audit configuration for a service.

3373

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

3374

# identities, if any, are exempted from logging.

3375

# An AuditConfig must have one or more AuditLogConfigs.

3376

#

3377

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

3378

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

3379

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

3380

# AuditLogConfig are exempted.

3381

#

3382

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

3388

# "audit_log_configs": [

3389

# {

3390

# "log_type": "DATA_READ",

3391

# "exempted_members": [

3392

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

3397

# },

3398

# {

3399

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

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

3405

# "audit_log_configs": [

3406

# {

3407

# "log_type": "DATA_READ",

3408

# },

3409

# {

3410

# "log_type": "DATA_WRITE",

3411

# "exempted_members": [

3412

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

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

3421

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

3422

# aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3423

"service": "A String", # Specifies a service that will be enabled for audit logging.

3424

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

3425

# `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3426

"auditLogConfigs": [ # The configuration for logging of each type of permission.

3427

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

3432

# {

3433

# "log_type": "DATA_READ",

3434

# "exempted_members": [

3435

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

3445

# jose@example.com from DATA_READ logging.

3446

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

3447

# permission.

3448

# Follows the same format of Binding.members.

3449

"A String",

3450

],

3451

"logType": "A String", # The log type that this config enables.

3452

},

3453

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3454

},

3455

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3460

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3461

<pre>Returns permissions that a caller has on the specified resource.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3462

If the resource does not exist, this will return an empty set of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3463

permissions, not a `NOT_FOUND` error.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3464

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3465

Note: This operation is designed to be used for building permission-aware

3466

UIs and command-line tools, not for authorization checking. This operation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3467

may "fail open" without warning.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3468

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3469

Args:

3470

resource: string, REQUIRED: The resource for which the policy detail is being requested.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3471

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3472

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3473

The object takes the form of:

3474

3475

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3476

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

3477

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3478

# information see

3479

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3480

"A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -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:

3491

3492

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3493

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3494

# allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3495

"A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

],

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

3501

<code class="details" id="undelete">undelete(serviceName, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3502

<pre>Revives a previously deleted managed service. The method restores the

3503

service using the configuration at the time the service was deleted.

3504

The target service must exist and must have been deleted within the

3505

last 30 days.

3506

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3507

Operation<response: UndeleteServiceResponse>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3508

3509

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3510

serviceName: string, Required. The name of the service. See the [overview](/service-management/overview)

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3511

for naming requirements. For example: `example.googleapis.com`. (required)

3512

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3519

3520

{ # This resource represents a long-running operation that is the result of a

3521

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

3522

"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.

3523

# different programming environments, including REST APIs and RPC APIs. It is

3524

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3525

# three pieces of data: error code, error message, and error details.

3526

#

3527

# You can find out more about this error model and how to work with it in the

3528

# [API Design Guide](https://cloud.google.com/apis/design/errors).

3529

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3530

"message": "A String", # A developer-facing error message, which should be in English. Any

3531

# user-facing error message should be localized and sent in the

3532

# google.rpc.Status.details field, or localized by the client.

3533

"details": [ # A list of messages that carry the error details. There is a common set of

3534

# message types for APIs to use.

3535

{

3536

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"name": "A String", # The server-assigned name, which is only unique within the same service that

3541

# originally returns it. If you use the default HTTP mapping, the

3542

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

"metadata": { # Service-specific metadata associated with the operation. It typically

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3544

# contains progress information and common metadata such as create time.

3545

# Some services might not provide such metadata. Any method that returns a

3546

# long-running operation should document the metadata type, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3547

"a_key": "", # Properties of the object. Contains field @type with type URL.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3548

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3549

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3550

# If `true`, the operation is completed, and either `error` or `response` is

3551

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3552

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3553

# method returns no data on success, such as `Delete`, the response is

3554

# `google.protobuf.Empty`. If the original method is standard

3555

# `Get`/`Create`/`Update`, the response should be the resource. For other

3556

# methods, the response should have the type `XxxResponse`, where `Xxx`

3557

# is the original method name. For example, if the original method name

3558

# is `TakeSnapshot()`, the inferred response type is

3559

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3560

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3561

},

Jon Wayne Parrott