blob: 29c601382d474990fbd2f49634af95e1df08913d [file] [log] [blame]
// Copyright 2017 Google Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.api;
import "google/api/annotations.proto";
option go_package = ";serviceconfig";
option java_multiple_files = true;
option java_outer_classname = "UsageProto";
option java_package = "";
option objc_class_prefix = "GAPI";
// Configuration controlling usage of a service.
message Usage {
// Requirements that must be satisfied before a consumer project can use the
// service. Each requirement is of the form <>/<requirement-id>;
// for example ''.
repeated string requirements = 1;
// A list of usage rules that apply to individual API methods.
// **NOTE:** All service configuration rules follow "last one wins" order.
repeated UsageRule rules = 6;
// The full resource name of a channel used for sending notifications to the
// service producer.
// Google Service Management currently only supports
// [Google Cloud Pub/Sub]( as a notification
// channel. To use Google Cloud Pub/Sub as the channel, this must be the name
// of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
// documented in
string producer_notification_channel = 7;
// Usage configuration rules for the service.
// NOTE: Under development.
// Use this rule to configure unregistered calls for the service. Unregistered
// calls are calls that do not contain consumer project identity.
// (Example: calls that do not contain an API key).
// By default, API methods do not allow unregistered calls, and each method call
// must be identified by a consumer project identity. Use this rule to
// allow/disallow unregistered calls.
// Example of an API that wants to allow unregistered calls for entire service.
// usage:
// rules:
// - selector: "*"
// allow_unregistered_calls: true
// Example of a method that wants to allow unregistered calls.
// usage:
// rules:
// - selector: "google.example.library.v1.LibraryService.CreateBook"
// allow_unregistered_calls: true
message UsageRule {
// Selects the methods to which this rule applies. Use '*' to indicate all
// methods in all APIs.
// Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
// True, if the method allows unregistered calls; false otherwise.
bool allow_unregistered_calls = 2;