|
| 1 | +// Copyright 2019 Google LLC. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | +// |
| 15 | + |
| 16 | +syntax = "proto3"; |
| 17 | + |
| 18 | +package google.api; |
| 19 | + |
| 20 | +import "google/protobuf/descriptor.proto"; |
| 21 | + |
| 22 | +option go_package = "api"; |
| 23 | +option java_multiple_files = true; |
| 24 | +option java_outer_classname = "ClientProto"; |
| 25 | +option java_package = "com.google.api"; |
| 26 | +option objc_class_prefix = "GAPI"; |
| 27 | + |
| 28 | +extend google.protobuf.MethodOptions { |
| 29 | + // A definition of a client library method signature. |
| 30 | + // |
| 31 | + // In client libraries, each proto RPC corresponds to one or more methods |
| 32 | + // which the end user is able to call, and calls the underlying RPC. |
| 33 | + // Normally, this method receives a single argument (a struct or instance |
| 34 | + // corresponding to the RPC request object). Defining this field will |
| 35 | + // add one or more overloads providing flattened or simpler method signatures |
| 36 | + // in some languages. |
| 37 | + // |
| 38 | + // The fields on the method signature are provided as a comma-separated |
| 39 | + // string. |
| 40 | + // |
| 41 | + // For example, the proto RPC and annotation: |
| 42 | + // |
| 43 | + // rpc CreateSubscription(CreateSubscriptionRequest) |
| 44 | + // returns (Subscription) { |
| 45 | + // option (google.api.method_signature) = "name,topic"; |
| 46 | + // } |
| 47 | + // |
| 48 | + // Would add the following Java overload (in addition to the method accepting |
| 49 | + // the request object): |
| 50 | + // |
| 51 | + // public final Subscription createSubscription(String name, String topic) |
| 52 | + // |
| 53 | + // The following backwards-compatibility guidelines apply: |
| 54 | + // |
| 55 | + // * Adding this annotation to an unannotated method is backwards |
| 56 | + // compatible. |
| 57 | + // * Adding this annotation to a method which already has existing |
| 58 | + // method signature annotations is backwards compatible if and only if |
| 59 | + // the new method signature annotation is last in the sequence. |
| 60 | + // * Modifying or removing an existing method signature annotation is |
| 61 | + // a breaking change. |
| 62 | + // * Re-ordering existing method signature annotations is a breaking |
| 63 | + // change. |
| 64 | + repeated string method_signature = 1051; |
| 65 | +} |
| 66 | + |
| 67 | +extend google.protobuf.ServiceOptions { |
| 68 | + // The hostname for this service. |
| 69 | + // This should be specified with no prefix or protocol. |
| 70 | + // |
| 71 | + // Example: |
| 72 | + // |
| 73 | + // service Foo { |
| 74 | + // option (google.api.default_host) = "foo.googleapi.com"; |
| 75 | + // ... |
| 76 | + // } |
| 77 | + string default_host = 1049; |
| 78 | + |
| 79 | + // OAuth scopes needed for the client. |
| 80 | + // |
| 81 | + // Example: |
| 82 | + // |
| 83 | + // service Foo { |
| 84 | + // option (google.api.oauth_scopes) = \ |
| 85 | + // "https://www.googleapis.com/auth/cloud-platform"; |
| 86 | + // ... |
| 87 | + // } |
| 88 | + // |
| 89 | + // If there is more than one scope, use a comma-separated string: |
| 90 | + // |
| 91 | + // Example: |
| 92 | + // |
| 93 | + // service Foo { |
| 94 | + // option (google.api.oauth_scopes) = \ |
| 95 | + // "https://www.googleapis.com/auth/cloud-platform," |
| 96 | + // "https://www.googleapis.com/auth/monitoring"; |
| 97 | + // ... |
| 98 | + // } |
| 99 | + string oauth_scopes = 1050; |
| 100 | +} |
0 commit comments