@devvit/protos 0.11.7 → 0.11.8-next-2025-02-10-4d44fb2af.0
Sign up to get free protection for your applications and to get access to all the features.
- package/meta.min.json +7820 -0
- package/package.json +4 -4
- package/protos.min.js +2 -0
- package/protos.min.js.map +7 -0
- package/schema/.snootobuf/deps/buf/validate/expression.proto +92 -0
- package/schema/.snootobuf/deps/buf/validate/priv/private.proto +41 -0
- package/schema/.snootobuf/deps/buf/validate/validate.proto +4130 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/audit.proto +72 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/auth.proto +49 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/organization.proto +54 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/service.proto +46 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/subscription.proto +72 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/ui.proto +20 -0
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/user.proto +45 -0
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/admin.proto +54 -0
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/delivery.proto +773 -0
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/filter.proto +66 -0
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/firehose.proto +100 -0
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/intake.proto +19 -0
- package/schema/.snootobuf/deps/devvit/events/v1alpha/events.proto +446 -0
- package/schema/.snootobuf/deps/devvit/gateway/v1alpha/payments.proto +24 -0
- package/schema/.snootobuf/deps/devvit/options/options.proto +98 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/commentv2.proto +29 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/flair.proto +25 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modaction.proto +53 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modmail.proto +56 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/postv2.proto +107 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/subredditv2.proto +41 -0
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/userv2.proto +23 -0
- package/schema/.snootobuf/deps/devvit/triggers/v1alpha/triggers.proto +162 -0
- package/schema/.snootobuf/deps/enum/account_gender_category.proto +14 -0
- package/schema/.snootobuf/deps/enum/approval_status.proto +15 -0
- package/schema/.snootobuf/deps/enum/automated_reporting_level.proto +12 -0
- package/schema/.snootobuf/deps/enum/ban_evasion_threshold.proto +13 -0
- package/schema/.snootobuf/deps/enum/ban_info_action.proto +12 -0
- package/schema/.snootobuf/deps/enum/block_relation_type.proto +11 -0
- package/schema/.snootobuf/deps/enum/comment_sort.proto +18 -0
- package/schema/.snootobuf/deps/enum/comment_type.proto +11 -0
- package/schema/.snootobuf/deps/enum/crowd_control_level.proto +12 -0
- package/schema/.snootobuf/deps/enum/discussion_type.proto +10 -0
- package/schema/.snootobuf/deps/enum/distinguish_type.proto +14 -0
- package/schema/.snootobuf/deps/enum/flair_position.proto +11 -0
- package/schema/.snootobuf/deps/enum/hateful_content_threshold.proto +12 -0
- package/schema/.snootobuf/deps/enum/link_content_type.proto +11 -0
- package/schema/.snootobuf/deps/enum/link_type.proto +11 -0
- package/schema/.snootobuf/deps/enum/link_visibility.proto +11 -0
- package/schema/.snootobuf/deps/enum/prediction_leaderboard_entry_type.proto +11 -0
- package/schema/.snootobuf/deps/enum/promo_layout.proto +11 -0
- package/schema/.snootobuf/deps/enum/removed_by_type.proto +18 -0
- package/schema/.snootobuf/deps/enum/spam_level.proto +11 -0
- package/schema/.snootobuf/deps/enum/subreddit_type.proto +16 -0
- package/schema/.snootobuf/deps/enum/verdict.proto +14 -0
- package/schema/.snootobuf/deps/enum/vote.proto +12 -0
- package/schema/.snootobuf/deps/enum/whitelist_status.proto +17 -0
- package/schema/.snootobuf/deps/enum/wiki_edit_mode.proto +12 -0
- package/schema/.snootobuf/deps/evaluator/evaluator.proto +203 -0
- package/schema/.snootobuf/deps/google/api/annotations.proto +31 -0
- package/schema/.snootobuf/deps/google/api/apikeys/v2/apikeys.proto +288 -0
- package/schema/.snootobuf/deps/google/api/apikeys/v2/resources.proto +175 -0
- package/schema/.snootobuf/deps/google/api/auth.proto +237 -0
- package/schema/.snootobuf/deps/google/api/backend.proto +185 -0
- package/schema/.snootobuf/deps/google/api/billing.proto +77 -0
- package/schema/.snootobuf/deps/google/api/client.proto +431 -0
- package/schema/.snootobuf/deps/google/api/cloudquotas/v1/cloudquotas.proto +322 -0
- package/schema/.snootobuf/deps/google/api/cloudquotas/v1/resources.proto +315 -0
- package/schema/.snootobuf/deps/google/api/config_change.proto +84 -0
- package/schema/.snootobuf/deps/google/api/consumer.proto +82 -0
- package/schema/.snootobuf/deps/google/api/context.proto +92 -0
- package/schema/.snootobuf/deps/google/api/control.proto +41 -0
- package/schema/.snootobuf/deps/google/api/distribution.proto +213 -0
- package/schema/.snootobuf/deps/google/api/documentation.proto +168 -0
- package/schema/.snootobuf/deps/google/api/endpoint.proto +69 -0
- package/schema/.snootobuf/deps/google/api/error_reason.proto +589 -0
- package/schema/.snootobuf/deps/google/api/expr/conformance/v1alpha1/conformance_service.proto +183 -0
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/checked.proto +343 -0
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/eval.proto +118 -0
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/explain.proto +53 -0
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/syntax.proto +438 -0
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/value.proto +115 -0
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/decl.proto +84 -0
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/eval.proto +125 -0
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/expr.proto +265 -0
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/source.proto +62 -0
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/value.proto +114 -0
- package/schema/.snootobuf/deps/google/api/field_behavior.proto +104 -0
- package/schema/.snootobuf/deps/google/api/field_info.proto +106 -0
- package/schema/.snootobuf/deps/google/api/http.proto +371 -0
- package/schema/.snootobuf/deps/google/api/httpbody.proto +81 -0
- package/schema/.snootobuf/deps/google/api/label.proto +48 -0
- package/schema/.snootobuf/deps/google/api/launch_stage.proto +72 -0
- package/schema/.snootobuf/deps/google/api/log.proto +54 -0
- package/schema/.snootobuf/deps/google/api/logging.proto +81 -0
- package/schema/.snootobuf/deps/google/api/metric.proto +268 -0
- package/schema/.snootobuf/deps/google/api/monitored_resource.proto +130 -0
- package/schema/.snootobuf/deps/google/api/monitoring.proto +107 -0
- package/schema/.snootobuf/deps/google/api/policy.proto +85 -0
- package/schema/.snootobuf/deps/google/api/quota.proto +184 -0
- package/schema/.snootobuf/deps/google/api/resource.proto +243 -0
- package/schema/.snootobuf/deps/google/api/routing.proto +461 -0
- package/schema/.snootobuf/deps/google/api/service.proto +191 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/check_error.proto +124 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/distribution.proto +166 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/http_request.proto +93 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/log_entry.proto +126 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/metric_value.proto +81 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/operation.proto +123 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/quota_controller.proto +245 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/service_controller.proto +260 -0
- package/schema/.snootobuf/deps/google/api/servicecontrol/v2/service_controller.proto +196 -0
- package/schema/.snootobuf/deps/google/api/servicemanagement/v1/resources.proto +295 -0
- package/schema/.snootobuf/deps/google/api/servicemanagement/v1/servicemanager.proto +508 -0
- package/schema/.snootobuf/deps/google/api/serviceusage/v1/resources.proto +130 -0
- package/schema/.snootobuf/deps/google/api/serviceusage/v1/serviceusage.proto +305 -0
- package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/resources.proto +458 -0
- package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/serviceusage.proto +793 -0
- package/schema/.snootobuf/deps/google/api/source_info.proto +31 -0
- package/schema/.snootobuf/deps/google/api/system_parameter.proto +96 -0
- package/schema/.snootobuf/deps/google/api/usage.proto +96 -0
- package/schema/.snootobuf/deps/google/api/visibility.proto +113 -0
- package/schema/.snootobuf/deps/google/cloud/extended_operations.proto +150 -0
- package/schema/.snootobuf/deps/google/iam/admin/v1/iam.proto +1087 -0
- package/schema/.snootobuf/deps/google/iam/v1/iam_policy.proto +145 -0
- package/schema/.snootobuf/deps/google/iam/v1/logging/audit_data.proto +34 -0
- package/schema/.snootobuf/deps/google/iam/v1/options.proto +41 -0
- package/schema/.snootobuf/deps/google/iam/v1/policy.proto +240 -0
- package/schema/.snootobuf/deps/google/logging/type/http_request.proto +92 -0
- package/schema/.snootobuf/deps/google/logging/type/log_severity.proto +72 -0
- package/schema/.snootobuf/deps/google/longrunning/operations.proto +247 -0
- package/schema/.snootobuf/deps/google/protobuf/any.proto +158 -0
- package/schema/.snootobuf/deps/google/protobuf/api.proto +208 -0
- package/schema/.snootobuf/deps/google/protobuf/compiler/plugin.proto +183 -0
- package/schema/.snootobuf/deps/google/protobuf/descriptor.proto +921 -0
- package/schema/.snootobuf/deps/google/protobuf/duration.proto +116 -0
- package/schema/.snootobuf/deps/google/protobuf/empty.proto +51 -0
- package/schema/.snootobuf/deps/google/protobuf/field_mask.proto +245 -0
- package/schema/.snootobuf/deps/google/protobuf/source_context.proto +48 -0
- package/schema/.snootobuf/deps/google/protobuf/struct.proto +95 -0
- package/schema/.snootobuf/deps/google/protobuf/timestamp.proto +147 -0
- package/schema/.snootobuf/deps/google/protobuf/type.proto +187 -0
- package/schema/.snootobuf/deps/google/protobuf/wrappers.proto +123 -0
- package/schema/.snootobuf/deps/google/rpc/code.proto +186 -0
- package/schema/.snootobuf/deps/google/rpc/context/attribute_context.proto +287 -0
- package/schema/.snootobuf/deps/google/rpc/error_details.proto +246 -0
- package/schema/.snootobuf/deps/google/rpc/status.proto +47 -0
- package/schema/.snootobuf/deps/google/type/calendar_period.proto +57 -0
- package/schema/.snootobuf/deps/google/type/color.proto +170 -0
- package/schema/.snootobuf/deps/google/type/date.proto +50 -0
- package/schema/.snootobuf/deps/google/type/datetime.proto +97 -0
- package/schema/.snootobuf/deps/google/type/dayofweek.proto +51 -0
- package/schema/.snootobuf/deps/google/type/expr.proto +51 -0
- package/schema/.snootobuf/deps/google/type/fraction.proto +34 -0
- package/schema/.snootobuf/deps/google/type/latlng.proto +37 -0
- package/schema/.snootobuf/deps/google/type/money.proto +43 -0
- package/schema/.snootobuf/deps/google/type/month.proto +66 -0
- package/schema/.snootobuf/deps/google/type/postal_address.proto +135 -0
- package/schema/.snootobuf/deps/google/type/quaternion.proto +95 -0
- package/schema/.snootobuf/deps/google/type/timeofday.proto +44 -0
- package/schema/.snootobuf/deps/openapi/helper.proto +20 -0
- package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +189 -0
- package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +118 -0
- package/schema/.snootobuf/deps/reddit/api/metadata/v1/metadata.proto +55 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account.proto +579 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account_relations.proto +43 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/api/metadata/v1/metadata.proto +82 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/blocking/v1/user_blocking_service.proto +221 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree.proto +78 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_service.proto +189 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_structure.proto +29 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments.proto +417 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments_service.proto +72 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/auth.proto +25 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/features.proto +52 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/lang.proto +16 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/legal.proto +20 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/media.proto +149 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/moderation.proto +197 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/safety.proto +116 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/time.proto +25 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/domains/v1/domains_metadata_service.proto +101 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/grpc_thrift/v1/grpc_thrift_options.proto +34 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links.proto +798 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links_service.proto +186 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/messages/v1/messages.proto +110 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/sensitive/v1/wrappers.proto +51 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit.proto +1202 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_member_relations.proto +85 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_moderator_service.proto +363 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_service.proto +301 -0
- package/schema/.snootobuf/deps/reddit/coreplatform/thing/v0/thing.proto +2869 -0
- package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/custom_post.proto +15 -0
- package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/service.proto +11 -0
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/context_action.proto +48 -0
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/manifest.proto +70 -0
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/service.proto +11 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/acknowledge_order_delivery.proto +17 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/checkout.proto +89 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/common.proto +322 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/delete_products.proto +17 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/events.proto +14 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_batch_products.proto +15 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_gold_balances.proto +48 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_order.proto +31 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders.proto +26 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders_by_user.proto +15 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_payout_info_batch.proto +52 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_products.proto +23 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_user_profiles.proto +28 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/refund_order.proto +17 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service.proto +49 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service_data_compliance.proto +20 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/upsert_products.proto +17 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paygatewaypsps/v1/paygatewaypsps.proto +158 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payments_data_compliance.proto +18 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payorders.proto +195 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/admin.proto +44 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/ledger.proto +200 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/payments_data_compliance.proto +18 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/paypayments.proto +210 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +189 -0
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +135 -0
- package/schema/.snootobuf/deps/snooron_sources/text_classification/text_classification.proto +29 -0
- package/schema/.snootobuf/deps/snooron_sources/v2_event/v2_event.proto +3292 -0
- package/schema/.snootobuf/deps/validate/validate.proto +862 -0
@@ -0,0 +1,247 @@
|
|
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
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.longrunning;
|
18
|
+
|
19
|
+
import "google/api/annotations.proto";
|
20
|
+
import "google/api/client.proto";
|
21
|
+
import "google/protobuf/any.proto";
|
22
|
+
import "google/protobuf/duration.proto";
|
23
|
+
import "google/protobuf/empty.proto";
|
24
|
+
import "google/rpc/status.proto";
|
25
|
+
import "google/protobuf/descriptor.proto";
|
26
|
+
|
27
|
+
option cc_enable_arenas = true;
|
28
|
+
option csharp_namespace = "Google.LongRunning";
|
29
|
+
option go_package = "google.golang.org/genproto/googleapis/longrunning;longrunning";
|
30
|
+
option java_multiple_files = true;
|
31
|
+
option java_outer_classname = "OperationsProto";
|
32
|
+
option java_package = "com.google.longrunning";
|
33
|
+
option php_namespace = "Google\\LongRunning";
|
34
|
+
|
35
|
+
extend google.protobuf.MethodOptions {
|
36
|
+
// Additional information regarding long-running operations.
|
37
|
+
// In particular, this specifies the types that are returned from
|
38
|
+
// long-running operations.
|
39
|
+
//
|
40
|
+
// Required for methods that return `google.longrunning.Operation`; invalid
|
41
|
+
// otherwise.
|
42
|
+
google.longrunning.OperationInfo operation_info = 1049;
|
43
|
+
}
|
44
|
+
|
45
|
+
// Manages long-running operations with an API service.
|
46
|
+
//
|
47
|
+
// When an API method normally takes long time to complete, it can be designed
|
48
|
+
// to return [Operation][google.longrunning.Operation] to the client, and the client can use this
|
49
|
+
// interface to receive the real response asynchronously by polling the
|
50
|
+
// operation resource, or pass the operation resource to another API (such as
|
51
|
+
// Google Cloud Pub/Sub API) to receive the response. Any API service that
|
52
|
+
// returns long-running operations should implement the `Operations` interface
|
53
|
+
// so developers can have a consistent client experience.
|
54
|
+
service Operations {
|
55
|
+
option (google.api.default_host) = "longrunning.googleapis.com";
|
56
|
+
|
57
|
+
// Lists operations that match the specified filter in the request. If the
|
58
|
+
// server doesn't support this method, it returns `UNIMPLEMENTED`.
|
59
|
+
//
|
60
|
+
// NOTE: the `name` binding allows API services to override the binding
|
61
|
+
// to use different resource name schemes, such as `users/*/operations`. To
|
62
|
+
// override the binding, API services can add a binding such as
|
63
|
+
// `"/v1/{name=users/*}/operations"` to their service configuration.
|
64
|
+
// For backwards compatibility, the default name includes the operations
|
65
|
+
// collection id, however overriding users must ensure the name binding
|
66
|
+
// is the parent resource, without the operations collection id.
|
67
|
+
rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) {
|
68
|
+
option (google.api.http) = {
|
69
|
+
get: "/v1/{name=operations}"
|
70
|
+
};
|
71
|
+
option (google.api.method_signature) = "name,filter";
|
72
|
+
}
|
73
|
+
|
74
|
+
// Gets the latest state of a long-running operation. Clients can use this
|
75
|
+
// method to poll the operation result at intervals as recommended by the API
|
76
|
+
// service.
|
77
|
+
rpc GetOperation(GetOperationRequest) returns (Operation) {
|
78
|
+
option (google.api.http) = {
|
79
|
+
get: "/v1/{name=operations/**}"
|
80
|
+
};
|
81
|
+
option (google.api.method_signature) = "name";
|
82
|
+
}
|
83
|
+
|
84
|
+
// Deletes a long-running operation. This method indicates that the client is
|
85
|
+
// no longer interested in the operation result. It does not cancel the
|
86
|
+
// operation. If the server doesn't support this method, it returns
|
87
|
+
// `google.rpc.Code.UNIMPLEMENTED`.
|
88
|
+
rpc DeleteOperation(DeleteOperationRequest) returns (google.protobuf.Empty) {
|
89
|
+
option (google.api.http) = {
|
90
|
+
delete: "/v1/{name=operations/**}"
|
91
|
+
};
|
92
|
+
option (google.api.method_signature) = "name";
|
93
|
+
}
|
94
|
+
|
95
|
+
// Starts asynchronous cancellation on a long-running operation. The server
|
96
|
+
// makes a best effort to cancel the operation, but success is not
|
97
|
+
// guaranteed. If the server doesn't support this method, it returns
|
98
|
+
// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
99
|
+
// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
|
100
|
+
// other methods to check whether the cancellation succeeded or whether the
|
101
|
+
// operation completed despite cancellation. On successful cancellation,
|
102
|
+
// the operation is not deleted; instead, it becomes an operation with
|
103
|
+
// an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
|
104
|
+
// corresponding to `Code.CANCELLED`.
|
105
|
+
rpc CancelOperation(CancelOperationRequest) returns (google.protobuf.Empty) {
|
106
|
+
option (google.api.http) = {
|
107
|
+
post: "/v1/{name=operations/**}:cancel"
|
108
|
+
body: "*"
|
109
|
+
};
|
110
|
+
option (google.api.method_signature) = "name";
|
111
|
+
}
|
112
|
+
|
113
|
+
// Waits for the specified long-running operation until it is done or reaches
|
114
|
+
// at most a specified timeout, returning the latest state. If the operation
|
115
|
+
// is already done, the latest state is immediately returned. If the timeout
|
116
|
+
// specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
117
|
+
// timeout is used. If the server does not support this method, it returns
|
118
|
+
// `google.rpc.Code.UNIMPLEMENTED`.
|
119
|
+
// Note that this method is on a best-effort basis. It may return the latest
|
120
|
+
// state before the specified timeout (including immediately), meaning even an
|
121
|
+
// immediate response is no guarantee that the operation is done.
|
122
|
+
rpc WaitOperation(WaitOperationRequest) returns (Operation) {
|
123
|
+
}
|
124
|
+
}
|
125
|
+
|
126
|
+
// This resource represents a long-running operation that is the result of a
|
127
|
+
// network API call.
|
128
|
+
message Operation {
|
129
|
+
// The server-assigned name, which is only unique within the same service that
|
130
|
+
// originally returns it. If you use the default HTTP mapping, the
|
131
|
+
// `name` should be a resource name ending with `operations/{unique_id}`.
|
132
|
+
string name = 1;
|
133
|
+
|
134
|
+
// Service-specific metadata associated with the operation. It typically
|
135
|
+
// contains progress information and common metadata such as create time.
|
136
|
+
// Some services might not provide such metadata. Any method that returns a
|
137
|
+
// long-running operation should document the metadata type, if any.
|
138
|
+
google.protobuf.Any metadata = 2;
|
139
|
+
|
140
|
+
// If the value is `false`, it means the operation is still in progress.
|
141
|
+
// If `true`, the operation is completed, and either `error` or `response` is
|
142
|
+
// available.
|
143
|
+
bool done = 3;
|
144
|
+
|
145
|
+
// The operation result, which can be either an `error` or a valid `response`.
|
146
|
+
// If `done` == `false`, neither `error` nor `response` is set.
|
147
|
+
// If `done` == `true`, exactly one of `error` or `response` is set.
|
148
|
+
oneof result {
|
149
|
+
// The error result of the operation in case of failure or cancellation.
|
150
|
+
google.rpc.Status error = 4;
|
151
|
+
|
152
|
+
// The normal response of the operation in case of success. If the original
|
153
|
+
// method returns no data on success, such as `Delete`, the response is
|
154
|
+
// `google.protobuf.Empty`. If the original method is standard
|
155
|
+
// `Get`/`Create`/`Update`, the response should be the resource. For other
|
156
|
+
// methods, the response should have the type `XxxResponse`, where `Xxx`
|
157
|
+
// is the original method name. For example, if the original method name
|
158
|
+
// is `TakeSnapshot()`, the inferred response type is
|
159
|
+
// `TakeSnapshotResponse`.
|
160
|
+
google.protobuf.Any response = 5;
|
161
|
+
}
|
162
|
+
}
|
163
|
+
|
164
|
+
// The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
|
165
|
+
message GetOperationRequest {
|
166
|
+
// The name of the operation resource.
|
167
|
+
string name = 1;
|
168
|
+
}
|
169
|
+
|
170
|
+
// The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
|
171
|
+
message ListOperationsRequest {
|
172
|
+
// The name of the operation's parent resource.
|
173
|
+
string name = 4;
|
174
|
+
|
175
|
+
// The standard list filter.
|
176
|
+
string filter = 1;
|
177
|
+
|
178
|
+
// The standard list page size.
|
179
|
+
int32 page_size = 2;
|
180
|
+
|
181
|
+
// The standard list page token.
|
182
|
+
string page_token = 3;
|
183
|
+
}
|
184
|
+
|
185
|
+
// The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
|
186
|
+
message ListOperationsResponse {
|
187
|
+
// A list of operations that matches the specified filter in the request.
|
188
|
+
repeated Operation operations = 1;
|
189
|
+
|
190
|
+
// The standard List next-page token.
|
191
|
+
string next_page_token = 2;
|
192
|
+
}
|
193
|
+
|
194
|
+
// The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
|
195
|
+
message CancelOperationRequest {
|
196
|
+
// The name of the operation resource to be cancelled.
|
197
|
+
string name = 1;
|
198
|
+
}
|
199
|
+
|
200
|
+
// The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
|
201
|
+
message DeleteOperationRequest {
|
202
|
+
// The name of the operation resource to be deleted.
|
203
|
+
string name = 1;
|
204
|
+
}
|
205
|
+
|
206
|
+
// The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].
|
207
|
+
message WaitOperationRequest {
|
208
|
+
// The name of the operation resource to wait on.
|
209
|
+
string name = 1;
|
210
|
+
|
211
|
+
// The maximum duration to wait before timing out. If left blank, the wait
|
212
|
+
// will be at most the time permitted by the underlying HTTP/RPC protocol.
|
213
|
+
// If RPC context deadline is also specified, the shorter one will be used.
|
214
|
+
google.protobuf.Duration timeout = 2;
|
215
|
+
}
|
216
|
+
|
217
|
+
// A message representing the message types used by a long-running operation.
|
218
|
+
//
|
219
|
+
// Example:
|
220
|
+
//
|
221
|
+
// rpc LongRunningRecognize(LongRunningRecognizeRequest)
|
222
|
+
// returns (google.longrunning.Operation) {
|
223
|
+
// option (google.longrunning.operation_info) = {
|
224
|
+
// response_type: "LongRunningRecognizeResponse"
|
225
|
+
// metadata_type: "LongRunningRecognizeMetadata"
|
226
|
+
// };
|
227
|
+
// }
|
228
|
+
message OperationInfo {
|
229
|
+
// Required. The message name of the primary return type for this
|
230
|
+
// long-running operation.
|
231
|
+
// This type will be used to deserialize the LRO's response.
|
232
|
+
//
|
233
|
+
// If the response is in a different package from the rpc, a fully-qualified
|
234
|
+
// message name must be used (e.g. `google.protobuf.Struct`).
|
235
|
+
//
|
236
|
+
// Note: Altering this value constitutes a breaking change.
|
237
|
+
string response_type = 1;
|
238
|
+
|
239
|
+
// Required. The message name of the metadata type for this long-running
|
240
|
+
// operation.
|
241
|
+
//
|
242
|
+
// If the response is in a different package from the rpc, a fully-qualified
|
243
|
+
// message name must be used (e.g. `google.protobuf.Struct`).
|
244
|
+
//
|
245
|
+
// Note: Altering this value constitutes a breaking change.
|
246
|
+
string metadata_type = 2;
|
247
|
+
}
|
@@ -0,0 +1,158 @@
|
|
1
|
+
// Protocol Buffers - Google's data interchange format
|
2
|
+
// Copyright 2008 Google Inc. All rights reserved.
|
3
|
+
// https://developers.google.com/protocol-buffers/
|
4
|
+
//
|
5
|
+
// Redistribution and use in source and binary forms, with or without
|
6
|
+
// modification, are permitted provided that the following conditions are
|
7
|
+
// met:
|
8
|
+
//
|
9
|
+
// * Redistributions of source code must retain the above copyright
|
10
|
+
// notice, this list of conditions and the following disclaimer.
|
11
|
+
// * Redistributions in binary form must reproduce the above
|
12
|
+
// copyright notice, this list of conditions and the following disclaimer
|
13
|
+
// in the documentation and/or other materials provided with the
|
14
|
+
// distribution.
|
15
|
+
// * Neither the name of Google Inc. nor the names of its
|
16
|
+
// contributors may be used to endorse or promote products derived from
|
17
|
+
// this software without specific prior written permission.
|
18
|
+
//
|
19
|
+
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
20
|
+
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
21
|
+
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
22
|
+
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
23
|
+
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
24
|
+
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
25
|
+
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
26
|
+
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
27
|
+
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
28
|
+
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
29
|
+
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
30
|
+
|
31
|
+
syntax = "proto3";
|
32
|
+
|
33
|
+
package google.protobuf;
|
34
|
+
|
35
|
+
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
36
|
+
option go_package = "google.golang.org/protobuf/types/known/anypb";
|
37
|
+
option java_package = "com.google.protobuf";
|
38
|
+
option java_outer_classname = "AnyProto";
|
39
|
+
option java_multiple_files = true;
|
40
|
+
option objc_class_prefix = "GPB";
|
41
|
+
|
42
|
+
// `Any` contains an arbitrary serialized protocol buffer message along with a
|
43
|
+
// URL that describes the type of the serialized message.
|
44
|
+
//
|
45
|
+
// Protobuf library provides support to pack/unpack Any values in the form
|
46
|
+
// of utility functions or additional generated methods of the Any type.
|
47
|
+
//
|
48
|
+
// Example 1: Pack and unpack a message in C++.
|
49
|
+
//
|
50
|
+
// Foo foo = ...;
|
51
|
+
// Any any;
|
52
|
+
// any.PackFrom(foo);
|
53
|
+
// ...
|
54
|
+
// if (any.UnpackTo(&foo)) {
|
55
|
+
// ...
|
56
|
+
// }
|
57
|
+
//
|
58
|
+
// Example 2: Pack and unpack a message in Java.
|
59
|
+
//
|
60
|
+
// Foo foo = ...;
|
61
|
+
// Any any = Any.pack(foo);
|
62
|
+
// ...
|
63
|
+
// if (any.is(Foo.class)) {
|
64
|
+
// foo = any.unpack(Foo.class);
|
65
|
+
// }
|
66
|
+
//
|
67
|
+
// Example 3: Pack and unpack a message in Python.
|
68
|
+
//
|
69
|
+
// foo = Foo(...)
|
70
|
+
// any = Any()
|
71
|
+
// any.Pack(foo)
|
72
|
+
// ...
|
73
|
+
// if any.Is(Foo.DESCRIPTOR):
|
74
|
+
// any.Unpack(foo)
|
75
|
+
// ...
|
76
|
+
//
|
77
|
+
// Example 4: Pack and unpack a message in Go
|
78
|
+
//
|
79
|
+
// foo := &pb.Foo{...}
|
80
|
+
// any, err := anypb.New(foo)
|
81
|
+
// if err != nil {
|
82
|
+
// ...
|
83
|
+
// }
|
84
|
+
// ...
|
85
|
+
// foo := &pb.Foo{}
|
86
|
+
// if err := any.UnmarshalTo(foo); err != nil {
|
87
|
+
// ...
|
88
|
+
// }
|
89
|
+
//
|
90
|
+
// The pack methods provided by protobuf library will by default use
|
91
|
+
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
92
|
+
// methods only use the fully qualified type name after the last '/'
|
93
|
+
// in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
94
|
+
// name "y.z".
|
95
|
+
//
|
96
|
+
//
|
97
|
+
// JSON
|
98
|
+
//
|
99
|
+
// The JSON representation of an `Any` value uses the regular
|
100
|
+
// representation of the deserialized, embedded message, with an
|
101
|
+
// additional field `@type` which contains the type URL. Example:
|
102
|
+
//
|
103
|
+
// package google.profile;
|
104
|
+
// message Person {
|
105
|
+
// string first_name = 1;
|
106
|
+
// string last_name = 2;
|
107
|
+
// }
|
108
|
+
//
|
109
|
+
// {
|
110
|
+
// "@type": "type.googleapis.com/google.profile.Person",
|
111
|
+
// "firstName": <string>,
|
112
|
+
// "lastName": <string>
|
113
|
+
// }
|
114
|
+
//
|
115
|
+
// If the embedded message type is well-known and has a custom JSON
|
116
|
+
// representation, that representation will be embedded adding a field
|
117
|
+
// `value` which holds the custom JSON in addition to the `@type`
|
118
|
+
// field. Example (for message [google.protobuf.Duration][]):
|
119
|
+
//
|
120
|
+
// {
|
121
|
+
// "@type": "type.googleapis.com/google.protobuf.Duration",
|
122
|
+
// "value": "1.212s"
|
123
|
+
// }
|
124
|
+
//
|
125
|
+
message Any {
|
126
|
+
// A URL/resource name that uniquely identifies the type of the serialized
|
127
|
+
// protocol buffer message. This string must contain at least
|
128
|
+
// one "/" character. The last segment of the URL's path must represent
|
129
|
+
// the fully qualified name of the type (as in
|
130
|
+
// `path/google.protobuf.Duration`). The name should be in a canonical form
|
131
|
+
// (e.g., leading "." is not accepted).
|
132
|
+
//
|
133
|
+
// In practice, teams usually precompile into the binary all types that they
|
134
|
+
// expect it to use in the context of Any. However, for URLs which use the
|
135
|
+
// scheme `http`, `https`, or no scheme, one can optionally set up a type
|
136
|
+
// server that maps type URLs to message definitions as follows:
|
137
|
+
//
|
138
|
+
// * If no scheme is provided, `https` is assumed.
|
139
|
+
// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
140
|
+
// value in binary format, or produce an error.
|
141
|
+
// * Applications are allowed to cache lookup results based on the
|
142
|
+
// URL, or have them precompiled into a binary to avoid any
|
143
|
+
// lookup. Therefore, binary compatibility needs to be preserved
|
144
|
+
// on changes to types. (Use versioned type names to manage
|
145
|
+
// breaking changes.)
|
146
|
+
//
|
147
|
+
// Note: this functionality is not currently available in the official
|
148
|
+
// protobuf release, and it is not used for type URLs beginning with
|
149
|
+
// type.googleapis.com.
|
150
|
+
//
|
151
|
+
// Schemes other than `http`, `https` (or the empty scheme) might be
|
152
|
+
// used with implementation specific semantics.
|
153
|
+
//
|
154
|
+
string type_url = 1;
|
155
|
+
|
156
|
+
// Must be a valid serialized protocol buffer of the above specified type.
|
157
|
+
bytes value = 2;
|
158
|
+
}
|
@@ -0,0 +1,208 @@
|
|
1
|
+
// Protocol Buffers - Google's data interchange format
|
2
|
+
// Copyright 2008 Google Inc. All rights reserved.
|
3
|
+
// https://developers.google.com/protocol-buffers/
|
4
|
+
//
|
5
|
+
// Redistribution and use in source and binary forms, with or without
|
6
|
+
// modification, are permitted provided that the following conditions are
|
7
|
+
// met:
|
8
|
+
//
|
9
|
+
// * Redistributions of source code must retain the above copyright
|
10
|
+
// notice, this list of conditions and the following disclaimer.
|
11
|
+
// * Redistributions in binary form must reproduce the above
|
12
|
+
// copyright notice, this list of conditions and the following disclaimer
|
13
|
+
// in the documentation and/or other materials provided with the
|
14
|
+
// distribution.
|
15
|
+
// * Neither the name of Google Inc. nor the names of its
|
16
|
+
// contributors may be used to endorse or promote products derived from
|
17
|
+
// this software without specific prior written permission.
|
18
|
+
//
|
19
|
+
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
20
|
+
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
21
|
+
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
22
|
+
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
23
|
+
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
24
|
+
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
25
|
+
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
26
|
+
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
27
|
+
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
28
|
+
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
29
|
+
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
30
|
+
|
31
|
+
syntax = "proto3";
|
32
|
+
|
33
|
+
package google.protobuf;
|
34
|
+
|
35
|
+
import "google/protobuf/source_context.proto";
|
36
|
+
import "google/protobuf/type.proto";
|
37
|
+
|
38
|
+
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
39
|
+
option java_package = "com.google.protobuf";
|
40
|
+
option java_outer_classname = "ApiProto";
|
41
|
+
option java_multiple_files = true;
|
42
|
+
option objc_class_prefix = "GPB";
|
43
|
+
option go_package = "google.golang.org/protobuf/types/known/apipb";
|
44
|
+
|
45
|
+
// Api is a light-weight descriptor for an API Interface.
|
46
|
+
//
|
47
|
+
// Interfaces are also described as "protocol buffer services" in some contexts,
|
48
|
+
// such as by the "service" keyword in a .proto file, but they are different
|
49
|
+
// from API Services, which represent a concrete implementation of an interface
|
50
|
+
// as opposed to simply a description of methods and bindings. They are also
|
51
|
+
// sometimes simply referred to as "APIs" in other contexts, such as the name of
|
52
|
+
// this message itself. See https://cloud.google.com/apis/design/glossary for
|
53
|
+
// detailed terminology.
|
54
|
+
message Api {
|
55
|
+
// The fully qualified name of this interface, including package name
|
56
|
+
// followed by the interface's simple name.
|
57
|
+
string name = 1;
|
58
|
+
|
59
|
+
// The methods of this interface, in unspecified order.
|
60
|
+
repeated Method methods = 2;
|
61
|
+
|
62
|
+
// Any metadata attached to the interface.
|
63
|
+
repeated Option options = 3;
|
64
|
+
|
65
|
+
// A version string for this interface. If specified, must have the form
|
66
|
+
// `major-version.minor-version`, as in `1.10`. If the minor version is
|
67
|
+
// omitted, it defaults to zero. If the entire version field is empty, the
|
68
|
+
// major version is derived from the package name, as outlined below. If the
|
69
|
+
// field is not empty, the version in the package name will be verified to be
|
70
|
+
// consistent with what is provided here.
|
71
|
+
//
|
72
|
+
// The versioning schema uses [semantic
|
73
|
+
// versioning](http://semver.org) where the major version number
|
74
|
+
// indicates a breaking change and the minor version an additive,
|
75
|
+
// non-breaking change. Both version numbers are signals to users
|
76
|
+
// what to expect from different versions, and should be carefully
|
77
|
+
// chosen based on the product plan.
|
78
|
+
//
|
79
|
+
// The major version is also reflected in the package name of the
|
80
|
+
// interface, which must end in `v<major-version>`, as in
|
81
|
+
// `google.feature.v1`. For major versions 0 and 1, the suffix can
|
82
|
+
// be omitted. Zero major versions must only be used for
|
83
|
+
// experimental, non-GA interfaces.
|
84
|
+
//
|
85
|
+
//
|
86
|
+
string version = 4;
|
87
|
+
|
88
|
+
// Source context for the protocol buffer service represented by this
|
89
|
+
// message.
|
90
|
+
SourceContext source_context = 5;
|
91
|
+
|
92
|
+
// Included interfaces. See [Mixin][].
|
93
|
+
repeated Mixin mixins = 6;
|
94
|
+
|
95
|
+
// The source syntax of the service.
|
96
|
+
Syntax syntax = 7;
|
97
|
+
}
|
98
|
+
|
99
|
+
// Method represents a method of an API interface.
|
100
|
+
message Method {
|
101
|
+
// The simple name of this method.
|
102
|
+
string name = 1;
|
103
|
+
|
104
|
+
// A URL of the input message type.
|
105
|
+
string request_type_url = 2;
|
106
|
+
|
107
|
+
// If true, the request is streamed.
|
108
|
+
bool request_streaming = 3;
|
109
|
+
|
110
|
+
// The URL of the output message type.
|
111
|
+
string response_type_url = 4;
|
112
|
+
|
113
|
+
// If true, the response is streamed.
|
114
|
+
bool response_streaming = 5;
|
115
|
+
|
116
|
+
// Any metadata attached to the method.
|
117
|
+
repeated Option options = 6;
|
118
|
+
|
119
|
+
// The source syntax of this method.
|
120
|
+
Syntax syntax = 7;
|
121
|
+
}
|
122
|
+
|
123
|
+
// Declares an API Interface to be included in this interface. The including
|
124
|
+
// interface must redeclare all the methods from the included interface, but
|
125
|
+
// documentation and options are inherited as follows:
|
126
|
+
//
|
127
|
+
// - If after comment and whitespace stripping, the documentation
|
128
|
+
// string of the redeclared method is empty, it will be inherited
|
129
|
+
// from the original method.
|
130
|
+
//
|
131
|
+
// - Each annotation belonging to the service config (http,
|
132
|
+
// visibility) which is not set in the redeclared method will be
|
133
|
+
// inherited.
|
134
|
+
//
|
135
|
+
// - If an http annotation is inherited, the path pattern will be
|
136
|
+
// modified as follows. Any version prefix will be replaced by the
|
137
|
+
// version of the including interface plus the [root][] path if
|
138
|
+
// specified.
|
139
|
+
//
|
140
|
+
// Example of a simple mixin:
|
141
|
+
//
|
142
|
+
// package google.acl.v1;
|
143
|
+
// service AccessControl {
|
144
|
+
// // Get the underlying ACL object.
|
145
|
+
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
146
|
+
// option (google.api.http).get = "/v1/{resource=**}:getAcl";
|
147
|
+
// }
|
148
|
+
// }
|
149
|
+
//
|
150
|
+
// package google.storage.v2;
|
151
|
+
// service Storage {
|
152
|
+
// rpc GetAcl(GetAclRequest) returns (Acl);
|
153
|
+
//
|
154
|
+
// // Get a data record.
|
155
|
+
// rpc GetData(GetDataRequest) returns (Data) {
|
156
|
+
// option (google.api.http).get = "/v2/{resource=**}";
|
157
|
+
// }
|
158
|
+
// }
|
159
|
+
//
|
160
|
+
// Example of a mixin configuration:
|
161
|
+
//
|
162
|
+
// apis:
|
163
|
+
// - name: google.storage.v2.Storage
|
164
|
+
// mixins:
|
165
|
+
// - name: google.acl.v1.AccessControl
|
166
|
+
//
|
167
|
+
// The mixin construct implies that all methods in `AccessControl` are
|
168
|
+
// also declared with same name and request/response types in
|
169
|
+
// `Storage`. A documentation generator or annotation processor will
|
170
|
+
// see the effective `Storage.GetAcl` method after inheriting
|
171
|
+
// documentation and annotations as follows:
|
172
|
+
//
|
173
|
+
// service Storage {
|
174
|
+
// // Get the underlying ACL object.
|
175
|
+
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
176
|
+
// option (google.api.http).get = "/v2/{resource=**}:getAcl";
|
177
|
+
// }
|
178
|
+
// ...
|
179
|
+
// }
|
180
|
+
//
|
181
|
+
// Note how the version in the path pattern changed from `v1` to `v2`.
|
182
|
+
//
|
183
|
+
// If the `root` field in the mixin is specified, it should be a
|
184
|
+
// relative path under which inherited HTTP paths are placed. Example:
|
185
|
+
//
|
186
|
+
// apis:
|
187
|
+
// - name: google.storage.v2.Storage
|
188
|
+
// mixins:
|
189
|
+
// - name: google.acl.v1.AccessControl
|
190
|
+
// root: acls
|
191
|
+
//
|
192
|
+
// This implies the following inherited HTTP annotation:
|
193
|
+
//
|
194
|
+
// service Storage {
|
195
|
+
// // Get the underlying ACL object.
|
196
|
+
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
197
|
+
// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
|
198
|
+
// }
|
199
|
+
// ...
|
200
|
+
// }
|
201
|
+
message Mixin {
|
202
|
+
// The fully qualified name of the interface which is included.
|
203
|
+
string name = 1;
|
204
|
+
|
205
|
+
// If non-empty specifies a path under which inherited HTTP paths
|
206
|
+
// are rooted.
|
207
|
+
string root = 2;
|
208
|
+
}
|