|
426 | 426 | } |
427 | 427 | } |
428 | 428 | }, |
429 | | - "revision": "20240811", |
| 429 | + "revision": "20240929", |
430 | 430 | "rootUrl": "https://serviceusage.googleapis.com/", |
431 | 431 | "schemas": { |
432 | 432 | "AddEnableRulesMetadata": { |
|
1003 | 1003 | "deprecated": true, |
1004 | 1004 | "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", |
1005 | 1005 | "type": "string" |
| 1006 | + }, |
| 1007 | + "selectiveGapicGeneration": { |
| 1008 | + "$ref": "SelectiveGapicGeneration", |
| 1009 | + "description": "Configuration for which RPCs should be generated in the GAPIC client." |
1006 | 1010 | } |
1007 | 1011 | }, |
1008 | 1012 | "type": "object" |
|
1516 | 1520 | }, |
1517 | 1521 | "type": "object" |
1518 | 1522 | }, |
| 1523 | + "ExperimentalFeatures": { |
| 1524 | + "description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.", |
| 1525 | + "id": "ExperimentalFeatures", |
| 1526 | + "properties": { |
| 1527 | + "restAsyncIoEnabled": { |
| 1528 | + "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", |
| 1529 | + "type": "boolean" |
| 1530 | + } |
| 1531 | + }, |
| 1532 | + "type": "object" |
| 1533 | + }, |
1519 | 1534 | "Field": { |
1520 | 1535 | "description": "A single field of a message type.", |
1521 | 1536 | "id": "Field", |
|
2617 | 2632 | "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", |
2618 | 2633 | "format": "google-duration", |
2619 | 2634 | "type": "string" |
| 2635 | + }, |
| 2636 | + "timeSeriesResourceHierarchyLevel": { |
| 2637 | + "description": "The scope of the timeseries data of the metric.", |
| 2638 | + "items": { |
| 2639 | + "enum": [ |
| 2640 | + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", |
| 2641 | + "PROJECT", |
| 2642 | + "ORGANIZATION", |
| 2643 | + "FOLDER" |
| 2644 | + ], |
| 2645 | + "enumDescriptions": [ |
| 2646 | + "Do not use this default value.", |
| 2647 | + "Scopes a metric to a project.", |
| 2648 | + "Scopes a metric to an organization.", |
| 2649 | + "Scopes a metric to a folder." |
| 2650 | + ], |
| 2651 | + "type": "string" |
| 2652 | + }, |
| 2653 | + "type": "array" |
2620 | 2654 | } |
2621 | 2655 | }, |
2622 | 2656 | "type": "object" |
|
2641 | 2675 | "type": "object" |
2642 | 2676 | }, |
2643 | 2677 | "Mixin": { |
2644 | | - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", |
| 2678 | + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", |
2645 | 2679 | "id": "Mixin", |
2646 | 2680 | "properties": { |
2647 | 2681 | "name": { |
|
2958 | 2992 | "common": { |
2959 | 2993 | "$ref": "CommonLanguageSettings", |
2960 | 2994 | "description": "Some settings." |
| 2995 | + }, |
| 2996 | + "experimentalFeatures": { |
| 2997 | + "$ref": "ExperimentalFeatures", |
| 2998 | + "description": "Experimental features to be included during client library generation." |
2961 | 2999 | } |
2962 | 3000 | }, |
2963 | 3001 | "type": "object" |
|
3108 | 3146 | }, |
3109 | 3147 | "type": "object" |
3110 | 3148 | }, |
| 3149 | + "SelectiveGapicGeneration": { |
| 3150 | + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", |
| 3151 | + "id": "SelectiveGapicGeneration", |
| 3152 | + "properties": { |
| 3153 | + "methods": { |
| 3154 | + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", |
| 3155 | + "items": { |
| 3156 | + "type": "string" |
| 3157 | + }, |
| 3158 | + "type": "array" |
| 3159 | + } |
| 3160 | + }, |
| 3161 | + "type": "object" |
| 3162 | + }, |
3111 | 3163 | "ServiceIdentity": { |
3112 | 3164 | "description": "Service identity for a service. This is the identity that service producer should use to access consumer resources.", |
3113 | 3165 | "id": "ServiceIdentity", |
|
0 commit comments