You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto",
903
+
"id": "Aspect",
904
+
"properties": {
905
+
"kind": {
906
+
"description": "The type of this aspect configuration.",
907
+
"type": "string"
908
+
},
909
+
"spec": {
910
+
"additionalProperties": {
911
+
"description": "Properties of the object.",
912
+
"type": "any"
913
+
},
914
+
"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.",
915
+
"type": "object"
916
+
}
917
+
},
918
+
"type": "object"
919
+
},
901
920
"AuditConfig": {
902
921
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.",
903
922
"id": "AuditConfig",
@@ -1077,6 +1096,10 @@
1077
1096
"description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.",
1078
1097
"type": "string"
1079
1098
},
1099
+
"loadBalancingPolicy": {
1100
+
"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".",
1101
+
"type": "string"
1102
+
},
1080
1103
"minDeadline": {
1081
1104
"deprecated": true,
1082
1105
"description": "Deprecated, do not use.",
@@ -1595,7 +1618,7 @@
1595
1618
"type": "array"
1596
1619
},
1597
1620
"sectionOverrides": {
1598
-
"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries",
1621
+
"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries",
1599
1622
"items": {
1600
1623
"$ref": "Page"
1601
1624
},
@@ -1625,7 +1648,7 @@
1625
1648
"type": "string"
1626
1649
},
1627
1650
"disableReplacementWords": {
1628
-
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.",
1651
+
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.",
1629
1652
"type": "string"
1630
1653
},
1631
1654
"selector": {
@@ -1794,6 +1817,10 @@
1794
1817
"restAsyncIoEnabled": {
1795
1818
"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.",
1796
1819
"type": "boolean"
1820
+
},
1821
+
"unversionedPackageDisabled": {
1822
+
"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.",
1823
+
"type": "boolean"
1797
1824
}
1798
1825
},
1799
1826
"type": "object"
@@ -2885,7 +2912,7 @@
2885
2912
"id": "Page",
2886
2913
"properties": {
2887
2914
"content": {
2888
-
"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
2915
+
"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
2889
2916
"type": "string"
2890
2917
},
2891
2918
"name": {
@@ -3198,6 +3225,10 @@
3198
3225
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
3199
3226
"id": "SelectiveGapicGeneration",
3200
3227
"properties": {
3228
+
"generateOmittedAsInternal": {
3229
+
"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.",
3230
+
"type": "boolean"
3231
+
},
3201
3232
"methods": {
3202
3233
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
3203
3234
"items": {
@@ -3219,6 +3250,13 @@
3219
3250
},
3220
3251
"type": "array"
3221
3252
},
3253
+
"aspects": {
3254
+
"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.",
3255
+
"items": {
3256
+
"$ref": "Aspect"
3257
+
},
3258
+
"type": "array"
3259
+
},
3222
3260
"authentication": {
3223
3261
"$ref": "Authentication",
3224
3262
"description": "Auth configuration."
@@ -3666,11 +3704,11 @@
3666
3704
"type": "object"
3667
3705
},
3668
3706
"UsageRule": {
3669
-
"description": "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",
3707
+
"description": "Usage configuration rules for the service.",
3670
3708
"id": "UsageRule",
3671
3709
"properties": {
3672
3710
"allowUnregisteredCalls": {
3673
-
"description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.",
3711
+
"description": " 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). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.",
* Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto
173
+
*/
174
+
exportinterfaceSchema$Aspect{
175
+
/**
176
+
* The type of this aspect configuration.
177
+
*/
178
+
kind?: string|null;
179
+
/**
180
+
* Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.
181
+
*/
182
+
spec?: {[key: string]: any}|null;
183
+
}
171
184
/**
172
185
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
* The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
300
313
*/
301
314
jwtAudience?: string|null;
315
+
/**
316
+
* The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin".
* Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
660
+
* Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries
* 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.
786
803
*/
787
804
restAsyncIoEnabled?: boolean|null;
805
+
/**
806
+
* Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.
807
+
*/
808
+
unversionedPackageDisabled?: boolean|null;
788
809
}
789
810
/**
790
811
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
* The Markdown content of the page. You can use (== include {path\} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
1526
+
* The Markdown content of the page. You can use ```(== include {path\} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
* This message is used to configure the generation of a subset of the RPCs in a service for client libraries.
1724
1745
*/
1725
1746
exportinterfaceSchema$SelectiveGapicGeneration{
1747
+
/**
1748
+
* Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.
1749
+
*/
1750
+
generateOmittedAsInternal?: boolean|null;
1726
1751
/**
1727
1752
* An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.
* A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
1737
1762
*/
1738
1763
apis?: Schema$Api[];
1764
+
/**
1765
+
* Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.
* 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
2086
+
* Usage configuration rules for the service.
2058
2087
*/
2059
2088
exportinterfaceSchema$UsageRule{
2060
2089
/**
2061
-
* If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
2090
+
* 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). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.
0 commit comments