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

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-20 12:08:20 -0700

[diff] [blame^]

232

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

Sai Cheemalapati

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

[diff] [blame]

233

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

234

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

235

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

Bu Sun Kim

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

[diff] [blame^]

236

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

Sai Cheemalapati

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame^]

238

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

239

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

240

# available.

Bu Sun Kim

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

[diff] [blame^]

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

249

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

Dan O'Meara

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

[diff] [blame]

250

},

Bu Sun Kim

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

[diff] [blame^]

251

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

Dan O'Meara

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

[diff] [blame]

252

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

253

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

Bu Sun Kim

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

[diff] [blame^]

254

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

255

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

256

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

257

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

258

#

259

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

260

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

261

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

262

# message types for APIs to use.

263

{

264

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

265

},

266

],

267

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

268

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

269

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

270

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

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-20 12:08:20 -0700

[diff] [blame^]

311

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

Sai Cheemalapati

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

[diff] [blame]

312

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

313

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

314

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

Bu Sun Kim

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

[diff] [blame^]

315

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

Sai Cheemalapati

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

[diff] [blame]

316

},

Bu Sun Kim

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

[diff] [blame^]

317

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

318

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

319

# available.

Bu Sun Kim

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

[diff] [blame^]

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

328

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

Dan O'Meara

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

[diff] [blame]

329

},

Bu Sun Kim

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

[diff] [blame^]

330

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

Dan O'Meara

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

[diff] [blame]

331

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

332

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

Bu Sun Kim

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

[diff] [blame^]

333

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

334

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

335

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

336

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

337

#

338

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

339

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

340

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

341

# message types for APIs to use.

342

{

343

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

344

},

345

],

346

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

347

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

348

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

349

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

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-20 12:08:20 -0700

[diff] [blame^]

391

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

Sai Cheemalapati

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

[diff] [blame]

392

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

393

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

394

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

Bu Sun Kim

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

[diff] [blame^]

395

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

Sai Cheemalapati

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

[diff] [blame]

396

},

Bu Sun Kim

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

[diff] [blame^]

397

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

398

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

399

# available.

Bu Sun Kim

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

[diff] [blame^]

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame^]

408

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

Dan O'Meara

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

[diff] [blame]

409

},

Bu Sun Kim

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

[diff] [blame^]

410

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

Dan O'Meara

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

[diff] [blame]

411

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

412

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

Bu Sun Kim

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

[diff] [blame^]

413

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

414

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

415

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

416

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

417

#

418

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

419

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

420

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

421

# message types for APIs to use.

422

{

423

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

424

},

425

],

426

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

427

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

428

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

429

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

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-20 12:08:20 -0700

[diff] [blame^]

495

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

496

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

497

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

498

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

499

# is used.

500

# Examples:

501

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

502

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

503

# - logging.producer_destinations[0]

504

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

505

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

506

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

Jon Wayne Parrott

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

[diff] [blame]

507

# possible impact of this change.

508

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

509

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

Bu Sun Kim

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

[diff] [blame^]

510

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

Jon Wayne Parrott

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

[diff] [blame]

511

# be taken to mitigate any implied risks.

512

},

513

],

Bu Sun Kim

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

[diff] [blame^]

514

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

Jon Wayne Parrott

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

[diff] [blame]

515

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

Bu Sun Kim

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

[diff] [blame^]

516

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

Jon Wayne Parrott

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

521

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

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

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

527

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

528

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

Jon Wayne Parrott

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

[diff] [blame]

529

},

530

],

Bu Sun Kim

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

[diff] [blame^]

531

"serviceName": "A String", # Name of the service 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

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

554

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

555

# for naming requirements.

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-20 12:08:20 -0700

[diff] [blame^]

603

"monitoring": { # Monitoring configuration of the service. # Monitoring configuration.

Jon Wayne Parrott

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

[diff] [blame]

604

#

605

# The example below shows how to configure monitored resources and metrics

606

# for monitoring. In the example, a monitored resource and two metrics are

607

# defined. The `library.googleapis.com/book/returned_count` metric is sent

608

# to both producer and consumer projects, whereas the

609

# `library.googleapis.com/book/overdue_count` metric is only sent to the

610

# consumer project.

611

#

612

# monitored_resources:

613

# - type: library.googleapis.com/branch

614

# labels:

615

# - key: /city

616

# description: The city where the library branch is located in.

617

# - key: /name

618

# description: The name of the branch.

619

# metrics:

620

# - name: library.googleapis.com/book/returned_count

# metric_kind: DELTA

# value_type: INT64

# labels:

# - key: /customer_id

625

# - name: library.googleapis.com/book/overdue_count

# metric_kind: GAUGE

# value_type: INT64

# labels:

# - key: /customer_id

630

# monitoring:

631

# producer_destinations:

632

# - monitored_resource: library.googleapis.com/branch

633

# metrics:

634

# - library.googleapis.com/book/returned_count

635

# consumer_destinations:

636

# - monitored_resource: library.googleapis.com/branch

637

# metrics:

638

# - library.googleapis.com/book/returned_count

639

# - library.googleapis.com/book/overdue_count

Bu Sun Kim

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

[diff] [blame^]

640

"consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.

Bu Sun Kim

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

[diff] [blame]

641

# There can be multiple consumer destinations. A monitored resouce type may

642

# appear in multiple monitoring destinations if different aggregations are

643

# needed for different sets of metrics associated with that monitored

644

# resource type. A monitored resource and metric pair may only be used once

645

# in the Monitoring configuration.

Jon Wayne Parrott

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

[diff] [blame]

646

{ # Configuration of a specific monitoring destination (the producer project

647

# or the consumer project).

Bu Sun Kim

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

[diff] [blame^]

648

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

Jon Wayne Parrott

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

[diff] [blame]

649

# Service.monitored_resources section.

Bu Sun Kim

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

[diff] [blame^]

650

"metrics": [ # Types of the metrics to report to this monitoring destination.

Bu Sun Kim

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

[diff] [blame]

651

# Each type must be defined in Service.metrics section.

Bu Sun Kim

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

[diff] [blame^]

"A String",

],

},

],

"producerDestinations": [ # Monitoring configurations for sending metrics to the producer project.

657

# There can be multiple producer destinations. A monitored resouce type may

658

# appear in multiple monitoring destinations if different aggregations are

659

# needed for different sets of metrics associated with that monitored

660

# resource type. A monitored resource and metric pair may only be used once

661

# in the Monitoring configuration.

662

{ # Configuration of a specific monitoring destination (the producer project

663

# or the consumer project).

664

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

665

# Service.monitored_resources section.

666

"metrics": [ # Types of the metrics to report to this monitoring destination.

667

# Each type must be defined in Service.metrics section.

668

"A String",

Bu Sun Kim

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

[diff] [blame]

],

},

],

},

Bu Sun Kim

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

[diff] [blame^]

673

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

674

# It serves similar purpose as [google.api.Service.types], except that

675

# these types are not needed by user-defined APIs. Therefore, they will not

676

# show up in the generated discovery doc. This field should only be used

677

# to define system APIs in ESF.

678

{ # A protocol buffer message type.

679

"options": [ # The protocol buffer options.

680

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

681

# enumeration, etc.

682

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

683

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

684

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

685

# value using the google.protobuf.Int32Value type.

686

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

687

},

688

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

689

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

690

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

691

# `"google.api.http"`.

692

},

693

],

694

"fields": [ # The list of fields.

695

{ # A single field of a message type.

696

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

697

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

698

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

699

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

700

"number": 42, # The field number.

701

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

702

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

703

"options": [ # The protocol buffer options.

704

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

705

# enumeration, etc.

706

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

707

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

708

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

709

# value using the google.protobuf.Int32Value type.

710

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

711

},

712

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

713

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

714

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

715

# `"google.api.http"`.

716

},

717

],

718

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

719

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

720

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

721

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

722

},

723

],

724

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

725

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

726

"A String",

727

],

728

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

729

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

730

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

731

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

732

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

},

},

],

"producerProjectId": "A String", # The Google project that owns this service.

737

"quota": { # Quota configuration helps to achieve fairness and budgeting in service # Quota configuration.

738

# usage.

739

#

740

# The metric based quota configuration works this way:

741

# - The service configuration defines a set of metrics.

742

# - For API calls, the quota.metric_rules maps methods to metrics with

743

# corresponding costs.

744

# - The quota.limits defines limits on the metrics, which will be used for

745

# quota checks at runtime.

746

#

747

# An example quota configuration in yaml format:

#

# quota:

# limits:

#

# - name: apiWriteQpsPerProject

753

# metric: library.googleapis.com/write_calls

754

# unit: "1/min/{project}" # rate limit for consumer projects

# values:

# STANDARD: 10000

#

#

# # The metric rules bind all methods to the read_calls metric,

760

# # except for the UpdateBook and DeleteBook methods. These two methods

761

# # are mapped to the write_calls metric, with the UpdateBook method

762

# # consuming at twice rate as the DeleteBook method.

# metric_rules:

# - selector: "*"

# metric_costs:

# library.googleapis.com/read_calls: 1

767

# - selector: google.example.library.v1.LibraryService.UpdateBook

768

# metric_costs:

769

# library.googleapis.com/write_calls: 2

770

# - selector: google.example.library.v1.LibraryService.DeleteBook

771

# metric_costs:

772

# library.googleapis.com/write_calls: 1

773

#

774

# Corresponding Metric definition:

775

#

776

# metrics:

777

# - name: library.googleapis.com/read_calls

778

# display_name: Read requests

# metric_kind: DELTA

# value_type: INT64

#

# - name: library.googleapis.com/write_calls

783

# display_name: Write requests

# metric_kind: DELTA

# value_type: INT64

#

"limits": [ # List of `QuotaLimit` definitions for the service.

788

{ # `QuotaLimit` defines a specific limit that applies over a specified duration

789

# for a limit type. There can be at most one limit for a duration and limit

790

# type combination defined within a `QuotaGroup`.

791

"name": "A String", # Name of the quota limit.

792

#

793

# The name must be provided, and it must be unique within the service. The

794

# name can only include alphanumeric characters as well as '-'.

795

#

796

# The maximum length of the limit name is 64 characters.

797

"freeTier": "A String", # Free tier value displayed in the Developers Console for this limit.

798

# The free tier is the number of tokens that will be subtracted from the

799

# billed amount when billing is enabled.

800

# This field can only be set on a limit with duration "1d", in a billable

801

# group; it is invalid on any other limit. If this field is not set, it

802

# defaults to 0, indicating that there is no free tier for this service.

803

#

804

# Used by group-based quotas only.

805

"duration": "A String", # Duration of this limit in textual notation. Must be "100s" or "1d".

806

#

807

# Used by group-based quotas only.

808

"defaultLimit": "A String", # Default number of tokens that can be consumed during the specified

809

# duration. This is the number of tokens assigned when a client

810

# application developer activates the service for his/her project.

811

#

812

# Specifying a value of 0 will block all requests. This can be used if you

813

# are provisioning quota to selected consumers and blocking others.

814

# Similarly, a value of -1 will indicate an unlimited quota. No other

815

# negative values are allowed.

816

#

817

# Used by group-based quotas only.

818

"description": "A String", # Optional. User-visible, extended description for this quota limit.

819

# Should be used only when more context is needed to understand this limit

820

# than provided by the limit's display name (see: `display_name`).

821

"metric": "A String", # The name of the metric this quota limit applies to. The quota limits with

822

# the same metric will be checked together during runtime. The metric must be

823

# defined within the service config.

824

"displayName": "A String", # User-visible display name for this limit.

825

# Optional. If not set, the UI will provide a default display name based on

826

# the quota configuration. This field can be used to override the default

827

# display name generated from the configuration.

828

"values": { # Tiered limit values. You must specify this as a key:value pair, with an

829

# integer value that is the maximum number of requests allowed for the

830

# specified unit. Currently only STANDARD is supported.

831

"a_key": "A String",

832

},

833

"unit": "A String", # Specify the unit of the quota limit. It uses the same syntax as

834

# Metric.unit. The supported unit kinds are determined by the quota

835

# backend system.

836

#

837

# Here are some examples:

838

# * "1/min/{project}" for quota per minute per project.

839

#

840

# Note: the order of unit components is insignificant.

841

# The "1" at the beginning is required to follow the metric unit syntax.

842

"maxLimit": "A String", # Maximum number of tokens that can be consumed during the specified

843

# duration. Client application developers can override the default limit up

844

# to this maximum. If specified, this value cannot be set to a value less

845

# than the default limit. If not specified, it is set to the default limit.

846

#

847

# To allow clients to apply overrides with no upper bound, set this to -1,

848

# indicating unlimited maximum quota.

849

#

850

# Used by group-based quotas only.

851

},

852

],

853

"metricRules": [ # List of `MetricRule` definitions, each one mapping a selected method to one

854

# or more metrics.

855

{ # Bind API methods to metrics. Binding a method to a metric causes that

856

# metric's configured quota behaviors to apply to the method call.

857

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

858

#

859

# Refer to selector for syntax details.

860

"metricCosts": { # Metrics to update when the selected methods are called, and the associated

861

# cost applied to each metric.

862

#

863

# The key of the map is the metric name, and the values are the amount

864

# increased for the metric against which the quota limits are defined.

865

# The value must not be negative.

"a_key": "A String",

},

},

],

},

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

872

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

873

# typically goes through DNS verification to make sure the owner

874

# of the service also owns the DNS name.

875

"billing": { # Billing related configuration of the service. # Billing configuration.

Bu Sun Kim

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

[diff] [blame]

876

#

877

# The following example shows how to configure monitored resources and metrics

Bu Sun Kim

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

[diff] [blame^]

878

# for billing, `consumer_destinations` is the only supported destination and

879

# the monitored resources need at least one label key

880

# `cloud.googleapis.com/location` to indicate the location of the billing

881

# usage, using different monitored resources between monitoring and billing is

882

# recommended so they can be evolved independently:

883

#

Bu Sun Kim

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

[diff] [blame]

884

#

885

# monitored_resources:

Bu Sun Kim

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

[diff] [blame^]

886

# - type: library.googleapis.com/billing_branch

Bu Sun Kim

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

[diff] [blame]

887

# labels:

Bu Sun Kim

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

[diff] [blame^]

888

# - key: cloud.googleapis.com/location

889

# description: |

890

# Predefined label to support billing location restriction.

891

# - key: city

892

# description: |

893

# Custom label to define the city where the library branch is located

894

# in.

895

# - key: name

896

# description: Custom label to define the name of the library branch.

Bu Sun Kim

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

[diff] [blame]

897

# metrics:

898

# - name: library.googleapis.com/book/borrowed_count

899

# metric_kind: DELTA

900

# value_type: INT64

Bu Sun Kim

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

[diff] [blame^]

901

# unit: "1"

Bu Sun Kim

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

[diff] [blame]

902

# billing:

903

# consumer_destinations:

Bu Sun Kim

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

[diff] [blame^]

904

# - monitored_resource: library.googleapis.com/billing_branch

Bu Sun Kim

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

[diff] [blame]

905

# metrics:

906

# - library.googleapis.com/book/borrowed_count

Bu Sun Kim

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

[diff] [blame^]

907

"consumerDestinations": [ # Billing configurations for sending metrics to the consumer project.

Bu Sun Kim

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

[diff] [blame]

908

# There can be multiple consumer destinations per service, each one must have

909

# a different monitored resource type. A metric can be used in at most

910

# one consumer destination.

911

{ # Configuration of a specific billing destination (Currently only support

912

# bill against consumer project).

Bu Sun Kim

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

[diff] [blame^]

913

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

Dan O'Meara

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

[diff] [blame]

914

# Service.monitored_resources section.

Bu Sun Kim

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

[diff] [blame^]

915

"metrics": [ # Names of the metrics to report to this billing destination.

916

# Each name must be defined in Service.metrics section.

917

"A String",

918

],

Jon Wayne Parrott

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

[diff] [blame]

919

},

920

],

921

},

Bu Sun Kim

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

[diff] [blame^]

922

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

923

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

924

# error responses.

Jon Wayne Parrott

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

[diff] [blame]

925

#

Bu Sun Kim

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

[diff] [blame^]

926

# Example:

Jon Wayne Parrott

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

[diff] [blame]

927

#

Bu Sun Kim

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

[diff] [blame^]

928

# custom_error:

929

# types:

930

# - google.foo.v1.CustomError

931

# - google.foo.v1.AnotherError

932

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

Jon Wayne Parrott

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

[diff] [blame]

933

#

Bu Sun Kim

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

[diff] [blame^]

934

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

935

{ # A custom error rule.

936

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

937

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

938

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

Jon Wayne Parrott

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

[diff] [blame]

939

#

940

# Refer to selector for syntax details.

941

},

942

],

Bu Sun Kim

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

[diff] [blame^]

943

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

944

"A String",

Jon Wayne Parrott

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

[diff] [blame]

945

],

946

},

Bu Sun Kim

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

[diff] [blame^]

947

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

948

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

949

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

950

# defined APIs.

951

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

952

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

953

# same service configuration, such as quota configuration and monitoring

954

# configuration.

Jon Wayne Parrott

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

[diff] [blame]

955

#

Bu Sun Kim

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

[diff] [blame^]

956

# Example service configuration:

Dan O'Meara

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

[diff] [blame]

957

#

Bu Sun Kim

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

[diff] [blame^]

958

# name: library-example.googleapis.com

959

# endpoints:

960

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

961

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

962

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

963

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

964

# # allowed to proceed.

965

# - name: library-example.googleapis.com

966

# allow_cors: true

967

"aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,

968

# please specify multiple google.api.Endpoint for each of the intended

969

# aliases.

Dan O'Meara

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

[diff] [blame]

970

#

Bu Sun Kim

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

[diff] [blame^]

971

# Additional names that this endpoint will be hosted on.

972

"A String",

973

],

974

"features": [ # The list of features enabled on this endpoint.

975

"A String",

976

],

977

"allowCors": True or False, # Allowing

978

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

979

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

980

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

981

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

982

# allowed to proceed.

983

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

984

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

985

# handle requests to this [API

986

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

987

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

988

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

Dan O'Meara

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

[diff] [blame]

989

},

Bu Sun Kim

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

[diff] [blame^]

990

],

991

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

992

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

Jon Wayne Parrott

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

[diff] [blame]

993

#

Bu Sun Kim

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

[diff] [blame^]

994

# - name: library.googleapis.com/activity_history

995

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

996

# display_name: Activity

997

# labels:

998

# - key: /customer_id

999

# description: Identifier of a library customer

1000

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

1001

# Runtime requests that contain labels not specified here are

1002

# considered invalid.

1003

{ # A description of a label.

1004

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

1005

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

1006

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

1007

},

1008

],

1009

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

1010

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

1011

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

1012

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

1013

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

1014

# the documentation and can contain details.

1015

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

1016

# the user interface and should be concise.

1017

},

1018

],

1019

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

1020

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

1021

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

1022

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

1023

# which cannot be resolved against the associated IDL files.

1024

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

1025

#

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

# detailed terminology.

1033

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

1034

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

1035

# enumeration, etc.

1036

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

1037

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

1038

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

1039

# value using the google.protobuf.Int32Value type.

1040

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

1041

},

1042

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

1043

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

1044

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

1045

# `"google.api.http"`.

1046

},

1047

],

1048

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

1049

{ # Method represents a method of an API interface.

1050

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

1051

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

1052

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

1053

# enumeration, etc.

1054

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

1055

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

1056

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

1057

# value using the google.protobuf.Int32Value type.

1058

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

1059

},

1060

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

1061

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

1062

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

1063

# `"google.api.http"`.

1064

},

1065

],

1066

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

1067

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

1068

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

1069

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

1070

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

1071

},

1072

],

1073

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

1074

# followed by the interface's simple name.

1075

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

1076

# message.

1077

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

1078

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

1079

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

1080

},

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

# consistent with what is provided here.

1088

#

1089

# The versioning schema uses [semantic

1090

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

1091

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

1092

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

1093

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

1094

# chosen based on the product plan.

1095

#

1096

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

1097

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

1098

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

1099

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

1100

# experimental, non-GA interfaces.

1101

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

1102

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

1103

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

1104

# documentation and options are inherited as follows:

1105

#

1106

# - If after comment and whitespace stripping, the documentation

1107

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

1108

# from the original method.

1109

#

1110

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

1111

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

1112

# inherited.

1113

#

1114

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

1115

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

1116

# version of the including interface plus the root path if

1117

# specified.

1118

#

1119

# Example of a simple mixin:

1120

#

1121

# package google.acl.v1;

1122

# service AccessControl {

1123

# // Get the underlying ACL object.

1124

# rpc GetAcl(GetAclRequest) returns (Acl) {

1125

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

# }

# }

#

# package google.storage.v2;

1130

# service Storage {

1131

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

1132

#

1133

# // Get a data record.

1134

# rpc GetData(GetDataRequest) returns (Data) {

1135

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

# }

# }

#

# Example of a mixin configuration:

1140

#

1141

# apis:

1142

# - name: google.storage.v2.Storage

1143

# mixins:

1144

# - name: google.acl.v1.AccessControl

1145

#

1146

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

1147

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

1148

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

1149

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

1150

# documentation and annotations as follows:

1151

#

1152

# service Storage {

1153

# // Get the underlying ACL object.

1154

# rpc GetAcl(GetAclRequest) returns (Acl) {

1155

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

# }

# ...

# }

#

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

1161

#

1162

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

1163

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

1164

#

1165

# apis:

1166

# - name: google.storage.v2.Storage

1167

# mixins:

1168

# - name: google.acl.v1.AccessControl

1169

# root: acls

1170

#

1171

# This implies the following inherited HTTP annotation:

1172

#

1173

# service Storage {

1174

# // Get the underlying ACL object.

1175

# rpc GetAcl(GetAclRequest) returns (Acl) {

1176

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

# }

# ...

# }

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

1181

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

# are rooted.

},

],

},

],

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

1188

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

1189

# automatically included. Messages which are not referenced but

1190

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

1191

# should be listed here by name. Example:

1192

#

1193

# types:

1194

# - name: google.protobuf.Int32

1195

{ # A protocol buffer message type.

1196

"options": [ # The protocol buffer options.

1197

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

1198

# enumeration, etc.

1199

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

1200

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

1201

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

1202

# value using the google.protobuf.Int32Value type.

1203

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

1204

},

1205

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

1206

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

1207

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

1208

# `"google.api.http"`.

1209

},

1210

],

1211

"fields": [ # The list of fields.

1212

{ # A single field of a message type.

1213

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

1214

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

1215

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

1216

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

1217

"number": 42, # The field number.

1218

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

1219

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

1220

"options": [ # The protocol buffer options.

1221

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

1222

# enumeration, etc.

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

},

1229

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

1230

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

1231

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

1232

# `"google.api.http"`.

1233

},

1234

],

1235

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

1236

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

1237

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

1238

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

1239

},

1240

],

1241

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

1242

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

1243

"A String",

1244

],

1245

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

1246

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

1247

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

1248

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

1249

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

},

},

],

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

1254

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

1255

{

1256

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

1257

},

Jon Wayne Parrott

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

[diff] [blame]

1258

],

1259

},

Bu Sun Kim

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

[diff] [blame^]

1260

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

1261

# HttpRule, each specifying the mapping of an RPC method

1262

# to one or more HTTP REST API methods.

Bu Sun Kim

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

[diff] [blame^]

1263

"fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in

1264

# cases of single segment matches in reserved expansion, where "%2F" will be

1265

# left encoded.

Jon Wayne Parrott

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

[diff] [blame]

1266

#

Bu Sun Kim

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

[diff] [blame^]

1267

# The default behavior is to not decode RFC 6570 reserved characters in multi

1268

# segment matches.

1269

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

1270

#

1271

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

Bu Sun Kim

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

[diff] [blame]

1272

{ # # gRPC Transcoding

Jon Wayne Parrott

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

[diff] [blame]

1273

#

Bu Sun Kim

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

[diff] [blame]

1274

# gRPC Transcoding is a feature for mapping between a gRPC method and one or

1275

# more HTTP REST endpoints. It allows developers to build a single API service

1276

# that supports both gRPC APIs and REST APIs. Many systems, including [Google

1277

# APIs](https://github.com/googleapis/googleapis),

1278

# [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC

1279

# Gateway](https://github.com/grpc-ecosystem/grpc-gateway),

1280

# and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature

1281

# and use it for large scale production services.

Jon Wayne Parrott

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

[diff] [blame]

1282

#

Bu Sun Kim

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

[diff] [blame]

1283

# `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies

1284

# how different portions of the gRPC request message are mapped to the URL

1285

# path, URL query parameters, and HTTP request body. It also controls how the

1286

# gRPC response message is mapped to the HTTP response body. `HttpRule` is

1287

# typically specified as an `google.api.http` annotation on the gRPC method.

1288

#

1289

# Each mapping specifies a URL path template and an HTTP method. The path

1290

# template may refer to one or more fields in the gRPC request message, as long

1291

# as each field is a non-repeated field with a primitive (non-message) type.

1292

# The path template controls how fields of the request message are mapped to

1293

# the URL path.

1294

#

1295

# Example:

Jon Wayne Parrott

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

[diff] [blame]

1296

#

1297

# service Messaging {

1298

# rpc GetMessage(GetMessageRequest) returns (Message) {

Bu Sun Kim

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

[diff] [blame]

1299

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame^]

1300

# get: "/v1/{name=messages/*}"

Bu Sun Kim

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

[diff] [blame]

1301

# };

Jon Wayne Parrott

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

[diff] [blame]

1302

# }

1303

# }

1304

# message GetMessageRequest {

Bu Sun Kim

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

[diff] [blame]

1305

# string name = 1; // Mapped to URL path.

Jon Wayne Parrott

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

[diff] [blame]

1306

# }

1307

# message Message {

Bu Sun Kim

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

[diff] [blame]

1308

# string text = 1; // The resource content.

Jon Wayne Parrott

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

[diff] [blame]

1309

# }

1310

#

Bu Sun Kim

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

[diff] [blame]

1311

# This enables an HTTP REST to gRPC mapping as below:

Jon Wayne Parrott

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

[diff] [blame]

1312

#

Bu Sun Kim

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

[diff] [blame]

1313

# HTTP | gRPC

Jon Wayne Parrott

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

[diff] [blame]

1314

# -----|-----

Bu Sun Kim

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

[diff] [blame^]

1315

# `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`

Jon Wayne Parrott

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

[diff] [blame]

1316

#

Bu Sun Kim

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

[diff] [blame]

1317

# Any fields in the request message which are not bound by the path template

1318

# automatically become HTTP query parameters if there is no HTTP request body.

1319

# For example:

Jon Wayne Parrott

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

[diff] [blame]

1320

#

Sai Cheemalapati

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

[diff] [blame]

1321

# service Messaging {

1322

# rpc GetMessage(GetMessageRequest) returns (Message) {

Bu Sun Kim

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

[diff] [blame]

1323

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame^]

1324

# get:"/v1/messages/{message_id}"

Bu Sun Kim

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

[diff] [blame]

1325

# };

Sai Cheemalapati

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

[diff] [blame]

1326

# }

1327

# }

Jon Wayne Parrott

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

[diff] [blame]

1328

# message GetMessageRequest {

1329

# message SubMessage {

1330

# string subfield = 1;

1331

# }

Bu Sun Kim

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

[diff] [blame]

1332

# string message_id = 1; // Mapped to URL path.

1333

# int64 revision = 2; // Mapped to URL query parameter `revision`.

1334

# SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.

Jon Wayne Parrott

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

[diff] [blame]

1335

# }

1336

#

Jon Wayne Parrott

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

[diff] [blame]

1337

# This enables a HTTP JSON to RPC mapping as below:

1338

#

Bu Sun Kim

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

[diff] [blame]

1339

# HTTP | gRPC

Jon Wayne Parrott

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

[diff] [blame]

1340

# -----|-----

Dan O'Meara

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

[diff] [blame]

1341

# `GET /v1/messages/123456?revision=2&sub.subfield=foo` |

Bu Sun Kim

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

[diff] [blame^]

1342

# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:

1343

# "foo"))`

Jon Wayne Parrott

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

[diff] [blame]

1344

#

Bu Sun Kim

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

[diff] [blame]

1345

# Note that fields which are mapped to URL query parameters must have a

1346

# primitive type or a repeated primitive type or a non-repeated message type.

1347

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

1348

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

1349

# message is mapped to a separate parameter, such as

Dan O'Meara

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

[diff] [blame]

1350

# `...?foo.a=A&foo.b=B&foo.c=C`.

Jon Wayne Parrott

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

[diff] [blame]

1351

#

Bu Sun Kim

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

[diff] [blame]

1352

# For HTTP methods that allow a request body, the `body` field

Jon Wayne Parrott

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

[diff] [blame]

1353

# specifies the mapping. Consider a REST update method on the

1354

# message resource collection:

1355

#

Jon Wayne Parrott

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

[diff] [blame]

1356

# service Messaging {

1357

# rpc UpdateMessage(UpdateMessageRequest) returns (Message) {

1358

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame^]

1359

# patch: "/v1/messages/{message_id}"

1360

# body: "message"

Jon Wayne Parrott

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

[diff] [blame]

# };

# }

# }

# message UpdateMessageRequest {

1365

# string message_id = 1; // mapped to the URL

1366

# Message message = 2; // mapped to the body

1367

# }

1368

#

Jon Wayne Parrott

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

[diff] [blame]

1369

# The following HTTP JSON to RPC mapping is enabled, where the

1370

# representation of the JSON in the request body is determined by

1371

# protos JSON encoding:

1372

#

Bu Sun Kim

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

[diff] [blame]

1373

# HTTP | gRPC

Jon Wayne Parrott

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

[diff] [blame]

1374

# -----|-----

Bu Sun Kim

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

[diff] [blame^]

1375

# `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:

1376

# "123456" message { text: "Hi!" })`

Jon Wayne Parrott

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

[diff] [blame]

1377

#

1378

# The special name `*` can be used in the body mapping to define that

1379

# every field not bound by the path template should be mapped to the

1380

# request body. This enables the following alternative definition of

1381

# the update method:

1382

#

Jon Wayne Parrott

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

[diff] [blame]

1383

# service Messaging {

1384

# rpc UpdateMessage(Message) returns (Message) {

1385

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame^]

1386

# patch: "/v1/messages/{message_id}"

1387

# body: "*"

Jon Wayne Parrott

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

[diff] [blame]

# };

# }

# }

# message Message {

# string message_id = 1;

1393

# string text = 2;

1394

# }

1395

#

Jon Wayne Parrott

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

[diff] [blame]

1396

#

1397

# The following HTTP JSON to RPC mapping is enabled:

1398

#

Bu Sun Kim

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

[diff] [blame]

1399

# HTTP | gRPC

Jon Wayne Parrott

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

[diff] [blame]

1400

# -----|-----

Bu Sun Kim

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

[diff] [blame^]

1401

# `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:

1402

# "123456" text: "Hi!")`

Jon Wayne Parrott

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

[diff] [blame]

1403

#

1404

# Note that when using `*` in the body mapping, it is not possible to

1405

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

1406

# the body. This makes this option more rarely used in practice when

Jon Wayne Parrott

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

[diff] [blame]

1407

# defining REST APIs. The common usage of `*` is in custom methods

Bu Sun Kim

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

[diff] [blame^]

1408

# which don't use the URL at all for transferring data.

Jon Wayne Parrott

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

[diff] [blame]

1409

#

1410

# It is possible to define multiple HTTP methods for one RPC by using

1411

# the `additional_bindings` option. Example:

1412

#

Jon Wayne Parrott

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

[diff] [blame]

1413

# service Messaging {

1414

# rpc GetMessage(GetMessageRequest) returns (Message) {

1415

# option (google.api.http) = {

Bu Sun Kim

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

[diff] [blame^]

1416

# get: "/v1/messages/{message_id}"

Jon Wayne Parrott

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

[diff] [blame]

1417

# additional_bindings {

Bu Sun Kim

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

[diff] [blame^]

1418

# get: "/v1/users/{user_id}/messages/{message_id}"

Jon Wayne Parrott

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

[diff] [blame]

1419

# }

1420

# };

Jon Wayne Parrott

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

[diff] [blame]

1421

# }

Jon Wayne Parrott

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

[diff] [blame]

1422

# }

1423

# message GetMessageRequest {

1424

# string message_id = 1;

1425

# string user_id = 2;

1426

# }

1427

#

Bu Sun Kim

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

[diff] [blame]

1428

# This enables the following two alternative HTTP JSON to RPC mappings:

Jon Wayne Parrott

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

[diff] [blame]

1429

#

Bu Sun Kim

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

[diff] [blame]

1430

# HTTP | gRPC

Jon Wayne Parrott

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

[diff] [blame]

1431

# -----|-----

Bu Sun Kim

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

[diff] [blame^]

1432

# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`

1433

# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:

1434

# "123456")`

Jon Wayne Parrott

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

[diff] [blame]

1435

#

Bu Sun Kim

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

[diff] [blame]

1436

# ## Rules for HTTP mapping

Jon Wayne Parrott

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

[diff] [blame]

1437

#

Bu Sun Kim

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

[diff] [blame]

1438

# 1. Leaf request fields (recursive expansion nested messages in the request

1439

# message) are classified into three categories:

1440

# - Fields referred by the path template. They are passed via the URL path.

1441

# - Fields referred by the HttpRule.body. They are passed via the HTTP

1442

# request body.

1443

# - All other fields are passed via the URL query parameters, and the

1444

# parameter name is the field path in the request message. A repeated

1445

# field can be represented as multiple query parameters under the same

1446

# name.

Bu Sun Kim

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

[diff] [blame^]

1447

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

1448

# are passed via URL path and HTTP request body.

1449

# 3. If HttpRule.body is omitted, there is no HTTP request body, all

1450

# fields are passed via URL path and URL query parameters.

Jon Wayne Parrott

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

[diff] [blame]

1451

#

Bu Sun Kim

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

[diff] [blame]

1452

# ### Path template syntax

Jon Wayne Parrott

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

[diff] [blame]

1453

#

Bu Sun Kim

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

[diff] [blame^]

1454

# Template = "/" Segments [ Verb ] ;

1455

# Segments = Segment { "/" Segment } ;

1456

# Segment = "*" | "**" | LITERAL | Variable ;

1457

# Variable = "{" FieldPath [ "=" Segments ] "}" ;

1458

# FieldPath = IDENT { "." IDENT } ;

1459

# Verb = ":" LITERAL ;

Jon Wayne Parrott

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

[diff] [blame]

1460

#

Bu Sun Kim

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

[diff] [blame]

1461

# The syntax `*` matches a single URL path segment. The syntax `**` matches

1462

# zero or more URL path segments, which must be the last part of the URL path

1463

# except the `Verb`.

Jon Wayne Parrott

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

[diff] [blame]

1464

#

Bu Sun Kim

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

[diff] [blame]

1465

# The syntax `Variable` matches part of the URL path as specified by its

1466

# template. A variable template must not contain other variables. If a variable

Jon Wayne Parrott

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

[diff] [blame]

1467

# matches a single path segment, its template may be omitted, e.g. `{var}`

1468

# is equivalent to `{var=*}`.

1469

#

Bu Sun Kim

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

[diff] [blame]

1470

# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`

1471

# contains any reserved character, such characters should be percent-encoded

1472

# before the matching.

Jon Wayne Parrott

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

[diff] [blame]

1473

#

Bu Sun Kim

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

[diff] [blame^]

1474

# If a variable contains exactly one path segment, such as `"{var}"` or

1475

# `"{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]

1476

# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The

1477

# server side does the reverse decoding. Such variables show up in the

1478

# [Discovery

1479

# Document](https://developers.google.com/discovery/v1/reference/apis) as

1480

# `{var}`.

1481

#

Bu Sun Kim

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

[diff] [blame^]

1482

# If a variable contains multiple path segments, such as `"{var=foo/*}"`

1483

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

1484

# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.

Bu Sun Kim

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

[diff] [blame^]

1485

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

1486

# unchanged. Such variables show up in the

1487

# [Discovery

1488

# Document](https://developers.google.com/discovery/v1/reference/apis) as

1489

# `{+var}`.

1490

#

1491

# ## Using gRPC API Service Configuration

1492

#

1493

# gRPC API Service Configuration (service config) is a configuration language

1494

# for configuring a gRPC service to become a user-facing product. The

1495

# service config is simply the YAML representation of the `google.api.Service`

1496

# proto message.

1497

#

1498

# As an alternative to annotating your proto file, you can configure gRPC

1499

# transcoding in your service config YAML files. You do this by specifying a

1500

# `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same

1501

# effect as the proto annotation. This can be particularly useful if you

1502

# have a proto that is reused in multiple services. Note that any transcoding

1503

# specified in the service config will override any matching transcoding

1504

# configuration in the proto.

#

# Example:

#

# http:

# rules:

# # Selects a gRPC method and applies HttpRule to it.

1511

# - selector: example.v1.Messaging.GetMessage

1512

# get: /v1/messages/{message_id}/{sub.subfield}

#

# ## Special notes

#

# When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the

1517

# proto to JSON conversion must follow the [proto3

1518

# specification](https://developers.google.com/protocol-buffers/docs/proto3#json).

1519

#

1520

# While the single segment variable follows the semantics of

1521

# [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String

1522

# Expansion, the multi segment variable **does not** follow RFC 6570 Section

1523

# 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion

1524

# does not expand special characters like `?` and `#`, which would lead

1525

# to invalid URLs. As the result, gRPC Transcoding uses a custom encoding

1526

# for multi segment variables.

1527

#

1528

# The path variables **must not** refer to any repeated or mapped field,

1529

# because client libraries are not capable of handling such variable expansion.

1530

#

Bu Sun Kim

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

[diff] [blame^]

1531

# The path variables **must not** capture the leading "/" character. The reason

1532

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

1533

# character. For consistency, all path variables must share the same behavior.

1534

#

1535

# Repeated message fields must not be mapped to URL query parameters, because

1536

# no client library can support such complicated mapping.

1537

#

1538

# If an API needs to use a JSON array for request or response body, it can map

1539

# the request or response body to a repeated field. However, some gRPC

1540

# Transcoding implementations may not support this feature.

Bu Sun Kim

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

[diff] [blame^]

1541

"delete": "A String", # Maps to HTTP DELETE. Used for deleting a resource.

1542

"additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must

Jon Wayne Parrott

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

[diff] [blame]

1543

# not contain an `additional_bindings` field themselves (that is,

1544

# the nesting may only be one level deep).

1545

# Object with schema name: HttpRule

1546

],

Bu Sun Kim

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

[diff] [blame^]

1547

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

1548

# response body. When omitted, the entire response message will be used

1549

# as the HTTP response body.

1550

#

1551

# NOTE: The referred field must be present at the top-level of the response

1552

# message type.

Bu Sun Kim

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

[diff] [blame^]

1553

"body": "A String", # The name of the request field whose value is mapped to the HTTP request

1554

# body, or `*` for mapping all request fields not captured by the path

1555

# pattern to the HTTP body, or omitted for not having any HTTP request body.

1556

#

1557

# NOTE: the referred field must be present at the top-level of the request

1558

# message type.

1559

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

1560

#

1561

# Refer to selector for syntax details.

1562

"post": "A String", # Maps to HTTP POST. Used for creating a resource or performing an action.

1563

"custom": { # A custom pattern is used for defining custom HTTP verb. # The custom pattern is used for specifying an HTTP method that is not

1564

# included in the `pattern` field, such as HEAD, or "*" to leave the

Bu Sun Kim

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

[diff] [blame]

1565

# HTTP method unspecified for this rule. The wild-card rule is useful

1566

# for services that provide content to Web (HTML) clients.

Bu Sun Kim

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

[diff] [blame^]

1567

"kind": "A String", # The name of this custom HTTP verb.

1568

"path": "A String", # The path matched by this custom verb.

Thomas Coffee

2f24537

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

[diff] [blame]

1569

},

Bu Sun Kim

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

[diff] [blame^]

1570

"patch": "A String", # Maps to HTTP PATCH. Used for updating a resource.

1571

"get": "A String", # Maps to HTTP GET. Used for listing and getting information about

1572

# resources.

1573

"allowHalfDuplex": True or False, # When this flag is set to true, HTTP requests will be allowed to invoke a

1574

# half-duplex streaming method.

1575

"put": "A String", # Maps to HTTP PUT. Used for replacing a resource.

Jon Wayne Parrott

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

[diff] [blame]

1576

},

1577

],

1578

},

Bu Sun Kim

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

[diff] [blame^]

1579

"systemParameters": { # ### System parameter configuration # System parameter configuration.

1580

#

1581

# A system parameter is a special kind of parameter defined by the API

1582

# system, not by an individual API. It is typically mapped to an HTTP header

1583

# and/or a URL query parameter. This configuration specifies which methods

1584

# change the names of the system parameters.

1585

"rules": [ # Define system parameters.

Bu Sun Kim

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

[diff] [blame]

1586

#

Bu Sun Kim

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

[diff] [blame^]

1587

# The parameters defined here will override the default parameters

1588

# implemented by the system. If this field is missing from the service

1589

# config, default system parameters will be used. Default system parameters

1590

# and names is implementation-dependent.

1591

#

1592

# Example: define api key for all methods

#

# system_parameters

# rules:

# - selector: "*"

# parameters:

# - name: api_key

# url_query_parameter: api_key

1600

#

1601

#

1602

# Example: define 2 api key names for a specific method.

#

# system_parameters

# rules:

# - selector: "/ListShelves"

1607

# parameters:

1608

# - name: api_key

1609

# http_header: Api-Key1

1610

# - name: api_key

1611

# http_header: Api-Key2

1612

#

1613

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

1614

{ # Define a system parameter rule mapping system parameter definitions to

1615

# methods.

1616

"parameters": [ # Define parameters. Multiple names may be defined for a parameter.

1617

# For a given method call, only one of them should be used. If multiple

1618

# names are used the behavior is implementation-dependent.

1619

# If none of the specified names are present the behavior is

1620

# parameter-dependent.

1621

{ # Define a parameter's name and location. The parameter may be passed as either

1622

# an HTTP header or a URL query parameter, and if both are passed the behavior

1623

# is implementation-dependent.

1624

"httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case

1625

# insensitive.

1626

"name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.

1627

"urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case

1628

# sensitive.

Jon Wayne Parrott

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

[diff] [blame]

1629

},

Bu Sun Kim

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

[diff] [blame^]

1630

],

1631

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

1632

# methods in all APIs.

1633

#

1634

# Refer to selector for syntax details.

},

],

},

"backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.

1639

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

1640

#

1641

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

1642

{ # A backend rule provides configuration for an individual API element.

1643

"protocol": "A String", # The protocol used for sending a request to the backend.

1644

# The supported values are "http/1.1" and "h2".

1645

#

1646

# The default value is inferred from the scheme in the

# address field:

#

# SCHEME PROTOCOL

# http:// http/1.1

# https:// http/1.1

# grpc:// h2

# grpcs:// h2

#

# For secure HTTP backends (https://) that support HTTP/2, set this field

1656

# to "h2" for improved performance.

1657

#

1658

# Configuring this field to non-default values is only supported for secure

1659

# HTTP backends. This field will be ignored for all other backends.

1660

#

1661

# See

1662

# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids

1663

# for more details on the supported values.

1664

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

1665

#

1666

# Refer to selector for syntax details.

1667

"operationDeadline": 3.14, # The number of seconds to wait for the completion of a long running

1668

# operation. The default is no deadline.

1669

"deadline": 3.14, # The number of seconds to wait for a response from a request. The default

1670

# varies based on the request protocol and deployment environment.

1671

"minDeadline": 3.14, # Minimum deadline in seconds needed for this method. Calls having deadline

1672

# value lower than this will be rejected.

1673

"address": "A String", # The address of the API backend.

1674

#

1675

# The scheme is used to determine the backend protocol and security.

1676

# The following schemes are accepted:

1677

#

1678

# 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

1685

# may cause constrasting behaviors across platforms.

1686

#

1687

# If the port is unspecified, the default is:

1688

# - 80 for schemes without TLS

1689

# - 443 for schemes with TLS

1690

#

1691

# For HTTP backends, use protocol

1692

# to specify the protocol version.

1693

"pathTranslation": "A String",

1694

"jwtAudience": "A String", # The JWT audience is used when generating a JWT ID token for the backend.

1695

# This ID token will be added in the HTTP "authorization" header, and sent

1696

# to the backend.

1697

"disableAuth": True or False, # When disable_auth is true, a JWT ID token won't be generated and the

1698

# original "Authorization" HTTP header will be preserved. If the header is

1699

# used to carry the original token and is expected by the backend, this

1700

# field must be set to true to preserve the header.

1701

"renameTo": "A String", # Unimplemented. Do not use.

1702

#

1703

# The new name the selected proto elements should be renamed to.

1704

#

1705

# The package, the service and the method can all be renamed.

1706

# The backend server should implement the renamed proto. However, clients

1707

# should call the original method, and ESF routes the traffic to the renamed

1708

# method.

1709

#

1710

# HTTP clients should call the URL mapped to the original method.

1711

# gRPC and Stubby clients should call the original method with package name.

1712

#

1713

# For legacy reasons, ESF allows Stubby clients to call with the

1714

# short name (without the package name). However, for API Versioning(or

1715

# multiple methods mapped to the same short name), all Stubby clients must

1716

# call the method's full name with the package name, otherwise the first one

1717

# (selector) wins.

1718

#

1719

# If this `rename_to` is specified with a trailing `*`, the `selector` must

1720

# be specified with a trailing `*` as well. The all element short names

1721

# matched by the `*` in the selector will be kept in the `rename_to`.

#

# For example,

# rename_rules:

# - selector: |-

# google.example.library.v1.*

1727

# rename_to: google.example.library.*

1728

#

1729

# The selector matches `google.example.library.v1.Library.CreateShelf` and

1730

# `google.example.library.v1.Library.CreateBook`, they will be renamed to

1731

# `google.example.library.Library.CreateShelf` and

1732

# `google.example.library.Library.CreateBook`. It essentially renames the

1733

# proto package name section of the matched proto service and methods.

},

],

},

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

1738

#

1739

# Example:

1740

# <pre><code>documentation:

1741

# summary: >

1742

# The Google Calendar API gives access

1743

# to most calendar features.

1744

# pages:

1745

# - name: Overview

1746

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

1747

# - name: Tutorial

1748

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

1749

# subpages;

1750

# - name: Java

1751

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

1752

# rules:

1753

# - selector: google.calendar.Calendar.Get

1754

# description: >

1755

# ...

1756

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1761

# standard markdown features, definition lists, tables and fenced

1762

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

1763

# interpreted relative to the section nesting of the context where

1764

# a documentation fragment is embedded.

1765

#

1766

# Documentation from the IDL is merged with documentation defined

1767

# via the config at normalization time, where documentation provided

1768

# by config rules overrides IDL provided.

1769

#

1770

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

1771

# in documentation text.

1772

#

1773

# In order to reference a proto element, the following

1774

# notation can be used:

1775

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

1776

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

1777

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

1778

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

1779

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

1780

#

1781

# A few directives are available in documentation. Note that

1782

# directives must appear on a single line to be properly

1783

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

1784

# an external source:

1785

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

1786

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

1787

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

1788

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

1789

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

1790

# The directive `suppress_warning` does not directly affect documentation

1791

# and is documented together with service config validation.

1792

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

1793

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

1794

#

1795

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

1796

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

1797

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

1798

# an element is marked as `deprecated`.

1799

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

1800

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

1801

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

1802

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

1803

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

1804

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

1805

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

1806

},

1807

],

1808

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

1809

# plain text.

1810

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

1811

# <pre><code>documentation:

1812

# summary: ...

1813

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

1814

# </code></pre>

1815

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

1816

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

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

1821

# </code></pre>

1822

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

1823

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

1824

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

1825

# nested documentation set structure.

1826

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

1827

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

1828

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

1829

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

1830

# documentation. For example:

1831

# <pre><code>pages:

1832

# - name: Tutorial

1833

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

1834

# subpages:

1835

# - name: Java

1836

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

1837

# </code></pre>

1838

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

1839

# `Java`.

1840

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

1841

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

1842

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

1843

# honored in the generated docset.

1844

# Object with schema name: Page

],

},

],

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

1849

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

1850

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

1851

# urls are relative to.

1852

},

1853

"logging": { # Logging configuration of the service. # Logging configuration.

1854

#

1855

# The following example shows how to configure logs to be sent to the

1856

# producer and consumer projects. In the example, the `activity_history`

1857

# log is sent to both the producer and consumer projects, whereas the

1858

# `purchase_history` log is only sent to the producer project.

1859

#

1860

# monitored_resources:

1861

# - type: library.googleapis.com/branch

1862

# labels:

1863

# - key: /city

1864

# description: The city where the library branch is located in.

1865

# - key: /name

1866

# description: The name of the branch.

1867

# logs:

1868

# - name: activity_history

1869

# labels:

1870

# - key: /customer_id

1871

# - name: purchase_history

1872

# logging:

1873

# producer_destinations:

1874

# - monitored_resource: library.googleapis.com/branch

# logs:

# - activity_history

# - purchase_history

# consumer_destinations:

1879

# - monitored_resource: library.googleapis.com/branch

1880

# logs:

1881

# - activity_history

1882

"producerDestinations": [ # Logging configurations for sending logs to the producer project.

1883

# There can be multiple producer destinations, each one must have a

1884

# different monitored resource type. A log can be used in at most

1885

# one producer destination.

1886

{ # Configuration of a specific logging destination (the producer project

1887

# or the consumer project).

1888

"logs": [ # Names of the logs to be sent to this destination. Each name must

1889

# be defined in the Service.logs section. If the log name is

1890

# not a domain scoped name, it will be automatically prefixed with

1891

# the service name followed by "/".

1892

"A String",

1893

],

1894

"monitoredResource": "A String", # The monitored resource type. The type must be defined in the

1895

# Service.monitored_resources section.

1896

},

1897

],

1898

"consumerDestinations": [ # Logging configurations for sending logs to the consumer project.

1899

# There can be multiple consumer destinations, each one must have a

1900

# different monitored resource type. A log can be used in at most

1901

# one consumer destination.

1902

{ # Configuration of a specific logging destination (the producer project

1903

# or the consumer project).

1904

"logs": [ # Names of the logs to be sent to this destination. Each name must

1905

# be defined in the Service.logs section. If the log name is

1906

# not a domain scoped name, it will be automatically prefixed with

1907

# the service name followed by "/".

1908

"A String",

1909

],

1910

"monitoredResource": "A String", # The monitored resource type. The type must be defined in the

1911

# Service.monitored_resources section.

},

],

},

"monitoredResources": [ # Defines the monitored resources used by this service. This is required

1916

# by the Service.monitoring and Service.logging configurations.

1917

{ # An object that describes the schema of a MonitoredResource object using a

1918

# type name and a set of labels. For example, the monitored resource

1919

# descriptor for Google Compute Engine VM instances has a type of

1920

# `"gce_instance"` and specifies the use of the labels `"instance_id"` and

1921

# `"zone"` to identify particular VM instances.

1922

#

1923

# Different APIs can support different monitored resource types. APIs generally

1924

# provide a `list` method that returns the monitored resource descriptors used

1925

# by the API.

1926

"displayName": "A String", # Optional. A concise name for the monitored resource type that might be

1927

# displayed in user interfaces. It should be a Title Cased Noun Phrase,

1928

# without any article or other determiners. For example,

1929

# `"Google Cloud SQL Database"`.

1930

"description": "A String", # Optional. A detailed description of the monitored resource type that might

1931

# be used in documentation.

1932

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

1933

"labels": [ # Required. A set of labels used to describe instances of this monitored

1934

# resource type. For example, an individual Google Cloud SQL database is

1935

# identified by values for the labels `"database_id"` and `"zone"`.

1936

{ # A description of a label.

1937

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

1938

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

1939

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

Jon Wayne Parrott

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

[diff] [blame]

1940

},

1941

],

Bu Sun Kim

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

[diff] [blame^]

1942

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

1943

# `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where

1944

# {type} is the value of the `type` field in this object and

1945

# {project_id} is a project ID that provides API-specific context for

1946

# accessing the type. APIs that do not use project information can use the

1947

# resource name format `"monitoredResourceDescriptors/{type}"`.

1948

"type": "A String", # Required. The monitored resource type. For example, the type

1949

# `"cloudsql_database"` represents databases in Google Cloud SQL.

1950

# The maximum length of this value is 256 characters.

Jon Wayne Parrott

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

[diff] [blame]

1951

},

1952

],

Bu Sun Kim

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

[diff] [blame^]

1953

"context": { # `Context` defines which contexts an API requests. # Context configuration.

Jon Wayne Parrott

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

[diff] [blame]

1954

#

1955

# Example:

1956

#

Bu Sun Kim

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

[diff] [blame^]

# context:

# rules:

# - selector: "*"

# requested:

# - google.rpc.context.ProjectContext

1962

# - google.rpc.context.OriginContext

1963

#

1964

# The above specifies that all methods in the API request

1965

# `google.rpc.context.ProjectContext` and

1966

# `google.rpc.context.OriginContext`.

1967

#

1968

# Available context types are defined in package

1969

# `google.rpc.context`.

1970

#

1971

# This also provides mechanism to whitelist any protobuf message extension that

1972

# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and

1973

# “x-goog-ext-<extension_id>-jspb” format. For example, list any service

1974

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

1982

# allowed_request_extensions:

1983

# - google.foo.v1.NewExtension

1984

# allowed_response_extensions:

1985

# - google.foo.v1.NewExtension

1986

#

1987

# You can also specify extension ID instead of fully qualified extension name

1988

# here.

1989

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

1990

#

Bu Sun Kim

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

[diff] [blame^]

1991

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

1992

{ # A context rule provides information about the context for an individual API

1993

# element.

1994

"requested": [ # A list of full type names of requested contexts.

1995

"A String",

1996

],

1997

"allowedRequestExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc

1998

# side channel from client to backend.

1999

"A String",

2000

],

2001

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc

2002

# side channel from backend to client.

2003

"A String",

2004

],

2005

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

Jon Wayne Parrott

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

[diff] [blame]

2006

#

2007

# Refer to selector for syntax details.

Bu Sun Kim

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

[diff] [blame^]

2008

"provided": [ # A list of full type names of provided contexts.

2009

"A String",

2010

],

Jon Wayne Parrott

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

[diff] [blame]

2011

},

2012

],

2013

},

Bu Sun Kim

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

[diff] [blame^]

2014

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

2015

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

2016

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

2017

# should be listed here by name. Example:

2018

#

2019

# enums:

2020

# - name: google.someapi.v1.SomeEnum

2021

{ # Enum type definition.

2022

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

2023

"enumvalue": [ # Enum value definitions.

2024

{ # Enum value definition.

2025

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

2026

"options": [ # Protocol buffer options.

2027

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

2028

# enumeration, etc.

2029

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

2030

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

2031

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

2032

# value using the google.protobuf.Int32Value type.

2033

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

2034

},

2035

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

2036

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

2037

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

2038

# `"google.api.http"`.

2039

},

2040

],

2041

"number": 42, # Enum value number.

2042

},

2043

],

2044

"options": [ # Protocol buffer options.

2045

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

2046

# enumeration, etc.

2047

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

2048

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

2049

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

2050

# value using the google.protobuf.Int32Value type.

2051

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

2052

},

2053

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

2054

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

2055

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

2056

# `"google.api.http"`.

2057

},

2058

],

2059

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

2060

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

2061

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

2062

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

2063

},

2064

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

2065

},

2066

],

2067

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

2068

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

2069

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

2070

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

2071

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

2072

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

2073

# service producer.

2074

#

2075

# Google Service Management currently only supports

2076

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

2077

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

2078

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

2079

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

2080

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

2081

#

2082

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

2083

{ # Usage configuration rules for the service.

2084

#

2085

# NOTE: Under development.

2086

#

2087

#

2088

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

2089

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

2090

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

2091

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

2092

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

2093

# allow/disallow unregistered calls.

2094

#

2095

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

#

# usage:

# rules:

# - selector: "*"

# allow_unregistered_calls: true

2101

#

2102

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

#

# usage:

# rules:

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

2107

# allow_unregistered_calls: true

2108

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

2109

# methods in all APIs.

2110

#

2111

# Refer to selector for syntax details.

2112

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

2113

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

2114

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

2115

# methods, such as service health check methods.

2116

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

2117

# that don't identify any user or application.

2118

},

2119

],

2120

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

2121

#

2122

#

2123

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

2124

# Example of a service identity configuration.

#

# usage:

# service_identity:

# - service_account_parent: "projects/123456789"

2129

# display_name: "Cloud XXX Service Agent"

2130

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

2131

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

2132

#

2133

# An example name would be:

2134

# `projects/123456789`

2135

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

2136

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

2137

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

2138

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

2139

},

2140

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

2141

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

2142

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

"A String",

],

},

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

Jon Wayne Parrott

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

[diff] [blame]

2147

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

Bu Sun Kim

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

[diff] [blame^]

2148

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

Jon Wayne Parrott

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

[diff] [blame]

2149

# existing data unusable.

Bu Sun Kim

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

[diff] [blame^]

2150

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

2151

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

Bu Sun Kim

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

[diff] [blame]

2152

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

2153

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

2154

# use a natural hierarchical grouping. For example:

Jon Wayne Parrott

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

[diff] [blame]

2155

#

Bu Sun Kim

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

[diff] [blame^]

2156

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

2157

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

2158

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

2159

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

2160

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

2161

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

2162

# data loss due to errors.

2163

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

2164

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

2165

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

2166

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

2167

# a smaller sampling period.

2168

},

2169

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

2170

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

2171

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

2172

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

2173

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

2174

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

2175

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

2176

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

2177

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

2178

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

Dan O'Meara

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

[diff] [blame]

2179

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

2180

# defines the representation of the stored metric values.

2181

#

2182

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

2183

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

2184

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

2185

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

2186

# matter how it may be displayed..

2187

#

2188

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

2189

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

2190

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

2191

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

2192

#

2193

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

2194

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

2195

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

2196

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

2197

#

2198

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

Jon Wayne Parrott

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

[diff] [blame]

2199

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

2200

#

2201

# **Basic units (UNIT)**

#

# * `bit` bit

# * `By` byte

# * `s` second

# * `min` minute

# * `h` hour

# * `d` day

#

# **Prefixes (PREFIX)**

2211

#

Dan O'Meara

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

[diff] [blame]

# * `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)

2219

# * `Y` yotta (10^24)

2220

#

2221

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

2222

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

2223

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

2224

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

2225

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

2226

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

2227

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

2228

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

#

# * `Ki` kibi (2^10)

# * `Mi` mebi (2^20)

# * `Gi` gibi (2^30)

# * `Ti` tebi (2^40)

# * `Pi` pebi (2^50)

Jon Wayne Parrott

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

[diff] [blame]

2235

#

2236

# **Grammar**

2237

#

Jon Wayne Parrott

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

[diff] [blame]

2238

# The grammar also includes these connectors:

2239

#

Dan O'Meara

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

[diff] [blame]

2240

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

2241

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

2242

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

2243

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

2244

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

2245

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

Jon Wayne Parrott

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

[diff] [blame]

2246

#

2247

# The grammar for a unit is as follows:

2248

#

Bu Sun Kim

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

[diff] [blame^]

2249

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

Jon Wayne Parrott

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

[diff] [blame]

2250

#

Bu Sun Kim

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

[diff] [blame^]

2251

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

Jon Wayne Parrott

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

[diff] [blame]

2252

# | Annotation

Bu Sun Kim

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

[diff] [blame^]

2253

# | "1"

Jon Wayne Parrott

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

[diff] [blame]

2254

# ;

2255

#

Bu Sun Kim

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

[diff] [blame^]

2256

# Annotation = "{" NAME "}" ;

Jon Wayne Parrott

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

[diff] [blame]

2257

#

2258

# Notes:

2259

#

Dan O'Meara

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

[diff] [blame]

2260

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

2261

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

2262

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

Jon Wayne Parrott

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

[diff] [blame]

2263

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

Dan O'Meara

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

[diff] [blame]

2264

# containing `{` or `}`.

2265

# * `1` represents a unitary [dimensionless

2266

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

2267

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

Bu Sun Kim

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

[diff] [blame^]

2268

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

2269

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

2270

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

Dan O'Meara

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

[diff] [blame]

2271

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

Bu Sun Kim

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

[diff] [blame^]

2272

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

Dan O'Meara

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

[diff] [blame]

2273

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

2274

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

Bu Sun Kim

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

[diff] [blame^]

2275

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

Dan O'Meara

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

[diff] [blame]

2276

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

2277

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

Bu Sun Kim

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

[diff] [blame^]

2278

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

2279

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

2280

# series, which is identified partially by

2281

# a metric type and a MonitoredResourceDescriptor, that is associated

2282

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

2283

# resource types listed here.

2284

"A String",

Dan O'Meara

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

[diff] [blame]

2285

],

Bu Sun Kim

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

[diff] [blame^]

2286

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

2287

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

2288

# instance of this metric type. For example, the

2289

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

2290

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

2291

# you can look at latencies for successful responses or just

2292

# for responses that failed.

2293

{ # A description of a label.

2294

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

2295

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

2296

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

Sai Cheemalapati

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

[diff] [blame]

2297

},

2298

],

Jon Wayne Parrott

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

[diff] [blame]

2299

},

2300

],

Bu Sun Kim

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

[diff] [blame^]

2301

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

Jon Wayne Parrott

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

[diff] [blame]

2302

#

Bu Sun Kim

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

[diff] [blame^]

2303

# Example for an API targeted for external use:

Jon Wayne Parrott

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

[diff] [blame]

2304

#

Bu Sun Kim

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

[diff] [blame^]

2305

# name: calendar.googleapis.com

2306

# authentication:

2307

# providers:

2308

# - id: google_calendar_auth

2309

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

2310

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

Jon Wayne Parrott

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

[diff] [blame]

2311

# rules:

Bu Sun Kim

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

[diff] [blame^]

2312

# - selector: "*"

2313

# requirements:

2314

# provider_id: google_calendar_auth

2315

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

Jon Wayne Parrott

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

[diff] [blame]

2316

#

Bu Sun Kim

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

[diff] [blame^]

2317

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

2318

{ # Authentication rules for the service.

2319

#

2320

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

2321

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

2322

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

2323

# request.

2324

#

2325

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

2326

# ignored.

2327

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

2328

{ # User-defined authentication requirements, including support for

2329

# [JSON Web Token

2330

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

2331

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

#

# Example:

#

# provider_id: bookstore_auth

2336

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

2337

# implemented and accepted in all the runtime components.

2338

#

2339

# The list of JWT

2340

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

2341

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

2342

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

2343

# "https://Service_name/API_name"

2344

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

2345

# LibraryService API will only accept JWTs with the following audience

2346

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

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

2351

# bookstore_web.apps.googleusercontent.com

2352

},

Jon Wayne Parrott

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

[diff] [blame]

2353

],

Bu Sun Kim

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

[diff] [blame^]

2354

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

Dan O'Meara

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

[diff] [blame]

2355

#

2356

# Refer to selector for syntax details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2357

"allowWithoutCredential": True or False, # If true, the service accepts API keys without any other credential.

2358

"oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.

2359

# there are scopes defined for "Read-only access to Google Calendar" and

2360

# "Access to Cloud Platform". Users can consent to a scope for an application,

2361

# giving it permission to access that data on their behalf.

2362

#

2363

# OAuth scope specifications should be fairly coarse grained; a user will need

2364

# to see and understand the text description of what your scope means.

2365

#

2366

# In most cases: use one or at most two OAuth scopes for an entire family of

2367

# products. If your product has multiple APIs, you should probably be sharing

2368

# the OAuth scope across all of those APIs.

2369

#

2370

# When you need finer grained OAuth consent screens: talk with your product

2371

# management about how developers will use them in practice.

2372

#

2373

# Please note that even though each of the canonical scopes is enough for a

2374

# request to be accepted and passed to the backend, a request can still fail

2375

# due to the backend requiring additional scopes or permissions.

2376

"canonicalScopes": "A String", # The list of publicly documented OAuth scopes that are allowed access. An

2377

# OAuth token containing any of these scopes will be accepted.

#

# Example:

#

# canonical_scopes: https://www.googleapis.com/auth/calendar,

2382

# https://www.googleapis.com/auth/calendar.read

},

},

],

"providers": [ # Defines a set of authentication providers that a service supports.

2387

{ # Configuration for an authentication provider, including support for

2388

# [JSON Web Token

2389

# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

2390

"jwksUri": "A String", # URL of the provider's public key set to validate signature of the JWT. See

2391

# [OpenID

2392

# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).

2393

# Optional if the key set document:

2394

# - can be retrieved from

2395

# [OpenID

2396

# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of

2397

# the issuer.

2398

# - can be inferred from the email domain of the issuer (e.g. a Google

2399

# service account).

2400

#

2401

# Example: https://www.googleapis.com/oauth2/v1/certs

2402

"audiences": "A String", # The list of JWT

2403

# [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).

2404

# that are allowed to access. A JWT containing any of these audiences will

2405

# be accepted. When this setting is absent, JWTs with audiences:

2406

# - "https://[service.name]/[google.protobuf.Api.name]"

2407

# - "https://[service.name]/"

2408

# will be accepted.

2409

# For example, if no audiences are in the setting, LibraryService API will

2410

# accept JWTs with the following audiences:

2411

# -

2412

# https://library-example.googleapis.com/google.example.library.v1.LibraryService

2413

# - https://library-example.googleapis.com/

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

2418

# bookstore_web.apps.googleusercontent.com

2419

"authorizationUrl": "A String", # Redirect URL if JWT token is required but not present or is expired.

2420

# Implement authorizationUrl of securityDefinitions in OpenAPI spec.

2421

"issuer": "A String", # Identifies the principal that issued the JWT. See

2422

# https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1

2423

# Usually a URL or an email address.

2424

#

2425

# Example: https://securetoken.google.com

2426

# Example: 1234567-compute@developer.gserviceaccount.com

2427

"id": "A String", # The unique identifier of the auth provider. It will be referred to by

2428

# `AuthRequirement.provider_id`.

2429

#

2430

# Example: "bookstore_auth".

2431

"jwtLocations": [ # Defines the locations to extract the JWT.

2432

#

2433

# JWT locations can be either from HTTP headers or URL query parameters.

2434

# The rule is that the first match wins. The checking order is: checking

2435

# all headers first, then URL query parameters.

2436

#

2437

# If not specified, default to use following 3 locations:

2438

# 1) Authorization: Bearer

2439

# 2) x-goog-iap-jwt-assertion

2440

# 3) access_token query parameter

2441

#

2442

# Default locations can be specified as followings:

2443

# jwt_locations:

2444

# - header: Authorization

2445

# value_prefix: "Bearer "

2446

# - header: x-goog-iap-jwt-assertion

2447

# - query: access_token

2448

{ # Specifies a location to extract JWT from an API request.

2449

"header": "A String", # Specifies HTTP header name to extract JWT token.

2450

"valuePrefix": "A String", # The value prefix. The value format is "value_prefix{token}"

2451

# Only applies to "in" header type. Must be empty for "in" query type.

2452

# If not empty, the header value has to match (case sensitive) this prefix.

2453

# If not matched, JWT will not be extracted. If matched, JWT will be

2454

# extracted after the prefix is removed.

2455

#

2456

# For example, for "Authorization: Bearer {JWT}",

2457

# value_prefix="Bearer " with a space at the end.

2458

"query": "A String", # Specifies URL query parameter name to extract JWT token.

2459

},

2460

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2461

},

2462

],

2463

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2464

"control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.

2465

# service controller handles features like abuse, quota, billing, logging,

2466

# monitoring, etc.

2467

"environment": "A String", # The service control environment to use. If empty, no control plane

2468

# feature (like quota and billing) will be enabled.

2469

},

2470

"configVersion": 42, # The semantic version of the service configuration. The config version

2471

# affects the interpretation of the service configuration. For example,

2472

# certain features are enabled by default for certain config versions.

2473

#

2474

# The latest config version is `3`.

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]

2479

<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]

2480

<pre>Gets the access control policy for a resource.

2481

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]

2486

See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2487

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2488

The object takes the form of:

2489

2490

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2491

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

2492

# `GetIamPolicy`.

2493

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2494

#

2495

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

2496

# rejected.

2497

#

2498

# Requests for policies with any conditional bindings must specify version 3.

2499

# Policies without any conditional bindings may specify any valid value or

2500

# leave the field unset.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2501

#

2502

# To learn which resources support conditions in their IAM policies, see the

2503

# [IAM

2504

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2505

},

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2506

}

2507

2508

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2515

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2516

{ # An Identity and Access Management (IAM) policy, which specifies access

2517

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2518

#

2519

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2520

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

2521

# `members` to a single `role`. Members can be user accounts, service accounts,

2522

# Google groups, and domains (such as G Suite). A `role` is a named list of

2523

# permissions; each `role` can be an IAM predefined role or a user-created

2524

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2525

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2526

# For some types of Google Cloud resources, a `binding` can also specify a

2527

# `condition`, which is a logical expression that allows access to a resource

2528

# only if the expression evaluates to `true`. A condition can add constraints

2529

# based on attributes of the request, the resource, or both. To learn which

2530

# resources support conditions in their IAM policies, see the

2531

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2532

#

2533

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2534

#

2535

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2536

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2537

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2538

# "role": "roles/resourcemanager.organizationAdmin",

2539

# "members": [

2540

# "user:mike@example.com",

2541

# "group:admins@example.com",

2542

# "domain:google.com",

2543

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2544

# ]

2545

# },

2546

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2547

# "role": "roles/resourcemanager.organizationViewer",

2548

# "members": [

2549

# "user:eve@example.com"

2550

# ],

2551

# "condition": {

2552

# "title": "expirable access",

2553

# "description": "Does not grant access after Sep 2020",

2554

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2555

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2556

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2557

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2558

# "etag": "BwWWja0YfJA=",

2559

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2560

# }

2561

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2562

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

2567

# - group:admins@example.com

2568

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2569

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

2570

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2571

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2572

# - user:eve@example.com

2573

# role: roles/resourcemanager.organizationViewer

2574

# condition:

2575

# title: expirable access

2576

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2577

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2578

# - etag: BwWWja0YfJA=

2579

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2580

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2581

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2582

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2583

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2584

# prevent simultaneous updates of a policy from overwriting each other.

2585

# It is strongly suggested that systems make use of the `etag` in the

2586

# read-modify-write cycle to perform policy updates in order to avoid race

2587

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2588

# systems are expected to put that etag in the request to `setIamPolicy` to

2589

# ensure that their change will be applied to the same version of the policy.

2590

#

2591

# **Important:** If you use IAM Conditions, you must include the `etag` field

2592

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2593

# you to overwrite a version `3` policy with a version `1` policy, and all of

2594

# the conditions in the version `3` policy are lost.

2595

"version": 42, # Specifies the format of the policy.

2596

#

2597

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

2598

# are rejected.

2599

#

2600

# Any operation that affects conditional role bindings must specify version

2601

# `3`. This requirement applies to the following operations:

2602

#

2603

# * Getting a policy that includes a conditional role binding

2604

# * Adding a conditional role binding to a policy

2605

# * Changing a conditional role binding in a policy

2606

# * Removing any role binding, with or without a condition, from a policy

2607

# that includes conditions

2608

#

2609

# **Important:** If you use IAM Conditions, you must include the `etag` field

2610

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2611

# you to overwrite a version `3` policy with a version `1` policy, and all of

2612

# the conditions in the version `3` policy are lost.

2613

#

2614

# If a policy does not include any conditions, operations on that policy may

2615

# specify any valid version or leave the field unset.

2616

#

2617

# To learn which resources support conditions in their IAM policies, see the

2618

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2619

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2620

{ # Specifies the audit configuration for a service.

2621

# The configuration determines which permission types are logged, and what

2622

# identities, if any, are exempted from logging.

2623

# An AuditConfig must have one or more AuditLogConfigs.

2624

#

2625

# If there are AuditConfigs for both `allServices` and a specific service,

2626

# the union of the two AuditConfigs is used for that service: the log_types

2627

# specified in each AuditConfig are enabled, and the exempted_members in each

2628

# AuditLogConfig are exempted.

2629

#

2630

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

2636

# "audit_log_configs": [

2637

# {

2638

# "log_type": "DATA_READ",

2639

# "exempted_members": [

2640

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

2645

# },

2646

# {

2647

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

2653

# "audit_log_configs": [

2654

# {

2655

# "log_type": "DATA_READ",

2656

# },

2657

# {

2658

# "log_type": "DATA_WRITE",

2659

# "exempted_members": [

2660

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

2669

# logging. It also exempts jose@example.com from DATA_READ logging, and

2670

# aliya@example.com from DATA_WRITE logging.

2671

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2672

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

2677

# {

2678

# "log_type": "DATA_READ",

2679

# "exempted_members": [

2680

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

2690

# jose@example.com from DATA_READ logging.

2691

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

2692

# permission.

2693

# Follows the same format of Binding.members.

2694

"A String",

2695

],

2696

"logType": "A String", # The log type that this config enables.

2697

},

2698

],

2699

"service": "A String", # Specifies a service that will be enabled for audit logging.

2700

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

2701

# `allServices` is a special value that covers all services.

2702

},

2703

],

2704

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2705

# `condition` that determines how and when the `bindings` are applied. Each

2706

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2707

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2708

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

2709

#

2710

# If the condition evaluates to `true`, then this binding applies to the

2711

# current request.

2712

#

2713

# If the condition evaluates to `false`, then this binding does not apply to

2714

# the current request. However, a different role binding might grant the same

2715

# role to one or more of the members in this binding.

2716

#

2717

# To learn which resources support conditions in their IAM policies, see the

2718

# [IAM

2719

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2720

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

2721

# are documented at https://github.com/google/cel-spec.

2722

#

2723

# Example (Comparison):

2724

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2725

# title: "Summary size limit"

2726

# description: "Determines if a summary is less than 100 chars"

2727

# expression: "document.summary.size() < 100"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2728

#

2729

# Example (Equality):

2730

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2731

# title: "Requestor is owner"

2732

# description: "Determines if requestor is the document owner"

2733

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2734

#

2735

# Example (Logic):

2736

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2737

# title: "Public documents"

2738

# description: "Determine whether the document should be publicly visible"

2739

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2740

#

2741

# Example (Data Manipulation):

2742

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2743

# title: "Notification string"

2744

# description: "Create a notification string with a timestamp."

2745

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2746

#

2747

# The exact variables and functions that may be referenced within an expression

2748

# are determined by the service that evaluates it. See the service

2749

# documentation for additional information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2750

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2751

# its purpose. This can be used e.g. in UIs which allow to enter the

2752

# expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2753

"location": "A String", # Optional. String indicating the location of the expression for error

2754

# reporting, e.g. a file name and a position in the file.

2755

"description": "A String", # Optional. Description of the expression. This is a longer text which

2756

# describes the expression, e.g. when hovered over it in a UI.

2757

"expression": "A String", # Textual representation of an expression in Common Expression Language

2758

# syntax.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2759

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2760

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2761

# `members` can have the following values:

2762

#

2763

# * `allUsers`: A special identifier that represents anyone who is

2764

# on the internet; with or without a Google account.

2765

#

2766

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2767

# who is authenticated with a Google account or a service account.

2768

#

2769

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2770

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2771

#

2772

#

2773

# * `serviceAccount:{emailid}`: An email address that represents a service

2774

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2775

#

2776

# * `group:{emailid}`: An email address that represents a Google group.

2777

# For example, `admins@example.com`.

2778

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2779

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

2780

# identifier) representing a user that has been recently deleted. For

2781

# example, `alice@example.com?uid=123456789012345678901`. If the user is

2782

# recovered, this value reverts to `user:{emailid}` and the recovered user

2783

# retains the role in the binding.

2784

#

2785

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

2786

# unique identifier) representing a service account that has been recently

2787

# deleted. For example,

2788

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

2789

# If the service account is undeleted, this value reverts to

2790

# `serviceAccount:{emailid}` and the undeleted service account retains the

2791

# role in the binding.

2792

#

2793

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

2794

# identifier) representing a Google group that has been recently

2795

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

2796

# the group is recovered, this value reverts to `group:{emailid}` and the

2797

# recovered group retains the role in the binding.

2798

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2799

#

2800

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

2801

# users of that domain. For example, `google.com` or `example.com`.

2802

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2803

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2804

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2805

"role": "A String", # Role that is assigned to `members`.

2806

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2807

},

2808

],

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^]

2813

<code class="details" id="list">list(consumerId=None, pageToken=None, pageSize=None, producerProjectId=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2814

<pre>Lists managed services.

2815

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2816

Returns all public services. For authenticated users, also returns all

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2817

services the calling user has "servicemanagement.services.get" permission

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2818

for.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2819

2820

**BETA:** If the caller specifies the `consumer_id`, it returns only the

2821

services enabled on the consumer. The `consumer_id` must have the format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2822

of "project:{PROJECT-ID}".

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2823

2824

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2825

consumerId: string, Include services consumed by the specified consumer.

2826

2827

The Google Service Management implementation accepts the following

2828

forms:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2829

- project:<project_id>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2830

pageToken: string, Token identifying which result to start with; returned by a previous list

2831

call.

2832

pageSize: integer, The max number of items to include in the response list. Page size is 50

2833

if not specified. Maximum value is 100.

2834

producerProjectId: string, Include services produced by the specified project.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2835

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2842

2843

{ # Response message for `ListServices` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2844

"services": [ # The returned services will only have the name field set.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2845

{ # The full representation of a Service that is managed by

2846

# Google Service Management.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2847

"producerProjectId": "A String", # ID of the project that produces and owns this service.

2848

"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]

2849

# for naming requirements.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2850

},

2851

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2852

"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>

2858

<pre>Retrieves the next page of results.

2859

2860

Args:

2861

previous_request: The request for the previous page. (required)

2862

previous_response: The response from the request for the previous page. (required)

2863

2864

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2865

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]

2866

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]

2871

<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]

2872

<pre>Sets the access control policy on the specified resource. Replaces any

2873

existing policy.

2874

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2875

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2876

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2877

Args:

2878

resource: string, REQUIRED: The resource for which the policy is being specified.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2879

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2880

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2881

The object takes the form of:

2882

2883

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2884

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

2885

# the fields in the mask will be modified. If no mask is provided, the

2886

# following default mask is used:

2887

#

2888

# `paths: "bindings, etag"`

2889

"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]

2890

# the policy is limited to a few 10s of KB. An empty policy is a

2891

# valid policy but certain Cloud Platform services (such as Projects)

2892

# might reject them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2893

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2894

#

2895

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2896

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

2897

# `members` to a single `role`. Members can be user accounts, service accounts,

2898

# Google groups, and domains (such as G Suite). A `role` is a named list of

2899

# permissions; each `role` can be an IAM predefined role or a user-created

2900

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2901

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2902

# For some types of Google Cloud resources, a `binding` can also specify a

2903

# `condition`, which is a logical expression that allows access to a resource

2904

# only if the expression evaluates to `true`. A condition can add constraints

2905

# based on attributes of the request, the resource, or both. To learn which

2906

# resources support conditions in their IAM policies, see the

2907

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2908

#

2909

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2910

#

2911

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2912

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2913

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2914

# "role": "roles/resourcemanager.organizationAdmin",

2915

# "members": [

2916

# "user:mike@example.com",

2917

# "group:admins@example.com",

2918

# "domain:google.com",

2919

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2920

# ]

2921

# },

2922

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2923

# "role": "roles/resourcemanager.organizationViewer",

2924

# "members": [

2925

# "user:eve@example.com"

2926

# ],

2927

# "condition": {

2928

# "title": "expirable access",

2929

# "description": "Does not grant access after Sep 2020",

2930

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2931

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2932

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2933

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2934

# "etag": "BwWWja0YfJA=",

2935

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2936

# }

2937

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2938

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

2943

# - group:admins@example.com

2944

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2945

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

2946

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2947

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2948

# - user:eve@example.com

2949

# role: roles/resourcemanager.organizationViewer

2950

# condition:

2951

# title: expirable access

2952

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2953

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2954

# - etag: BwWWja0YfJA=

2955

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2956

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2957

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2958

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2959

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2960

# prevent simultaneous updates of a policy from overwriting each other.

2961

# It is strongly suggested that systems make use of the `etag` in the

2962

# read-modify-write cycle to perform policy updates in order to avoid race

2963

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2964

# systems are expected to put that etag in the request to `setIamPolicy` to

2965

# ensure that their change will be applied to the same version of the policy.

2966

#

2967

# **Important:** If you use IAM Conditions, you must include the `etag` field

2968

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2969

# you to overwrite a version `3` policy with a version `1` policy, and all of

2970

# the conditions in the version `3` policy are lost.

2971

"version": 42, # Specifies the format of the policy.

2972

#

2973

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

2974

# are rejected.

2975

#

2976

# Any operation that affects conditional role bindings must specify version

2977

# `3`. This requirement applies to the following operations:

2978

#

2979

# * Getting a policy that includes a conditional role binding

2980

# * Adding a conditional role binding to a policy

2981

# * Changing a conditional role binding in a policy

2982

# * Removing any role binding, with or without a condition, from a policy

2983

# that includes conditions

2984

#

2985

# **Important:** If you use IAM Conditions, you must include the `etag` field

2986

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2987

# you to overwrite a version `3` policy with a version `1` policy, and all of

2988

# the conditions in the version `3` policy are lost.

2989

#

2990

# If a policy does not include any conditions, operations on that policy may

2991

# specify any valid version or leave the field unset.

2992

#

2993

# To learn which resources support conditions in their IAM policies, see the

2994

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2995

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2996

{ # Specifies the audit configuration for a service.

2997

# The configuration determines which permission types are logged, and what

2998

# identities, if any, are exempted from logging.

2999

# An AuditConfig must have one or more AuditLogConfigs.

3000

#

3001

# If there are AuditConfigs for both `allServices` and a specific service,

3002

# the union of the two AuditConfigs is used for that service: the log_types

3003

# specified in each AuditConfig are enabled, and the exempted_members in each

3004

# AuditLogConfig are exempted.

3005

#

3006

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

3012

# "audit_log_configs": [

3013

# {

3014

# "log_type": "DATA_READ",

3015

# "exempted_members": [

3016

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

3021

# },

3022

# {

3023

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

3029

# "audit_log_configs": [

3030

# {

3031

# "log_type": "DATA_READ",

3032

# },

3033

# {

3034

# "log_type": "DATA_WRITE",

3035

# "exempted_members": [

3036

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

3045

# logging. It also exempts jose@example.com from DATA_READ logging, and

3046

# aliya@example.com from DATA_WRITE logging.

3047

"auditLogConfigs": [ # The configuration for logging of each type of permission.

3048

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

3053

# {

3054

# "log_type": "DATA_READ",

3055

# "exempted_members": [

3056

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

3066

# jose@example.com from DATA_READ logging.

3067

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

3068

# permission.

3069

# Follows the same format of Binding.members.

3070

"A String",

3071

],

3072

"logType": "A String", # The log type that this config enables.

3073

},

3074

],

3075

"service": "A String", # Specifies a service that will be enabled for audit logging.

3076

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

3077

# `allServices` is a special value that covers all services.

3078

},

3079

],

3080

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3081

# `condition` that determines how and when the `bindings` are applied. Each

3082

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3083

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3084

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

3085

#

3086

# If the condition evaluates to `true`, then this binding applies to the

3087

# current request.

3088

#

3089

# If the condition evaluates to `false`, then this binding does not apply to

3090

# the current request. However, a different role binding might grant the same

3091

# role to one or more of the members in this binding.

3092

#

3093

# To learn which resources support conditions in their IAM policies, see the

3094

# [IAM

3095

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3096

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

3097

# are documented at https://github.com/google/cel-spec.

3098

#

3099

# Example (Comparison):

3100

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3101

# title: "Summary size limit"

3102

# description: "Determines if a summary is less than 100 chars"

3103

# expression: "document.summary.size() < 100"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3104

#

3105

# Example (Equality):

3106

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3107

# title: "Requestor is owner"

3108

# description: "Determines if requestor is the document owner"

3109

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3110

#

3111

# Example (Logic):

3112

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3113

# title: "Public documents"

3114

# description: "Determine whether the document should be publicly visible"

3115

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3116

#

3117

# Example (Data Manipulation):

3118

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3119

# title: "Notification string"

3120

# description: "Create a notification string with a timestamp."

3121

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3122

#

3123

# The exact variables and functions that may be referenced within an expression

3124

# are determined by the service that evaluates it. See the service

3125

# documentation for additional information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3126

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3127

# its purpose. This can be used e.g. in UIs which allow to enter the

3128

# expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3129

"location": "A String", # Optional. String indicating the location of the expression for error

3130

# reporting, e.g. a file name and a position in the file.

3131

"description": "A String", # Optional. Description of the expression. This is a longer text which

3132

# describes the expression, e.g. when hovered over it in a UI.

3133

"expression": "A String", # Textual representation of an expression in Common Expression Language

3134

# syntax.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3135

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3136

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3137

# `members` can have the following values:

3138

#

3139

# * `allUsers`: A special identifier that represents anyone who is

3140

# on the internet; with or without a Google account.

3141

#

3142

# * `allAuthenticatedUsers`: A special identifier that represents anyone

3143

# who is authenticated with a Google account or a service account.

3144

#

3145

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3146

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3147

#

3148

#

3149

# * `serviceAccount:{emailid}`: An email address that represents a service

3150

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

3151

#

3152

# * `group:{emailid}`: An email address that represents a Google group.

3153

# For example, `admins@example.com`.

3154

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3155

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

3156

# identifier) representing a user that has been recently deleted. For

3157

# example, `alice@example.com?uid=123456789012345678901`. If the user is

3158

# recovered, this value reverts to `user:{emailid}` and the recovered user

3159

# retains the role in the binding.

3160

#

3161

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

3162

# unique identifier) representing a service account that has been recently

3163

# deleted. For example,

3164

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

3165

# If the service account is undeleted, this value reverts to

3166

# `serviceAccount:{emailid}` and the undeleted service account retains the

3167

# role in the binding.

3168

#

3169

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

3170

# identifier) representing a Google group that has been recently

3171

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

3172

# the group is recovered, this value reverts to `group:{emailid}` and the

3173

# recovered group retains the role in the binding.

3174

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3175

#

3176

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

3177

# users of that domain. For example, `google.com` or `example.com`.

3178

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3179

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3180

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3181

"role": "A String", # Role that is assigned to `members`.

3182

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3183

},

3184

],

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:

3195

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3196

{ # An Identity and Access Management (IAM) policy, which specifies access

3197

# controls for Google Cloud resources.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3198

#

3199

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3200

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

3201

# `members` to a single `role`. Members can be user accounts, service accounts,

3202

# Google groups, and domains (such as G Suite). A `role` is a named list of

3203

# permissions; each `role` can be an IAM predefined role or a user-created

3204

# custom role.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3205

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3206

# For some types of Google Cloud resources, a `binding` can also specify a

3207

# `condition`, which is a logical expression that allows access to a resource

3208

# only if the expression evaluates to `true`. A condition can add constraints

3209

# based on attributes of the request, the resource, or both. To learn which

3210

# resources support conditions in their IAM policies, see the

3211

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3212

#

3213

# **JSON example:**

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3214

#

3215

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3216

# "bindings": [

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3217

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3218

# "role": "roles/resourcemanager.organizationAdmin",

3219

# "members": [

3220

# "user:mike@example.com",

3221

# "group:admins@example.com",

3222

# "domain:google.com",

3223

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3224

# ]

3225

# },

3226

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3227

# "role": "roles/resourcemanager.organizationViewer",

3228

# "members": [

3229

# "user:eve@example.com"

3230

# ],

3231

# "condition": {

3232

# "title": "expirable access",

3233

# "description": "Does not grant access after Sep 2020",

3234

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3235

# }

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3236

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3237

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3238

# "etag": "BwWWja0YfJA=",

3239

# "version": 3

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3240

# }

3241

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3242

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

3247

# - group:admins@example.com

3248

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3249

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

3250

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3251

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3252

# - user:eve@example.com

3253

# role: roles/resourcemanager.organizationViewer

3254

# condition:

3255

# title: expirable access

3256

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3257

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3258

# - etag: BwWWja0YfJA=

3259

# - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3260

#

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3261

# For a description of IAM and its features, see the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3262

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3263

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

3264

# prevent simultaneous updates of a policy from overwriting each other.

3265

# It is strongly suggested that systems make use of the `etag` in the

3266

# read-modify-write cycle to perform policy updates in order to avoid race

3267

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

3268

# systems are expected to put that etag in the request to `setIamPolicy` to

3269

# ensure that their change will be applied to the same version of the policy.

3270

#

3271

# **Important:** If you use IAM Conditions, you must include the `etag` field

3272

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

3273

# you to overwrite a version `3` policy with a version `1` policy, and all of

3274

# the conditions in the version `3` policy are lost.

3275

"version": 42, # Specifies the format of the policy.

3276

#

3277

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

3278

# are rejected.

3279

#

3280

# Any operation that affects conditional role bindings must specify version

3281

# `3`. This requirement applies to the following operations:

3282

#

3283

# * Getting a policy that includes a conditional role binding

3284

# * Adding a conditional role binding to a policy

3285

# * Changing a conditional role binding in a policy

3286

# * Removing any role binding, with or without a condition, from a policy

3287

# that includes conditions

3288

#

3289

# **Important:** If you use IAM Conditions, you must include the `etag` field

3290

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

3291

# you to overwrite a version `3` policy with a version `1` policy, and all of

3292

# the conditions in the version `3` policy are lost.

3293

#

3294

# If a policy does not include any conditions, operations on that policy may

3295

# specify any valid version or leave the field unset.

3296

#

3297

# To learn which resources support conditions in their IAM policies, see the

3298

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3299

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

3300

{ # Specifies the audit configuration for a service.

3301

# The configuration determines which permission types are logged, and what

3302

# identities, if any, are exempted from logging.

3303

# An AuditConfig must have one or more AuditLogConfigs.

3304

#

3305

# If there are AuditConfigs for both `allServices` and a specific service,

3306

# the union of the two AuditConfigs is used for that service: the log_types

3307

# specified in each AuditConfig are enabled, and the exempted_members in each

3308

# AuditLogConfig are exempted.

3309

#

3310

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

3316

# "audit_log_configs": [

3317

# {

3318

# "log_type": "DATA_READ",

3319

# "exempted_members": [

3320

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

3325

# },

3326

# {

3327

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

3333

# "audit_log_configs": [

3334

# {

3335

# "log_type": "DATA_READ",

3336

# },

3337

# {

3338

# "log_type": "DATA_WRITE",

3339

# "exempted_members": [

3340

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

3349

# logging. It also exempts jose@example.com from DATA_READ logging, and

3350

# aliya@example.com from DATA_WRITE logging.

3351

"auditLogConfigs": [ # The configuration for logging of each type of permission.

3352

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

3357

# {

3358

# "log_type": "DATA_READ",

3359

# "exempted_members": [

3360

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

3370

# jose@example.com from DATA_READ logging.

3371

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

3372

# permission.

3373

# Follows the same format of Binding.members.

3374

"A String",

3375

],

3376

"logType": "A String", # The log type that this config enables.

3377

},

3378

],

3379

"service": "A String", # Specifies a service that will be enabled for audit logging.

3380

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

3381

# `allServices` is a special value that covers all services.

3382

},

3383

],

3384

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3385

# `condition` that determines how and when the `bindings` are applied. Each

3386

# of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3387

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3388

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

3389

#

3390

# If the condition evaluates to `true`, then this binding applies to the

3391

# current request.

3392

#

3393

# If the condition evaluates to `false`, then this binding does not apply to

3394

# the current request. However, a different role binding might grant the same

3395

# role to one or more of the members in this binding.

3396

#

3397

# To learn which resources support conditions in their IAM policies, see the

3398

# [IAM

3399

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3400

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

3401

# are documented at https://github.com/google/cel-spec.

3402

#

3403

# Example (Comparison):

3404

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3405

# title: "Summary size limit"

3406

# description: "Determines if a summary is less than 100 chars"

3407

# expression: "document.summary.size() < 100"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3408

#

3409

# Example (Equality):

3410

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3411

# title: "Requestor is owner"

3412

# description: "Determines if requestor is the document owner"

3413

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3414

#

3415

# Example (Logic):

3416

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3417

# title: "Public documents"

3418

# description: "Determine whether the document should be publicly visible"

3419

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3420

#

3421

# Example (Data Manipulation):

3422

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3423

# title: "Notification string"

3424

# description: "Create a notification string with a timestamp."

3425

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3426

#

3427

# The exact variables and functions that may be referenced within an expression

3428

# are determined by the service that evaluates it. See the service

3429

# documentation for additional information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3430

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3431

# its purpose. This can be used e.g. in UIs which allow to enter the

3432

# expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3433

"location": "A String", # Optional. String indicating the location of the expression for error

3434

# reporting, e.g. a file name and a position in the file.

3435

"description": "A String", # Optional. Description of the expression. This is a longer text which

3436

# describes the expression, e.g. when hovered over it in a UI.

3437

"expression": "A String", # Textual representation of an expression in Common Expression Language

3438

# syntax.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3439

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3440

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3441

# `members` can have the following values:

3442

#

3443

# * `allUsers`: A special identifier that represents anyone who is

3444

# on the internet; with or without a Google account.

3445

#

3446

# * `allAuthenticatedUsers`: A special identifier that represents anyone

3447

# who is authenticated with a Google account or a service account.

3448

#

3449

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3450

# account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3451

#

3452

#

3453

# * `serviceAccount:{emailid}`: An email address that represents a service

3454

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

3455

#

3456

# * `group:{emailid}`: An email address that represents a Google group.

3457

# For example, `admins@example.com`.

3458

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3459

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

3460

# identifier) representing a user that has been recently deleted. For

3461

# example, `alice@example.com?uid=123456789012345678901`. If the user is

3462

# recovered, this value reverts to `user:{emailid}` and the recovered user

3463

# retains the role in the binding.

3464

#

3465

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

3466

# unique identifier) representing a service account that has been recently

3467

# deleted. For example,

3468

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

3469

# If the service account is undeleted, this value reverts to

3470

# `serviceAccount:{emailid}` and the undeleted service account retains the

3471

# role in the binding.

3472

#

3473

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

3474

# identifier) representing a Google group that has been recently

3475

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

3476

# the group is recovered, this value reverts to `group:{emailid}` and the

3477

# recovered group retains the role in the binding.

3478

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3479

#

3480

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

3481

# users of that domain. For example, `google.com` or `example.com`.

3482

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3483

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3484

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3485

"role": "A String", # Role that is assigned to `members`.

3486

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3487

},

3488

],

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]

3493

<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]

3494

<pre>Returns permissions that a caller has on the specified resource.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3495

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^]

3496

permissions, not a `NOT_FOUND` error.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3497

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3498

Note: This operation is designed to be used for building permission-aware

3499

UIs and command-line tools, not for authorization checking. This operation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3500

may "fail open" without warning.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3501

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3502

Args:

3503

resource: string, REQUIRED: The resource for which the policy detail is being requested.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3504

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3505

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3506

The object takes the form of:

3507

3508

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3509

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

3510

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3511

# information see

3512

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3513

"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:

3524

3525

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3526

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3527

# allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3528

"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]

3534

<code class="details" id="undelete">undelete(serviceName, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3535

<pre>Revives a previously deleted managed service. The method restores the

3536

service using the configuration at the time the service was deleted.

3537

The target service must exist and must have been deleted within the

3538

last 30 days.

3539

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3540

Operation<response: UndeleteServiceResponse>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3541

3542

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3543

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]

3544

for naming requirements. For example: `example.googleapis.com`. (required)

3545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3552

3553

{ # This resource represents a long-running operation that is the result of a

3554

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3555

"metadata": { # Service-specific metadata associated with the operation. It typically

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3556

# contains progress information and common metadata such as create time.

3557

# Some services might not provide such metadata. Any method that returns a

3558

# long-running operation should document the metadata type, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3559

"a_key": "", # Properties of the object. Contains field @type with type URL.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3561

"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]

3562

# If `true`, the operation is completed, and either `error` or `response` is

3563

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3564

"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]

3565

# method returns no data on success, such as `Delete`, the response is

3566

# `google.protobuf.Empty`. If the original method is standard

3567

# `Get`/`Create`/`Update`, the response should be the resource. For other

3568

# methods, the response should have the type `XxxResponse`, where `Xxx`

3569

# is the original method name. For example, if the original method name

3570

# is `TakeSnapshot()`, the inferred response type is

3571

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3572

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3574

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3575

# originally returns it. If you use the default HTTP mapping, the

3576

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim