mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-15 22:18:10 +01:00
update all APIs
Like documented in the README ``` rm -f .api.deps .cli.deps && FETCH_APIS=1 make update-json -j8 ```
This commit is contained in:
Sebastian Thiel
@@ -195,7 +195,7 @@
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
|
||||
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
||||
"flatPath": "v1/operations",
|
||||
"httpMethod": "GET",
|
||||
"id": "serviceusage.operations.list",
|
||||
@@ -426,9 +426,33 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20230118",
|
||||
"revision": "20240303",
|
||||
"rootUrl": "https://serviceusage.googleapis.com/",
|
||||
"schemas": {
|
||||
"AddEnableRulesMetadata": {
|
||||
"description": "Metadata for the `AddEnableRules` method.",
|
||||
"id": "AddEnableRulesMetadata",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"AddEnableRulesResponse": {
|
||||
"description": "The response message of `AddEnableRules` method.",
|
||||
"id": "AddEnableRulesResponse",
|
||||
"properties": {
|
||||
"addedValues": {
|
||||
"description": "The values added to the parent consumer policy.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AdminQuotaPolicy": {
|
||||
"description": "Quota policy created by quota administrator.",
|
||||
"id": "AdminQuotaPolicy",
|
||||
@@ -441,7 +465,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.",
|
||||
"description": " If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.",
|
||||
"type": "object"
|
||||
},
|
||||
"metric": {
|
||||
@@ -501,11 +525,13 @@
|
||||
"description": "The source syntax of the service.",
|
||||
"enum": [
|
||||
"SYNTAX_PROTO2",
|
||||
"SYNTAX_PROTO3"
|
||||
"SYNTAX_PROTO3",
|
||||
"SYNTAX_EDITIONS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Syntax `proto2`.",
|
||||
"Syntax `proto3`."
|
||||
"Syntax `proto3`.",
|
||||
"Syntax `editions`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -648,6 +674,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"minDeadline": {
|
||||
"deprecated": true,
|
||||
"description": "Deprecated, do not use.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
@@ -657,6 +684,13 @@
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
},
|
||||
"overridesByRequestProtocol": {
|
||||
"additionalProperties": {
|
||||
"$ref": "BackendRule"
|
||||
},
|
||||
"description": "The map between request protocol and the backend address.",
|
||||
"type": "object"
|
||||
},
|
||||
"pathTranslation": {
|
||||
"enum": [
|
||||
"PATH_TRANSLATION_UNSPECIFIED",
|
||||
@@ -861,7 +895,7 @@
|
||||
"description": "Settings for Ruby client libraries."
|
||||
},
|
||||
"version": {
|
||||
"description": "Version of the API to apply these settings to.",
|
||||
"description": "Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: \"google.cloud.speech.v1\" and \"google.spanner.admin.database.v1\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -889,12 +923,48 @@
|
||||
"type": "array"
|
||||
},
|
||||
"referenceDocsUri": {
|
||||
"deprecated": true,
|
||||
"description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ConsumerPolicy": {
|
||||
"description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.",
|
||||
"id": "ConsumerPolicy",
|
||||
"properties": {
|
||||
"annotations": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)",
|
||||
"type": "object"
|
||||
},
|
||||
"enableRules": {
|
||||
"description": "Enable rules define usable services and service groups.",
|
||||
"items": {
|
||||
"$ref": "EnableRule"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "An opaque tag indicating the current version of the policy, used for concurrency control.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. The resource name of the policy. We only allow consumer policy name as `default` for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "The last-modified time.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Context": {
|
||||
"description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using \u201cx-goog-ext--bin\u201d and \u201cx-goog-ext--jspb\u201d format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.",
|
||||
"id": "Context",
|
||||
@@ -955,6 +1025,13 @@
|
||||
"environment": {
|
||||
"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com",
|
||||
"type": "string"
|
||||
},
|
||||
"methodPolicies": {
|
||||
"description": "Defines policies applying to the API methods of the service.",
|
||||
"items": {
|
||||
"$ref": "MethodPolicy"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1070,7 +1147,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Documentation": {
|
||||
"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.",
|
||||
"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.",
|
||||
"id": "Documentation",
|
||||
"properties": {
|
||||
"documentationRootUrl": {
|
||||
@@ -1095,6 +1172,13 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sectionOverrides": {
|
||||
"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries",
|
||||
"items": {
|
||||
"$ref": "Page"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"serviceRootUrl": {
|
||||
"description": "Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.",
|
||||
"type": "string"
|
||||
@@ -1118,6 +1202,10 @@
|
||||
"description": "Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.",
|
||||
"type": "string"
|
||||
},
|
||||
"disableReplacementWords": {
|
||||
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.",
|
||||
"type": "string"
|
||||
},
|
||||
"selector": {
|
||||
"description": "The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in \"*\", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern \"*\" is used.",
|
||||
"type": "string"
|
||||
@@ -1132,6 +1220,41 @@
|
||||
"common": {
|
||||
"$ref": "CommonLanguageSettings",
|
||||
"description": "Some settings."
|
||||
},
|
||||
"forcedNamespaceAliases": {
|
||||
"description": "Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"handwrittenSignatures": {
|
||||
"description": "Method signatures (in the form \"service.method(signature)\") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"ignoredResources": {
|
||||
"description": "List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: \"documentai.googleapis.com/Location\"",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"renamedResources": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: \"datalabeling.googleapis.com/Dataset\": \"DataLabelingDataset\"",
|
||||
"type": "object"
|
||||
},
|
||||
"renamedServices": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1157,6 +1280,52 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"EnableRule": {
|
||||
"description": "The consumer policy rule that defines usable services and service groups.",
|
||||
"id": "EnableRule",
|
||||
"properties": {
|
||||
"enableType": {
|
||||
"description": "Client and resource project enable type.",
|
||||
"enum": [
|
||||
"ENABLE_TYPE_UNSPECIFIED",
|
||||
"CLIENT",
|
||||
"RESOURCE",
|
||||
"V1_COMPATIBLE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified enable type, which means enabled as both client and resource project.",
|
||||
"Enable all clients under the CRM node specified by `ConsumerPolicy.name` to use the listed services. A client can be an API key, an OAuth client, or a service account.",
|
||||
"Enable resources in the list services to be created and used under the CRM node specified by the `ConsumerPolicy.name`.",
|
||||
"Activation made by Service Usage v1 API. This will be how consumers differentiate between policy changes made by v1 and v2 clients and understand what is actually possible based on those different policies."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"groups": {
|
||||
"deprecated": true,
|
||||
"description": "DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"services": {
|
||||
"deprecated": true,
|
||||
"description": "DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"values": {
|
||||
"description": "The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"EnableServiceRequest": {
|
||||
"description": "Request message for the `EnableService` method.",
|
||||
"id": "EnableServiceRequest",
|
||||
@@ -1179,6 +1348,7 @@
|
||||
"id": "Endpoint",
|
||||
"properties": {
|
||||
"aliases": {
|
||||
"deprecated": true,
|
||||
"description": "Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
@@ -1204,6 +1374,10 @@
|
||||
"description": "Enum type definition.",
|
||||
"id": "Enum",
|
||||
"properties": {
|
||||
"edition": {
|
||||
"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.",
|
||||
"type": "string"
|
||||
},
|
||||
"enumvalue": {
|
||||
"description": "Enum value definitions.",
|
||||
"items": {
|
||||
@@ -1230,11 +1404,13 @@
|
||||
"description": "The source syntax.",
|
||||
"enum": [
|
||||
"SYNTAX_PROTO2",
|
||||
"SYNTAX_PROTO3"
|
||||
"SYNTAX_PROTO3",
|
||||
"SYNTAX_EDITIONS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Syntax `proto2`.",
|
||||
"Syntax `proto3`."
|
||||
"Syntax `proto3`.",
|
||||
"Syntax `editions`."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1370,6 +1546,25 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"FieldPolicy": {
|
||||
"description": "Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.",
|
||||
"id": "FieldPolicy",
|
||||
"properties": {
|
||||
"resourcePermission": {
|
||||
"description": "Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, \"resourcemanager.projects.get\".",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceType": {
|
||||
"description": "Specifies the resource type for the resource referred to by the field.",
|
||||
"type": "string"
|
||||
},
|
||||
"selector": {
|
||||
"description": "Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as \"foo.bar\" or \"foo.bar,foo.baz\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetServiceIdentityMetadata": {
|
||||
"description": "Metadata for the `GetServiceIdentity` method.",
|
||||
"id": "GetServiceIdentityMetadata",
|
||||
@@ -1695,6 +1890,69 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleApiServiceusageV2alphaConsumerPolicy": {
|
||||
"description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.",
|
||||
"id": "GoogleApiServiceusageV2alphaConsumerPolicy",
|
||||
"properties": {
|
||||
"annotations": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)",
|
||||
"type": "object"
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.",
|
||||
"format": "google-datetime",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"enableRules": {
|
||||
"description": "Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases.",
|
||||
"items": {
|
||||
"$ref": "GoogleApiServiceusageV2alphaEnableRule"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. The time the policy was last updated.",
|
||||
"format": "google-datetime",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleApiServiceusageV2alphaEnableRule": {
|
||||
"description": "The consumer policy rule that defines enabled services, groups, and categories.",
|
||||
"id": "GoogleApiServiceusageV2alphaEnableRule",
|
||||
"properties": {
|
||||
"services": {
|
||||
"description": "The names of the services that are enabled. Example: `services/storage.googleapis.com`.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata": {
|
||||
"description": "Metadata for the `UpdateConsumerPolicy` method.",
|
||||
"id": "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"Http": {
|
||||
"description": "Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.",
|
||||
"id": "Http",
|
||||
@@ -2060,24 +2318,51 @@
|
||||
"description": "The source syntax of this method.",
|
||||
"enum": [
|
||||
"SYNTAX_PROTO2",
|
||||
"SYNTAX_PROTO3"
|
||||
"SYNTAX_PROTO3",
|
||||
"SYNTAX_EDITIONS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Syntax `proto2`.",
|
||||
"Syntax `proto3`."
|
||||
"Syntax `proto3`.",
|
||||
"Syntax `editions`."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MethodPolicy": {
|
||||
"description": "Defines policies applying to an RPC method.",
|
||||
"id": "MethodPolicy",
|
||||
"properties": {
|
||||
"requestPolicies": {
|
||||
"description": "Policies that are applicable to the request message.",
|
||||
"items": {
|
||||
"$ref": "FieldPolicy"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"selector": {
|
||||
"description": "Selects a method to which these policies should be enforced, for example, \"google.pubsub.v1.Subscriber.CreateSubscription\". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MethodSettings": {
|
||||
"description": "Describes the generator configuration for a method.",
|
||||
"id": "MethodSettings",
|
||||
"properties": {
|
||||
"autoPopulatedFields": {
|
||||
"description": "List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"longRunning": {
|
||||
"$ref": "LongRunning",
|
||||
"description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_behavior: - selector: CreateAdDomain long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes"
|
||||
"description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes"
|
||||
},
|
||||
"selector": {
|
||||
"description": "The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.",
|
||||
@@ -2203,6 +2488,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"launchStage": {
|
||||
"deprecated": true,
|
||||
"description": "Deprecated. Must use the MetricDescriptor.launch_stage instead.",
|
||||
"enum": [
|
||||
"LAUNCH_STAGE_UNSPECIFIED",
|
||||
@@ -2254,7 +2540,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Mixin": {
|
||||
"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\"; } ... }",
|
||||
"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\"; } ... }",
|
||||
"id": "Mixin",
|
||||
"properties": {
|
||||
"name": {
|
||||
@@ -2316,7 +2602,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).",
|
||||
"description": "Required. The monitored resource type. For example, the type `\"cloudsql_database\"` represents databases in Google Cloud SQL. For a list of types, see [Monitored resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -2412,7 +2698,7 @@
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
||||
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
@@ -2526,7 +2812,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"newIssueUri": {
|
||||
"description": "Link to a place that API users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103",
|
||||
"description": "Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103",
|
||||
"type": "string"
|
||||
},
|
||||
"organization": {
|
||||
@@ -2536,16 +2822,30 @@
|
||||
"CLOUD",
|
||||
"ADS",
|
||||
"PHOTOS",
|
||||
"STREET_VIEW"
|
||||
"STREET_VIEW",
|
||||
"SHOPPING",
|
||||
"GEO",
|
||||
"GENERATIVE_AI"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not useful.",
|
||||
"Google Cloud Platform Org.",
|
||||
"Ads (Advertising) Org.",
|
||||
"Photos Org.",
|
||||
"Street View Org."
|
||||
"Street View Org.",
|
||||
"Shopping Org.",
|
||||
"Geo Org.",
|
||||
"Generative AI - https://developers.generativeai.google"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"protoReferenceDocumentationUri": {
|
||||
"description": "Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc",
|
||||
"type": "string"
|
||||
},
|
||||
"restReferenceDocumentationUri": {
|
||||
"description": "Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2671,6 +2971,31 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RemoveEnableRulesMetadata": {
|
||||
"description": "Metadata for the `RemoveEnableRules` method.",
|
||||
"id": "RemoveEnableRulesMetadata",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"RemoveEnableRulesResponse": {
|
||||
"description": "The response message of `RemoveEnableRules` method.",
|
||||
"id": "RemoveEnableRulesResponse",
|
||||
"properties": {
|
||||
"parent": {
|
||||
"description": "The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.",
|
||||
"type": "string"
|
||||
},
|
||||
"removedValues": {
|
||||
"deprecated": true,
|
||||
"description": "The values removed from the parent consumer policy.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RubySettings": {
|
||||
"description": "Settings for Ruby client libraries.",
|
||||
"id": "RubySettings",
|
||||
@@ -2808,6 +3133,10 @@
|
||||
"description": "A protocol buffer message type.",
|
||||
"id": "Type",
|
||||
"properties": {
|
||||
"edition": {
|
||||
"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.",
|
||||
"type": "string"
|
||||
},
|
||||
"fields": {
|
||||
"description": "The list of fields.",
|
||||
"items": {
|
||||
@@ -2841,11 +3170,13 @@
|
||||
"description": "The source syntax.",
|
||||
"enum": [
|
||||
"SYNTAX_PROTO2",
|
||||
"SYNTAX_PROTO3"
|
||||
"SYNTAX_PROTO3",
|
||||
"SYNTAX_EDITIONS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Syntax `proto2`.",
|
||||
"Syntax `proto3`."
|
||||
"Syntax `proto3`.",
|
||||
"Syntax `editions`."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -2858,6 +3189,12 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"UpdateConsumerPolicyMetadata": {
|
||||
"description": "Metadata for the `UpdateConsumerPolicy` method.",
|
||||
"id": "UpdateConsumerPolicyMetadata",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"Usage": {
|
||||
"description": "Configuration controlling usage of a service.",
|
||||
"id": "Usage",
|
||||
|
||||
Reference in New Issue
Block a user