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

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

[diff] [blame]

187

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

193

<pre>Disable a service so that it can no longer be used with a project.

194

This prevents unintended usage that may cause unexpected billing

195

charges or security leaks.

196

197

It is not valid to call the disable method on a service that is not

198

currently enabled. Callers will receive a `FAILED_PRECONDITION` status if

199

the target service is not currently enabled.

200

Dan O'Meara

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

[diff] [blame]

201

Operation<response: google.protobuf.Empty>

Bu Sun Kim

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

[diff] [blame]

Args:

The enable and disable methods currently only support projects.

207

208

An example name would be:

209

`projects/123/services/serviceusage.googleapis.com`

210

where `123` is the project number (not project ID). (required)

211

body: object, The request body.

212

The object takes the form of:

213

214

{ # Request message for the `DisableService` method.

215

}

216

217

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

224

225

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

226

# network API call.

Bu Sun Kim

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

[diff] [blame]

227

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

228

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

229

# available.

Bu Sun Kim

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

[diff] [blame]

230

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

231

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

232

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

Bu Sun Kim

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

[diff] [blame]

233

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

234

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

235

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

236

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

237

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

238

},

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

247

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

Dan O'Meara

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

[diff] [blame]

248

},

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

252

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

253

#

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

# message types for APIs to use.

262

{

263

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

264

},

265

],

Dan O'Meara

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

[diff] [blame]

266

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

272

<pre>Enable a service so that it can be used with a project.

273

Dan O'Meara

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

[diff] [blame]

274

Operation<response: google.protobuf.Empty>

Bu Sun Kim

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

[diff] [blame]

Args:

The `EnableService` and `DisableService` methods currently only support

280

projects.

281

282

Enabling a service requires that the service is public or is shared with

283

the user enabling the service.

284

285

An example name would be:

286

`projects/123/services/serviceusage.googleapis.com`

287

where `123` is the project number (not project ID). (required)

288

body: object, The request body.

289

The object takes the form of:

290

291

{ # Request message for the `EnableService` method.

292

}

293

294

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

301

302

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

303

# network API call.

Bu Sun Kim

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

[diff] [blame]

304

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

305

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

306

# available.

Bu Sun Kim

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

[diff] [blame]

307

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

308

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

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

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

315

},

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

324

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

Dan O'Meara

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

[diff] [blame]

325

},

Bu Sun Kim

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

[diff] [blame]

326

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

327

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

328

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

329

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

330

#

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

# message types for APIs to use.

339

{

340

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

341

},

342

],

Dan O'Meara

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

[diff] [blame]

343

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

349

<pre>Returns the service configuration and enabled state for a given service.

Args:

An example name would be:

355

`projects/123/services/serviceusage.googleapis.com`

356

where `123` is the project number (not project ID). (required)

357

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

364

365

{ # A service that is available for use by the consumer.

Bu Sun Kim

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

[diff] [blame]

366

"config": { # The configuration of the service. # The service configuration of the available service.

Bu Sun Kim

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

[diff] [blame]

367

# Some fields may be filtered out of the configuration in responses to

368

# the `ListServices` method. These fields are present only in responses to

369

# the `GetService` method.

Bu Sun Kim

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

[diff] [blame]

370

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

# documentation URL.

#

# Example:

# <pre><code>documentation:

375

# summary: >

376

# The Google Calendar API gives access

377

# to most calendar features.

378

# pages:

379

# - name: Overview

380

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

381

# - name: Tutorial

382

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

383

# subpages;

384

# - name: Java

385

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

386

# rules:

387

# - selector: google.calendar.Calendar.Get

388

# description: >

389

# ...

390

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

395

# standard markdown features, definition lists, tables and fenced

396

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

397

# interpreted relative to the section nesting of the context where

398

# a documentation fragment is embedded.

399

#

400

# Documentation from the IDL is merged with documentation defined

401

# via the config at normalization time, where documentation provided

402

# by config rules overrides IDL provided.

403

#

404

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

405

# in documentation text.

406

#

407

# In order to reference a proto element, the following

408

# notation can be used:

409

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

410

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

411

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

412

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

413

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

414

#

415

# A few directives are available in documentation. Note that

416

# directives must appear on a single line to be properly

417

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

418

# an external source:

419

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

420

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

421

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

422

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

423

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

424

# The directive `suppress_warning` does not directly affect documentation

425

# and is documented together with service config validation.

426

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

427

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

428

#

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

# an element is marked as `deprecated`.

440

},

441

],

442

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

443

# <pre><code>documentation:

444

# summary: ...

445

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

446

# </code></pre>

447

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

448

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

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

453

# </code></pre>

454

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

455

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

456

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

457

# nested documentation set structure.

458

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

459

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

460

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

461

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

462

# documentation. For example:

463

# <pre><code>pages:

464

# - name: Tutorial

465

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

466

# subpages:

467

# - name: Java

468

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

469

# </code></pre>

470

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

471

# `Java`.

472

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

473

# honored in the generated docset.

474

# Object with schema name: Page

475

],

476

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

477

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

478

},

479

],

480

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

481

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

482

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

483

# urls are relative to.

484

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

485

# plain text.

486

},

487

"authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration. Contains only the OAuth rules.

488

#

489

# Example for an API targeted for external use:

490

#

491

# name: calendar.googleapis.com

492

# authentication:

493

# providers:

494

# - id: google_calendar_auth

495

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

496

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

# rules:

# - selector: "*"

# requirements:

# provider_id: google_calendar_auth

501

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

502

{ # Configuration for an authentication provider, including support for

503

# [JSON Web Token

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

# will be accepted.

512

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

513

# accept JWTs with the following audiences:

514

# -

515

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

516

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

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

521

# bookstore_web.apps.googleusercontent.com

522

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

523

# Implement authorizationUrl of securityDefinitions in OpenAPI spec.

524

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

525

#

526

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

527

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

528

# all headers first, then URL query parameters.

529

#

530

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

531

# 1) Authorization: Bearer

532

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

533

# 3) access_token query parameter

534

#

535

# Default locations can be specified as followings:

536

# jwt_locations:

537

# - header: Authorization

538

# value_prefix: "Bearer "

539

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

540

# - query: access_token

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

# extracted after the prefix is removed.

549

#

550

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

551

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

552

},

553

],

554

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

555

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

556

# Usually a URL or an email address.

557

#

558

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

559

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

560

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

561

# [OpenID

562

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

563

# Optional if the key set document:

564

# - can be retrieved from

565

# [OpenID

566

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

567

# the issuer.

568

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

569

# service account).

570

#

571

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

572

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

573

# `AuthRequirement.provider_id`.

574

#

575

# Example: "bookstore_auth".

576

},

577

],

578

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

579

#

580

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

581

{ # Authentication rules for the service.

582

#

583

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

584

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

585

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

586

# request.

587

#

588

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

589

# ignored.

590

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

591

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

592

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

593

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

594

#

595

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

596

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

597

#

598

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

599

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

600

# the OAuth scope across all of those APIs.

601

#

602

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

603

# management about how developers will use them in practice.

604

#

605

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

606

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

607

# due to the backend requiring additional scopes or permissions.

608

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

609

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

#

# Example:

#

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

614

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

615

},

616

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

617

#

618

# Refer to selector for syntax details.

619

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

620

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

621

{ # User-defined authentication requirements, including support for

622

# [JSON Web Token

623

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

624

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

#

# Example:

#

# provider_id: bookstore_auth

629

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

630

# implemented and accepted in all the runtime components.

631

#

632

# The list of JWT

633

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

634

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

635

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

636

# "https://Service_name/API_name"

637

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

638

# LibraryService API will only accept JWTs with the following audience

639

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

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

644

# bookstore_web.apps.googleusercontent.com

},

],

},

],

},

Bu Sun Kim

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

[diff] [blame]

650

"endpoints": [ # Configuration for network endpoints. Contains only the names and aliases

651

# of the endpoints.

652

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

653

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

654

# same service configuration, such as quota configuration and monitoring

655

# configuration.

656

#

657

# Example service configuration:

658

#

659

# name: library-example.googleapis.com

660

# endpoints:

661

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

662

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

663

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

664

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

665

# # allowed to proceed.

666

# - name: library-example.googleapis.com

667

# allow_cors: true

Bu Sun Kim

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

[diff] [blame]

668

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

669

"A String",

670

],

671

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

672

# handle requests to this [API

673

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

674

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

675

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

Bu Sun Kim

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

[diff] [blame]

676

"allowCors": True or False, # Allowing

677

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

678

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

679

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

680

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

681

# allowed to proceed.

Bu Sun Kim

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

[diff] [blame]

682

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

683

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

684

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

685

# aliases.

686

#

687

# Additional names that this endpoint will be hosted on.

"A String",

],

},

],

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

693

# usage.

694

#

695

# The metric based quota configuration works this way:

696

# - The service configuration defines a set of metrics.

697

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

698

# corresponding costs.

699

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

700

# quota checks at runtime.

701

#

702

# An example quota configuration in yaml format:

#

# quota:

# limits:

#

# - name: apiWriteQpsPerProject

708

# metric: library.googleapis.com/write_calls

709

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

# values:

# STANDARD: 10000

#

#

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

715

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

716

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

717

# # consuming at twice rate as the DeleteBook method.

# metric_rules:

# - selector: "*"

# metric_costs:

# library.googleapis.com/read_calls: 1

722

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

723

# metric_costs:

724

# library.googleapis.com/write_calls: 2

725

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

726

# metric_costs:

727

# library.googleapis.com/write_calls: 1

728

#

729

# Corresponding Metric definition:

730

#

731

# metrics:

732

# - name: library.googleapis.com/read_calls

733

# display_name: Read requests

# metric_kind: DELTA

# value_type: INT64

#

# - name: library.googleapis.com/write_calls

738

# display_name: Write requests

739

# metric_kind: DELTA

740

# value_type: INT64

741

#

Bu Sun Kim

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

[diff] [blame]

742

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

743

# or more metrics.

744

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

745

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

746

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

747

# cost applied to each metric.

748

#

749

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

750

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

751

# The value must not be negative.

752

"a_key": "A String",

753

},

754

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

755

#

756

# Refer to selector for syntax details.

757

},

758

],

Bu Sun Kim

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

[diff] [blame]

759

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

760

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

761

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

762

# type combination defined within a `QuotaGroup`.

763

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

Bu Sun Kim

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

[diff] [blame]

764

#

Bu Sun Kim

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

[diff] [blame]

765

# Used by group-based quotas only.

766

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

Bu Sun Kim

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

[diff] [blame]

767

#

Bu Sun Kim

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

[diff] [blame]

768

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

769

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

Bu Sun Kim

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

[diff] [blame]

770

#

Bu Sun Kim

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

[diff] [blame]

771

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

772

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

773

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

774

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

775

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

Bu Sun Kim

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

[diff] [blame]

776

#

Bu Sun Kim

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

[diff] [blame]

777

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

778

# indicating unlimited maximum quota.

Bu Sun Kim

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

[diff] [blame]

779

#

Bu Sun Kim

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

[diff] [blame]

780

# Used by group-based quotas only.

781

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

782

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

783

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

784

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

785

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

786

# specified unit. Currently only STANDARD is supported.

787

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

788

},

Bu Sun Kim

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

[diff] [blame]

789

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

790

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

791

# backend system.

Bu Sun Kim

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

[diff] [blame]

792

#

Bu Sun Kim

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

[diff] [blame]

793

# Here are some examples:

794

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

795

#

796

# Note: the order of unit components is insignificant.

797

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

798

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

799

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

800

# defined within the service config.

801

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

802

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

803

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

804

# display name generated from the configuration.

805

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

806

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

807

# billed amount when billing is enabled.

808

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

809

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

810

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

811

#

812

# Used by group-based quotas only.

813

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

814

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

815

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

816

#

817

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

818

# are provisioning quota to selected consumers and blocking others.

819

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

820

# negative values are allowed.

821

#

822

# Used by group-based quotas only.

Bu Sun Kim

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

[diff] [blame]

823

},

824

],

825

},

Bu Sun Kim

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

[diff] [blame]

826

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

Bu Sun Kim

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

[diff] [blame]

827

"name": "A String", # The DNS address at which this service is available.

828

#

829

# An example DNS address would be:

830

# `calendar.googleapis.com`.

Bu Sun Kim

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

[diff] [blame]

831

"apis": [ # A list of API interfaces exported by this service. Contains only the names,

Bu Sun Kim

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

[diff] [blame]

832

# versions, and method names of the interfaces.

833

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

834

#

Bu Sun Kim

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

[diff] [blame]

835

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

836

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

Bu Sun Kim

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

[diff] [blame]

837

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

838

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

Bu Sun Kim

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

[diff] [blame]

839

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

Bu Sun Kim

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

[diff] [blame]

840

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

841

# detailed terminology.

Bu Sun Kim

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

[diff] [blame]

842

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

Bu Sun Kim

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

[diff] [blame]

843

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

844

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

845

# enumeration, etc.

846

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

847

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

848

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

849

# `"google.api.http"`.

850

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

851

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

852

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

853

# value using the google.protobuf.Int32Value type.

854

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

855

},

856

},

857

],

Bu Sun Kim

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

[diff] [blame]

858

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

859

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

860

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

861

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

862

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

863

# consistent with what is provided here.

864

#

865

# The versioning schema uses [semantic

866

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

867

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

868

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

869

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

870

# chosen based on the product plan.

871

#

872

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

873

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

874

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

875

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

876

# experimental, non-GA interfaces.

Bu Sun Kim

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

[diff] [blame]

877

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

Bu Sun Kim

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

[diff] [blame]

878

# message.

879

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

Bu Sun Kim

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

[diff] [blame]

880

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

881

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

Bu Sun Kim

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

[diff] [blame]

882

},

Bu Sun Kim

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

[diff] [blame]

883

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

Bu Sun Kim

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

[diff] [blame]

884

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

885

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

886

# documentation and options are inherited as follows:

887

#

888

# - If after comment and whitespace stripping, the documentation

889

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

890

# from the original method.

891

#

892

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

893

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

894

# inherited.

895

#

896

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

897

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

898

# version of the including interface plus the root path if

899

# specified.

900

#

901

# Example of a simple mixin:

902

#

903

# package google.acl.v1;

904

# service AccessControl {

905

# // Get the underlying ACL object.

906

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

907

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

Bu Sun Kim

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

[diff] [blame]

# }

# }

#

# package google.storage.v2;

912

# service Storage {

913

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

914

#

915

# // Get a data record.

916

# rpc GetData(GetDataRequest) returns (Data) {

Bu Sun Kim

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

[diff] [blame]

917

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

Bu Sun Kim

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

[diff] [blame]

# }

# }

#

# Example of a mixin configuration:

922

#

923

# apis:

924

# - name: google.storage.v2.Storage

925

# mixins:

926

# - name: google.acl.v1.AccessControl

927

#

928

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

929

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

930

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

931

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

932

# documentation and annotations as follows:

933

#

934

# service Storage {

935

# // Get the underlying ACL object.

936

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

937

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

Bu Sun Kim

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

[diff] [blame]

# }

# ...

# }

#

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

943

#

944

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

945

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

946

#

947

# apis:

948

# - name: google.storage.v2.Storage

949

# mixins:

950

# - name: google.acl.v1.AccessControl

951

# root: acls

952

#

953

# This implies the following inherited HTTP annotation:

954

#

955

# service Storage {

956

# // Get the underlying ACL object.

957

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

958

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

Bu Sun Kim

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

[diff] [blame]

959

# }

960

# ...

961

# }

Bu Sun Kim

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

[diff] [blame]

962

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

963

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

Bu Sun Kim

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

[diff] [blame]

964

# are rooted.

Bu Sun Kim

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

[diff] [blame]

965

},

966

],

Bu Sun Kim

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

[diff] [blame]

967

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

968

# followed by the interface's simple name.

Bu Sun Kim

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

[diff] [blame]

969

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

Bu Sun Kim

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

[diff] [blame]

970

{ # Method represents a method of an API interface.

Bu Sun Kim

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

[diff] [blame]

971

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

Bu Sun Kim

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

[diff] [blame]

972

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

973

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

974

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

Bu Sun Kim

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

[diff] [blame]

975

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

Bu Sun Kim

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

[diff] [blame]

976

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

977

# enumeration, etc.

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

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

981

# `"google.api.http"`.

Bu Sun Kim

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

[diff] [blame]

982

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

Bu Sun Kim

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

[diff] [blame]

983

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

984

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

985

# value using the google.protobuf.Int32Value type.

Bu Sun Kim

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

[diff] [blame]

986

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

Bu Sun Kim

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

[diff] [blame]

987

},

988

},

989

],

Bu Sun Kim

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

[diff] [blame]

990

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

991

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

Bu Sun Kim

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

[diff] [blame]

992

},

Bu Sun Kim

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

[diff] [blame]

993

],

994

},

995

],

Bu Sun Kim

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

[diff] [blame]

996

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

997

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

998

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

999

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

1000

"A String",

1001

],

1002

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

1003

#

1004

#

1005

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

1006

# Example of a service identity configuration.

#

# usage:

# service_identity:

# - service_account_parent: "projects/123456789"

1011

# display_name: "Cloud XXX Service Agent"

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

#

1019

# An example name would be:

1020

# `projects/123456789`

1021

},

1022

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

1023

# service producer.

1024

#

1025

# Google Service Management currently only supports

1026

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

1027

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

1028

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

1029

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

1030

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

1031

#

1032

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

1033

{ # Usage configuration rules for the service.

1034

#

1035

# NOTE: Under development.

1036

#

1037

#

1038

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

1039

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

1040

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

1041

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

1042

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

1043

# allow/disallow unregistered calls.

1044

#

1045

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

#

# usage:

# rules:

# - selector: "*"

# allow_unregistered_calls: true

1051

#

1052

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

#

# usage:

# rules:

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

1057

# allow_unregistered_calls: true

1058

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

1059

# methods in all APIs.

1060

#

1061

# Refer to selector for syntax details.

1062

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

1063

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

1064

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

1065

# methods, such as service health check methods.

1066

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

1067

# that don't identify any user or application.

1068

},

1069

],

1070

},

Bu Sun Kim

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

[diff] [blame]

1071

},

Bu Sun Kim

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

[diff] [blame]

1072

"name": "A String", # The resource name of the consumer and service.

1073

#

1074

# A valid name would be:

1075

# - projects/123/services/serviceusage.googleapis.com

Bu Sun Kim

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

[diff] [blame]

1076

"state": "A String", # Whether or not the service has been enabled for use by the consumer.

Bu Sun Kim

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

[diff] [blame]

1077

"parent": "A String", # The resource name of the consumer.

1078

#

1079

# A valid name would be:

1080

# - projects/123

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1085

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

Bu Sun Kim

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

[diff] [blame]

1086

<pre>List all services available to the specified project, and the current

1087

state of those services with respect to the project. The list includes

1088

all public services, all services for which the calling user has the

1089

`servicemanagement.services.bind` permission, and all services that have

1090

already been enabled on the project. The list can be filtered to

1091

only include services in a specific state, for example to only include

1092

services enabled on the project.

1093

1094

Args:

1095

parent: string, Parent to search for services on.

1096

1097

An example name would be:

1098

`projects/123`

1099

where `123` is the project number (not project ID). (required)

Bu Sun Kim

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

[diff] [blame]

1100

filter: string, Only list services that conform to the given filter.

1101

The allowed filter strings are `state:ENABLED` and `state:DISABLED`.

Bu Sun Kim

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

[diff] [blame]

1102

pageSize: integer, Requested size of the next page of data.

1103

Requested page size cannot exceed 200.

1104

If not set, the default page size is 50.

Bu Sun Kim

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

[diff] [blame]

1105

pageToken: string, Token identifying which result to start with, which is returned by a

1106

previous list call.

Bu Sun Kim

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

[diff] [blame]

1107

x__xgafv: string, V1 error format.

1108

Allowed values

1109

1 - v1 error format

1110

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

1111

1112

Returns:

1113

An object of the form:

1114

1115

{ # Response message for the `ListServices` method.

Bu Sun Kim

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

[diff] [blame]

1116

"services": [ # The available services for the requested project.

Bu Sun Kim

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

[diff] [blame]

1117

{ # A service that is available for use by the consumer.

Bu Sun Kim

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

[diff] [blame]

1118

"config": { # The configuration of the service. # The service configuration of the available service.

Bu Sun Kim

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

[diff] [blame]

1119

# Some fields may be filtered out of the configuration in responses to

1120

# the `ListServices` method. These fields are present only in responses to

1121

# the `GetService` method.

Bu Sun Kim

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

[diff] [blame]

1122

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

# documentation URL.

#

# Example:

# <pre><code>documentation:

1127

# summary: >

1128

# The Google Calendar API gives access

1129

# to most calendar features.

1130

# pages:

1131

# - name: Overview

1132

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

1133

# - name: Tutorial

1134

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

1135

# subpages;

1136

# - name: Java

1137

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

1138

# rules:

1139

# - selector: google.calendar.Calendar.Get

1140

# description: >

1141

# ...

1142

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1147

# standard markdown features, definition lists, tables and fenced

1148

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

1149

# interpreted relative to the section nesting of the context where

1150

# a documentation fragment is embedded.

1151

#

1152

# Documentation from the IDL is merged with documentation defined

1153

# via the config at normalization time, where documentation provided

1154

# by config rules overrides IDL provided.

1155

#

1156

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

1157

# in documentation text.

1158

#

1159

# In order to reference a proto element, the following

1160

# notation can be used:

1161

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

1162

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

1163

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

1164

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

1165

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

1166

#

1167

# A few directives are available in documentation. Note that

1168

# directives must appear on a single line to be properly

1169

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

1170

# an external source:

1171

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

1172

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

1173

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

1174

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

1175

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

1176

# The directive `suppress_warning` does not directly affect documentation

1177

# and is documented together with service config validation.

1178

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

1179

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

1180

#

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

1191

# an element is marked as `deprecated`.

1192

},

1193

],

1194

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

1195

# <pre><code>documentation:

1196

# summary: ...

1197

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

1198

# </code></pre>

1199

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

1200

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

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

1205

# </code></pre>

1206

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

1207

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

1208

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

1209

# nested documentation set structure.

1210

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

1211

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

1212

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

1213

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

1214

# documentation. For example:

1215

# <pre><code>pages:

1216

# - name: Tutorial

1217

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

1218

# subpages:

1219

# - name: Java

1220

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

1221

# </code></pre>

1222

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

1223

# `Java`.

1224

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

1225

# honored in the generated docset.

1226

# Object with schema name: Page

1227

],

1228

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

1229

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

1230

},

1231

],

1232

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

1233

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

1234

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

1235

# urls are relative to.

1236

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

1237

# plain text.

1238

},

1239

"authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration. Contains only the OAuth rules.

1240

#

1241

# Example for an API targeted for external use:

1242

#

1243

# name: calendar.googleapis.com

1244

# authentication:

1245

# providers:

1246

# - id: google_calendar_auth

1247

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

1248

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

# rules:

# - selector: "*"

# requirements:

# provider_id: google_calendar_auth

1253

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

1254

{ # Configuration for an authentication provider, including support for

1255

# [JSON Web Token

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

# will be accepted.

1264

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

1265

# accept JWTs with the following audiences:

1266

# -

1267

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

1268

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

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

1273

# bookstore_web.apps.googleusercontent.com

1274

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

1275

# Implement authorizationUrl of securityDefinitions in OpenAPI spec.

1276

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

1277

#

1278

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

1279

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

1280

# all headers first, then URL query parameters.

1281

#

1282

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

1283

# 1) Authorization: Bearer

1284

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

1285

# 3) access_token query parameter

1286

#

1287

# Default locations can be specified as followings:

1288

# jwt_locations:

1289

# - header: Authorization

1290

# value_prefix: "Bearer "

1291

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

1292

# - query: access_token

1293

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

1294

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

1295

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

1296

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

1297

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

1298

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

1299

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

1300

# extracted after the prefix is removed.

1301

#

1302

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

1303

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

1304

},

1305

],

1306

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

1307

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

1308

# Usually a URL or an email address.

1309

#

1310

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

1311

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

1312

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

1313

# [OpenID

1314

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

1315

# Optional if the key set document:

1316

# - can be retrieved from

1317

# [OpenID

1318

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

1319

# the issuer.

1320

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

1321

# service account).

1322

#

1323

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

1324

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

1325

# `AuthRequirement.provider_id`.

1326

#

1327

# Example: "bookstore_auth".

1328

},

1329

],

1330

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

1331

#

1332

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

1333

{ # Authentication rules for the service.

1334

#

1335

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

1336

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

1337

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

1338

# request.

1339

#

1340

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

1341

# ignored.

1342

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

1343

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

1344

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

1345

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

1346

#

1347

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

1348

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

1349

#

1350

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

1351

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

1352

# the OAuth scope across all of those APIs.

1353

#

1354

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

1355

# management about how developers will use them in practice.

1356

#

1357

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

1358

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

1359

# due to the backend requiring additional scopes or permissions.

1360

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

1361

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

#

# Example:

#

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

1366

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

1367

},

1368

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

1369

#

1370

# Refer to selector for syntax details.

1371

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

1372

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

1373

{ # User-defined authentication requirements, including support for

1374

# [JSON Web Token

1375

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

1376

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

#

# Example:

#

# provider_id: bookstore_auth

1381

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

1382

# implemented and accepted in all the runtime components.

1383

#

1384

# The list of JWT

1385

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

1386

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

1387

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

1388

# "https://Service_name/API_name"

1389

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

1390

# LibraryService API will only accept JWTs with the following audience

1391

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

#

# Example:

#

# audiences: bookstore_android.apps.googleusercontent.com,

1396

# bookstore_web.apps.googleusercontent.com

},

],

},

],

},

Bu Sun Kim

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

[diff] [blame]

1402

"endpoints": [ # Configuration for network endpoints. Contains only the names and aliases

1403

# of the endpoints.

1404

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

1405

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

1406

# same service configuration, such as quota configuration and monitoring

1407

# configuration.

1408

#

1409

# Example service configuration:

1410

#

1411

# name: library-example.googleapis.com

1412

# endpoints:

1413

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

1414

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

1415

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

1416

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

1417

# # allowed to proceed.

1418

# - name: library-example.googleapis.com

1419

# allow_cors: true

Bu Sun Kim

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

[diff] [blame]

1420

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

1421

"A String",

1422

],

1423

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

1424

# handle requests to this [API

1425

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

1426

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

1427

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

Bu Sun Kim

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

[diff] [blame]

1428

"allowCors": True or False, # Allowing

1429

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

1430

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

1431

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

1432

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

1433

# allowed to proceed.

Bu Sun Kim

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

[diff] [blame]

1434

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

1435

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

1436

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

1437

# aliases.

1438

#

1439

# Additional names that this endpoint will be hosted on.

"A String",

],

},

],

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

1445

# usage.

1446

#

1447

# The metric based quota configuration works this way:

1448

# - The service configuration defines a set of metrics.

1449

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

1450

# corresponding costs.

1451

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

1452

# quota checks at runtime.

1453

#

1454

# An example quota configuration in yaml format:

#

# quota:

# limits:

#

# - name: apiWriteQpsPerProject

1460

# metric: library.googleapis.com/write_calls

1461

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

# values:

# STANDARD: 10000

#

#

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

1467

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

1468

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

1469

# # consuming at twice rate as the DeleteBook method.

# metric_rules:

# - selector: "*"

# metric_costs:

# library.googleapis.com/read_calls: 1

1474

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

1475

# metric_costs:

1476

# library.googleapis.com/write_calls: 2

1477

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

1478

# metric_costs:

1479

# library.googleapis.com/write_calls: 1

1480

#

1481

# Corresponding Metric definition:

1482

#

1483

# metrics:

1484

# - name: library.googleapis.com/read_calls

1485

# display_name: Read requests

# metric_kind: DELTA

# value_type: INT64

#

# - name: library.googleapis.com/write_calls

1490

# display_name: Write requests

1491

# metric_kind: DELTA

1492

# value_type: INT64

1493

#

Bu Sun Kim

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

[diff] [blame]

1494

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

1495

# or more metrics.

1496

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

1497

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

1498

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

1499

# cost applied to each metric.

1500

#

1501

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

1502

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

1503

# The value must not be negative.

1504

"a_key": "A String",

1505

},

1506

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

1507

#

1508

# Refer to selector for syntax details.

1509

},

1510

],

Bu Sun Kim

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

[diff] [blame]

1511

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

1512

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

1513

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

1514

# type combination defined within a `QuotaGroup`.

1515

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

Bu Sun Kim

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

[diff] [blame]

1516

#

Bu Sun Kim

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

[diff] [blame]

1517

# Used by group-based quotas only.

1518

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

Bu Sun Kim

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

[diff] [blame]

1519

#

Bu Sun Kim

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

[diff] [blame]

1520

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

1521

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

Bu Sun Kim

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

[diff] [blame]

1522

#

Bu Sun Kim

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

[diff] [blame]

1523

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

1524

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

1525

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

1526

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

1527

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

Bu Sun Kim

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

[diff] [blame]

1528

#

Bu Sun Kim

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

[diff] [blame]

1529

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

1530

# indicating unlimited maximum quota.

Bu Sun Kim

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

[diff] [blame]

1531

#

Bu Sun Kim

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

[diff] [blame]

1532

# Used by group-based quotas only.

1533

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

1534

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

1535

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

1536

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

1537

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

1538

# specified unit. Currently only STANDARD is supported.

1539

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1540

},

Bu Sun Kim

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

[diff] [blame]

1541

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

1542

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

1543

# backend system.

Bu Sun Kim

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

[diff] [blame]

1544

#

Bu Sun Kim

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

[diff] [blame]

1545

# Here are some examples:

1546

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

1547

#

1548

# Note: the order of unit components is insignificant.

1549

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

1550

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

1551

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

1552

# defined within the service config.

1553

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

1554

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

1555

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

1556

# display name generated from the configuration.

1557

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

1558

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

1559

# billed amount when billing is enabled.

1560

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

1561

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

1562

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

1563

#

1564

# Used by group-based quotas only.

1565

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

1566

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

1567

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

1568

#

1569

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

1570

# are provisioning quota to selected consumers and blocking others.

1571

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

1572

# negative values are allowed.

1573

#

1574

# Used by group-based quotas only.

Bu Sun Kim

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

[diff] [blame]

1575

},

1576

],

1577

},

Bu Sun Kim

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

[diff] [blame]

1578

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

Bu Sun Kim

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

[diff] [blame]

1579

"name": "A String", # The DNS address at which this service is available.

1580

#

1581

# An example DNS address would be:

1582

# `calendar.googleapis.com`.

Bu Sun Kim

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

[diff] [blame]

1583

"apis": [ # A list of API interfaces exported by this service. Contains only the names,

Bu Sun Kim

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

[diff] [blame]

1584

# versions, and method names of the interfaces.

1585

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

1586

#

Bu Sun Kim

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

[diff] [blame]

1587

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

1588

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

Bu Sun Kim

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

[diff] [blame]

1589

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

1590

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

Bu Sun Kim

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

[diff] [blame]

1591

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

Bu Sun Kim

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

[diff] [blame]

1592

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

1593

# detailed terminology.

Bu Sun Kim

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

[diff] [blame]

1594

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

Bu Sun Kim

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

[diff] [blame]

1595

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

1596

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

1597

# enumeration, etc.

1598

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

1599

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

1600

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

1601

# `"google.api.http"`.

1602

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

1603

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

1604

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

1605

# value using the google.protobuf.Int32Value type.

1606

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

1607

},

1608

},

1609

],

Bu Sun Kim

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

[diff] [blame]

1610

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

1611

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

1612

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

1613

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

1614

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

1615

# consistent with what is provided here.

1616

#

1617

# The versioning schema uses [semantic

1618

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

1619

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

1620

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

1621

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

1622

# chosen based on the product plan.

1623

#

1624

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

1625

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

1626

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

1627

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

1628

# experimental, non-GA interfaces.

Bu Sun Kim

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

[diff] [blame]

1629

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

Bu Sun Kim

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

[diff] [blame]

1630

# message.

1631

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

Bu Sun Kim

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

[diff] [blame]

1632

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

1633

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

Bu Sun Kim

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

[diff] [blame]

1634

},

Bu Sun Kim

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

[diff] [blame]

1635

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

Bu Sun Kim

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

[diff] [blame]

1636

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

1637

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

1638

# documentation and options are inherited as follows:

1639

#

1640

# - If after comment and whitespace stripping, the documentation

1641

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

1642

# from the original method.

1643

#

1644

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

1645

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

1646

# inherited.

1647

#

1648

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

1649

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

1650

# version of the including interface plus the root path if

1651

# specified.

1652

#

1653

# Example of a simple mixin:

1654

#

1655

# package google.acl.v1;

1656

# service AccessControl {

1657

# // Get the underlying ACL object.

1658

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

1659

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

Bu Sun Kim

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

[diff] [blame]

# }

# }

#

# package google.storage.v2;

1664

# service Storage {

1665

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

1666

#

1667

# // Get a data record.

1668

# rpc GetData(GetDataRequest) returns (Data) {

Bu Sun Kim

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

[diff] [blame]

1669

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

Bu Sun Kim

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

[diff] [blame]

# }

# }

#

# Example of a mixin configuration:

1674

#

1675

# apis:

1676

# - name: google.storage.v2.Storage

1677

# mixins:

1678

# - name: google.acl.v1.AccessControl

1679

#

1680

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

1681

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

1682

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

1683

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

1684

# documentation and annotations as follows:

1685

#

1686

# service Storage {

1687

# // Get the underlying ACL object.

1688

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

1689

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

Bu Sun Kim

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

[diff] [blame]

# }

# ...

# }

#

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

1695

#

1696

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

1697

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

1698

#

1699

# apis:

1700

# - name: google.storage.v2.Storage

1701

# mixins:

1702

# - name: google.acl.v1.AccessControl

1703

# root: acls

1704

#

1705

# This implies the following inherited HTTP annotation:

1706

#

1707

# service Storage {

1708

# // Get the underlying ACL object.

1709

# rpc GetAcl(GetAclRequest) returns (Acl) {

Bu Sun Kim

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

[diff] [blame]

1710

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

Bu Sun Kim

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

[diff] [blame]

1711

# }

1712

# ...

1713

# }

Bu Sun Kim

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

[diff] [blame]

1714

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

1715

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

Bu Sun Kim

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

[diff] [blame]

1716

# are rooted.

Bu Sun Kim

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

[diff] [blame]

1717

},

1718

],

Bu Sun Kim

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

[diff] [blame]

1719

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

1720

# followed by the interface's simple name.

Bu Sun Kim

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

[diff] [blame]

1721

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

Bu Sun Kim

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

[diff] [blame]

1722

{ # Method represents a method of an API interface.

Bu Sun Kim

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

[diff] [blame]

1723

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

Bu Sun Kim

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

[diff] [blame]

1724

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

1725

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

1726

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

Bu Sun Kim

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

[diff] [blame]

1727

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

Bu Sun Kim

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

[diff] [blame]

1728

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

1729

# enumeration, etc.

Bu Sun Kim

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

[diff] [blame]

1730

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

1731

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

1732

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

1733

# `"google.api.http"`.

Bu Sun Kim

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

[diff] [blame]

1734

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

Bu Sun Kim

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

[diff] [blame]

1735

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

1736

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

1737

# value using the google.protobuf.Int32Value type.

Bu Sun Kim

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

[diff] [blame]

1738

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

Bu Sun Kim

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

[diff] [blame]

1739

},

1740

},

1741

],

Bu Sun Kim

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

[diff] [blame]

1742

"responseTypeUrl": "A String", # The URL of the output message type.

1743

"requestTypeUrl": "A String", # A URL of the input message type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1744

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1745

],

1746

},

1747

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1748

"usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.

1749

"requirements": [ # Requirements that must be satisfied before a consumer project can use the

1750

# service. Each requirement is of the form <service.name>/<requirement-id>;

1751

# for example 'serviceusage.googleapis.com/billing-enabled'.

1752

"A String",

1753

],

1754

"serviceIdentity": { # The per-product per-project service identity for a service. # The configuration of a per-product per-project service identity.

1755

#

1756

#

1757

# Use this field to configure per-product per-project service identity.

1758

# Example of a service identity configuration.

#

# usage:

# service_identity:

# - service_account_parent: "projects/123456789"

1763

# display_name: "Cloud XXX Service Agent"

1764

# description: "Used as the identity of Cloud XXX to access resources"

1765

"displayName": "A String", # Optional. A user-specified name for the service account.

1766

# Must be less than or equal to 100 UTF-8 bytes.

1767

"description": "A String", # Optional. A user-specified opaque description of the service account.

1768

# Must be less than or equal to 256 UTF-8 bytes.

1769

"serviceAccountParent": "A String", # A service account project that hosts the service accounts.

1770

#

1771

# An example name would be:

1772

# `projects/123456789`

1773

},

1774

"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the

1775

# service producer.

1776

#

1777

# Google Service Management currently only supports

1778

# [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification

1779

# channel. To use Google Cloud Pub/Sub as the channel, this must be the name

1780

# of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format

1781

# documented in https://cloud.google.com/pubsub/docs/overview.

1782

"rules": [ # A list of usage rules that apply to individual API methods.

1783

#

1784

# **NOTE:** All service configuration rules follow "last one wins" order.

1785

{ # Usage configuration rules for the service.

1786

#

1787

# NOTE: Under development.

1788

#

1789

#

1790

# Use this rule to configure unregistered calls for the service. Unregistered

1791

# calls are calls that do not contain consumer project identity.

1792

# (Example: calls that do not contain an API key).

1793

# By default, API methods do not allow unregistered calls, and each method call

1794

# must be identified by a consumer project identity. Use this rule to

1795

# allow/disallow unregistered calls.

1796

#

1797

# Example of an API that wants to allow unregistered calls for entire service.

#

# usage:

# rules:

# - selector: "*"

# allow_unregistered_calls: true

1803

#

1804

# Example of a method that wants to allow unregistered calls.

#

# usage:

# rules:

# - selector: "google.example.library.v1.LibraryService.CreateBook"

1809

# allow_unregistered_calls: true

1810

"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all

1811

# methods in all APIs.

1812

#

1813

# Refer to selector for syntax details.

1814

"skipServiceControl": True or False, # If true, the selected method should skip service control and the control

1815

# plane features, such as quota and billing, will not be available.

1816

# This flag is used by Google Cloud Endpoints to bypass checks for internal

1817

# methods, such as service health check methods.

1818

"allowUnregisteredCalls": True or False, # If true, the selected method allows unregistered calls, e.g. calls

1819

# that don't identify any user or application.

1820

},

1821

],

1822

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1823

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1824

"name": "A String", # The resource name of the consumer and service.

1825

#

1826

# A valid name would be:

1827

# - projects/123/services/serviceusage.googleapis.com

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1828

"state": "A String", # Whether or not the service has been enabled for use by the consumer.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1829

"parent": "A String", # The resource name of the consumer.

1830

#

1831

# A valid name would be:

1832

# - projects/123

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1833

},

1834

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1835

"nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# query.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1842

<pre>Retrieves the next page of results.

1843

1844

Args:

1845

previous_request: The request for the previous page. (required)

1846

previous_response: The response from the request for the previous page. (required)

1847

1848

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1849

A request object that you can call 'execute()' on to request the next

Bu Sun Kim