google-cloud-pubsub-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-pubsub-v1.rb +21 -0
- data/lib/google/cloud/pubsub/v1.rb +37 -0
- data/lib/google/cloud/pubsub/v1/iam_policy.rb +72 -0
- data/lib/google/cloud/pubsub/v1/iam_policy/client.rb +562 -0
- data/lib/google/cloud/pubsub/v1/iam_policy/credentials.rb +52 -0
- data/lib/google/cloud/pubsub/v1/publisher.rb +50 -0
- data/lib/google/cloud/pubsub/v1/publisher/client.rb +1093 -0
- data/lib/google/cloud/pubsub/v1/publisher/credentials.rb +52 -0
- data/lib/google/cloud/pubsub/v1/publisher/helpers.rb +23 -0
- data/lib/google/cloud/pubsub/v1/publisher/paths.rb +98 -0
- data/lib/google/cloud/pubsub/v1/subscriber.rb +51 -0
- data/lib/google/cloud/pubsub/v1/subscriber/client.rb +1861 -0
- data/lib/google/cloud/pubsub/v1/subscriber/credentials.rb +52 -0
- data/lib/google/cloud/pubsub/v1/subscriber/helpers.rb +23 -0
- data/lib/google/cloud/pubsub/v1/subscriber/paths.rb +115 -0
- data/lib/google/cloud/pubsub/v1/version.rb +28 -0
- data/lib/google/iam/v1/iam_policy_services_pb.rb +81 -0
- data/lib/google/pubsub/v1/pubsub_pb.rb +269 -0
- data/lib/google/pubsub/v1/pubsub_services_pb.rb +213 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
- data/proto_docs/google/iam/v1/options.rb +40 -0
- data/proto_docs/google/iam/v1/policy.rb +248 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/pubsub/v1/pubsub.rb +1023 -0
- data/proto_docs/google/type/expr.rb +52 -0
- metadata +238 -0
@@ -0,0 +1,213 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/pubsub/v1/pubsub.proto for package 'Google.Cloud.PubSub.V1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2020 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/pubsub/v1/pubsub_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module PubSub
|
25
|
+
module V1
|
26
|
+
module Publisher
|
27
|
+
# The service that an application uses to manipulate topics, and to send
|
28
|
+
# messages to a topic.
|
29
|
+
class Service
|
30
|
+
|
31
|
+
include GRPC::GenericService
|
32
|
+
|
33
|
+
self.marshal_class_method = :encode
|
34
|
+
self.unmarshal_class_method = :decode
|
35
|
+
self.service_name = 'google.pubsub.v1.Publisher'
|
36
|
+
|
37
|
+
# Creates the given topic with the given name. See the
|
38
|
+
# <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
|
39
|
+
# resource name rules</a>.
|
40
|
+
rpc :CreateTopic, Google::Cloud::PubSub::V1::Topic, Google::Cloud::PubSub::V1::Topic
|
41
|
+
# Updates an existing topic. Note that certain properties of a
|
42
|
+
# topic are not modifiable.
|
43
|
+
rpc :UpdateTopic, Google::Cloud::PubSub::V1::UpdateTopicRequest, Google::Cloud::PubSub::V1::Topic
|
44
|
+
# Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
|
45
|
+
# does not exist.
|
46
|
+
rpc :Publish, Google::Cloud::PubSub::V1::PublishRequest, Google::Cloud::PubSub::V1::PublishResponse
|
47
|
+
# Gets the configuration of a topic.
|
48
|
+
rpc :GetTopic, Google::Cloud::PubSub::V1::GetTopicRequest, Google::Cloud::PubSub::V1::Topic
|
49
|
+
# Lists matching topics.
|
50
|
+
rpc :ListTopics, Google::Cloud::PubSub::V1::ListTopicsRequest, Google::Cloud::PubSub::V1::ListTopicsResponse
|
51
|
+
# Lists the names of the attached subscriptions on this topic.
|
52
|
+
rpc :ListTopicSubscriptions, Google::Cloud::PubSub::V1::ListTopicSubscriptionsRequest, Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse
|
53
|
+
# Lists the names of the snapshots on this topic. Snapshots are used in
|
54
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
55
|
+
# operations, which allow
|
56
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
57
|
+
# acknowledgment state of messages in an existing subscription to the state
|
58
|
+
# captured by a snapshot.
|
59
|
+
rpc :ListTopicSnapshots, Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest, Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse
|
60
|
+
# Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
|
61
|
+
# does not exist. After a topic is deleted, a new topic may be created with
|
62
|
+
# the same name; this is an entirely new topic with none of the old
|
63
|
+
# configuration or subscriptions. Existing subscriptions to this topic are
|
64
|
+
# not deleted, but their `topic` field is set to `_deleted-topic_`.
|
65
|
+
rpc :DeleteTopic, Google::Cloud::PubSub::V1::DeleteTopicRequest, Google::Protobuf::Empty
|
66
|
+
# Detaches a subscription from this topic. All messages retained in the
|
67
|
+
# subscription are dropped. Subsequent `Pull` and `StreamingPull` requests
|
68
|
+
# will return FAILED_PRECONDITION. If the subscription is a push
|
69
|
+
# subscription, pushes to the endpoint will stop.
|
70
|
+
rpc :DetachSubscription, Google::Cloud::PubSub::V1::DetachSubscriptionRequest, Google::Cloud::PubSub::V1::DetachSubscriptionResponse
|
71
|
+
end
|
72
|
+
|
73
|
+
Stub = Service.rpc_stub_class
|
74
|
+
end
|
75
|
+
module Subscriber
|
76
|
+
# The service that an application uses to manipulate subscriptions and to
|
77
|
+
# consume messages from a subscription via the `Pull` method or by
|
78
|
+
# establishing a bi-directional stream using the `StreamingPull` method.
|
79
|
+
class Service
|
80
|
+
|
81
|
+
include GRPC::GenericService
|
82
|
+
|
83
|
+
self.marshal_class_method = :encode
|
84
|
+
self.unmarshal_class_method = :decode
|
85
|
+
self.service_name = 'google.pubsub.v1.Subscriber'
|
86
|
+
|
87
|
+
# Creates a subscription to a given topic. See the
|
88
|
+
# <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
|
89
|
+
# resource name rules</a>.
|
90
|
+
# If the subscription already exists, returns `ALREADY_EXISTS`.
|
91
|
+
# If the corresponding topic doesn't exist, returns `NOT_FOUND`.
|
92
|
+
#
|
93
|
+
# If the name is not provided in the request, the server will assign a random
|
94
|
+
# name for this subscription on the same project as the topic, conforming
|
95
|
+
# to the
|
96
|
+
# [resource name
|
97
|
+
# format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
|
98
|
+
# generated name is populated in the returned Subscription object. Note that
|
99
|
+
# for REST API requests, you must specify a name in the request.
|
100
|
+
rpc :CreateSubscription, Google::Cloud::PubSub::V1::Subscription, Google::Cloud::PubSub::V1::Subscription
|
101
|
+
# Gets the configuration details of a subscription.
|
102
|
+
rpc :GetSubscription, Google::Cloud::PubSub::V1::GetSubscriptionRequest, Google::Cloud::PubSub::V1::Subscription
|
103
|
+
# Updates an existing subscription. Note that certain properties of a
|
104
|
+
# subscription, such as its topic, are not modifiable.
|
105
|
+
rpc :UpdateSubscription, Google::Cloud::PubSub::V1::UpdateSubscriptionRequest, Google::Cloud::PubSub::V1::Subscription
|
106
|
+
# Lists matching subscriptions.
|
107
|
+
rpc :ListSubscriptions, Google::Cloud::PubSub::V1::ListSubscriptionsRequest, Google::Cloud::PubSub::V1::ListSubscriptionsResponse
|
108
|
+
# Deletes an existing subscription. All messages retained in the subscription
|
109
|
+
# are immediately dropped. Calls to `Pull` after deletion will return
|
110
|
+
# `NOT_FOUND`. After a subscription is deleted, a new one may be created with
|
111
|
+
# the same name, but the new one has no association with the old
|
112
|
+
# subscription or its topic unless the same topic is specified.
|
113
|
+
rpc :DeleteSubscription, Google::Cloud::PubSub::V1::DeleteSubscriptionRequest, Google::Protobuf::Empty
|
114
|
+
# Modifies the ack deadline for a specific message. This method is useful
|
115
|
+
# to indicate that more time is needed to process a message by the
|
116
|
+
# subscriber, or to make the message available for redelivery if the
|
117
|
+
# processing was interrupted. Note that this does not modify the
|
118
|
+
# subscription-level `ackDeadlineSeconds` used for subsequent messages.
|
119
|
+
rpc :ModifyAckDeadline, Google::Cloud::PubSub::V1::ModifyAckDeadlineRequest, Google::Protobuf::Empty
|
120
|
+
# Acknowledges the messages associated with the `ack_ids` in the
|
121
|
+
# `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
|
122
|
+
# from the subscription.
|
123
|
+
#
|
124
|
+
# Acknowledging a message whose ack deadline has expired may succeed,
|
125
|
+
# but such a message may be redelivered later. Acknowledging a message more
|
126
|
+
# than once will not result in an error.
|
127
|
+
rpc :Acknowledge, Google::Cloud::PubSub::V1::AcknowledgeRequest, Google::Protobuf::Empty
|
128
|
+
# Pulls messages from the server. The server may return `UNAVAILABLE` if
|
129
|
+
# there are too many concurrent pull requests pending for the given
|
130
|
+
# subscription.
|
131
|
+
rpc :Pull, Google::Cloud::PubSub::V1::PullRequest, Google::Cloud::PubSub::V1::PullResponse
|
132
|
+
# Establishes a stream with the server, which sends messages down to the
|
133
|
+
# client. The client streams acknowledgements and ack deadline modifications
|
134
|
+
# back to the server. The server will close the stream and return the status
|
135
|
+
# on any error. The server may close the stream with status `UNAVAILABLE` to
|
136
|
+
# reassign server-side resources, in which case, the client should
|
137
|
+
# re-establish the stream. Flow control can be achieved by configuring the
|
138
|
+
# underlying RPC channel.
|
139
|
+
rpc :StreamingPull, stream(Google::Cloud::PubSub::V1::StreamingPullRequest), stream(Google::Cloud::PubSub::V1::StreamingPullResponse)
|
140
|
+
# Modifies the `PushConfig` for a specified subscription.
|
141
|
+
#
|
142
|
+
# This may be used to change a push subscription to a pull one (signified by
|
143
|
+
# an empty `PushConfig`) or vice versa, or change the endpoint URL and other
|
144
|
+
# attributes of a push subscription. Messages will accumulate for delivery
|
145
|
+
# continuously through the call regardless of changes to the `PushConfig`.
|
146
|
+
rpc :ModifyPushConfig, Google::Cloud::PubSub::V1::ModifyPushConfigRequest, Google::Protobuf::Empty
|
147
|
+
# Gets the configuration details of a snapshot. Snapshots are used in
|
148
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
149
|
+
# operations, which allow you to manage message acknowledgments in bulk. That
|
150
|
+
# is, you can set the acknowledgment state of messages in an existing
|
151
|
+
# subscription to the state captured by a snapshot.
|
152
|
+
rpc :GetSnapshot, Google::Cloud::PubSub::V1::GetSnapshotRequest, Google::Cloud::PubSub::V1::Snapshot
|
153
|
+
# Lists the existing snapshots. Snapshots are used in
|
154
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
155
|
+
# operations, which allow
|
156
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
157
|
+
# acknowledgment state of messages in an existing subscription to the state
|
158
|
+
# captured by a snapshot.
|
159
|
+
rpc :ListSnapshots, Google::Cloud::PubSub::V1::ListSnapshotsRequest, Google::Cloud::PubSub::V1::ListSnapshotsResponse
|
160
|
+
# Creates a snapshot from the requested subscription. Snapshots are used in
|
161
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
162
|
+
# operations, which allow
|
163
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
164
|
+
# acknowledgment state of messages in an existing subscription to the state
|
165
|
+
# captured by a snapshot.
|
166
|
+
# <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`.
|
167
|
+
# If the requested subscription doesn't exist, returns `NOT_FOUND`.
|
168
|
+
# If the backlog in the subscription is too old -- and the resulting snapshot
|
169
|
+
# would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
|
170
|
+
# See also the `Snapshot.expire_time` field. If the name is not provided in
|
171
|
+
# the request, the server will assign a random
|
172
|
+
# name for this snapshot on the same project as the subscription, conforming
|
173
|
+
# to the
|
174
|
+
# [resource name
|
175
|
+
# format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
|
176
|
+
# generated name is populated in the returned Snapshot object. Note that for
|
177
|
+
# REST API requests, you must specify a name in the request.
|
178
|
+
rpc :CreateSnapshot, Google::Cloud::PubSub::V1::CreateSnapshotRequest, Google::Cloud::PubSub::V1::Snapshot
|
179
|
+
# Updates an existing snapshot. Snapshots are used in
|
180
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
181
|
+
# operations, which allow
|
182
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
183
|
+
# acknowledgment state of messages in an existing subscription to the state
|
184
|
+
# captured by a snapshot.
|
185
|
+
rpc :UpdateSnapshot, Google::Cloud::PubSub::V1::UpdateSnapshotRequest, Google::Cloud::PubSub::V1::Snapshot
|
186
|
+
# Removes an existing snapshot. Snapshots are used in
|
187
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
188
|
+
# operations, which allow
|
189
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
190
|
+
# acknowledgment state of messages in an existing subscription to the state
|
191
|
+
# captured by a snapshot.<br><br>
|
192
|
+
# When the snapshot is deleted, all messages retained in the snapshot
|
193
|
+
# are immediately dropped. After a snapshot is deleted, a new one may be
|
194
|
+
# created with the same name, but the new one has no association with the old
|
195
|
+
# snapshot or its subscription, unless the same subscription is specified.
|
196
|
+
rpc :DeleteSnapshot, Google::Cloud::PubSub::V1::DeleteSnapshotRequest, Google::Protobuf::Empty
|
197
|
+
# Seeks an existing subscription to a point in time or to a given snapshot,
|
198
|
+
# whichever is provided in the request. Snapshots are used in
|
199
|
+
# <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
|
200
|
+
# operations, which allow
|
201
|
+
# you to manage message acknowledgments in bulk. That is, you can set the
|
202
|
+
# acknowledgment state of messages in an existing subscription to the state
|
203
|
+
# captured by a snapshot. Note that both the subscription and the snapshot
|
204
|
+
# must be on the same topic.
|
205
|
+
rpc :Seek, Google::Cloud::PubSub::V1::SeekRequest, Google::Cloud::PubSub::V1::SeekResponse
|
206
|
+
end
|
207
|
+
|
208
|
+
Stub = Service.rpc_stub_class
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# An indicator of the behavior of a given field (for example, that a field
|
23
|
+
# is required in requests, or given as output but ignored as input).
|
24
|
+
# This **does not** change the behavior in protocol buffers itself; it only
|
25
|
+
# denotes the behavior and may affect how API tooling handles the field.
|
26
|
+
#
|
27
|
+
# Note: This enum **may** receive new values in the future.
|
28
|
+
module FieldBehavior
|
29
|
+
# Conventional default for enums. Do not use this.
|
30
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0
|
31
|
+
|
32
|
+
# Specifically denotes a field as optional.
|
33
|
+
# While all fields in protocol buffers are optional, this may be specified
|
34
|
+
# for emphasis if appropriate.
|
35
|
+
OPTIONAL = 1
|
36
|
+
|
37
|
+
# Denotes a field as required.
|
38
|
+
# This indicates that the field **must** be provided as part of the request,
|
39
|
+
# and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
40
|
+
REQUIRED = 2
|
41
|
+
|
42
|
+
# Denotes a field as output only.
|
43
|
+
# This indicates that the field is provided in responses, but including the
|
44
|
+
# field in a request does nothing (the server *must* ignore it and
|
45
|
+
# *must not* throw an error as a result of the field's presence).
|
46
|
+
OUTPUT_ONLY = 3
|
47
|
+
|
48
|
+
# Denotes a field as input only.
|
49
|
+
# This indicates that the field is provided in requests, and the
|
50
|
+
# corresponding field is not included in output.
|
51
|
+
INPUT_ONLY = 4
|
52
|
+
|
53
|
+
# Denotes a field as immutable.
|
54
|
+
# This indicates that the field may be set once in a request to create a
|
55
|
+
# resource, but may not be changed thereafter.
|
56
|
+
IMMUTABLE = 5
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,247 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# A simple descriptor of a resource type.
|
23
|
+
#
|
24
|
+
# ResourceDescriptor annotates a resource message (either by means of a
|
25
|
+
# protobuf annotation or use in the service config), and associates the
|
26
|
+
# resource's schema, the resource type, and the pattern of the resource name.
|
27
|
+
#
|
28
|
+
# Example:
|
29
|
+
#
|
30
|
+
# message Topic {
|
31
|
+
# // Indicates this message defines a resource schema.
|
32
|
+
# // Declares the resource type in the format of {service}/{kind}.
|
33
|
+
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
|
+
# option (google.api.resource) = {
|
35
|
+
# type: "pubsub.googleapis.com/Topic"
|
36
|
+
# name_descriptor: {
|
37
|
+
# pattern: "projects/{project}/topics/{topic}"
|
38
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
+
# parent_name_extractor: "projects/{project}"
|
40
|
+
# }
|
41
|
+
# };
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# The ResourceDescriptor Yaml config will look like:
|
45
|
+
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/\\{project}/topics/\\{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/\\{project}"
|
52
|
+
#
|
53
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
54
|
+
# live under multiple parents.
|
55
|
+
#
|
56
|
+
# Example:
|
57
|
+
#
|
58
|
+
# message LogEntry {
|
59
|
+
# option (google.api.resource) = {
|
60
|
+
# type: "logging.googleapis.com/LogEntry"
|
61
|
+
# name_descriptor: {
|
62
|
+
# pattern: "projects/{project}/logs/{log}"
|
63
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
64
|
+
# parent_name_extractor: "projects/{project}"
|
65
|
+
# }
|
66
|
+
# name_descriptor: {
|
67
|
+
# pattern: "folders/{folder}/logs/{log}"
|
68
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
+
# parent_name_extractor: "folders/{folder}"
|
70
|
+
# }
|
71
|
+
# name_descriptor: {
|
72
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
+
# parent_name_extractor: "organizations/{organization}"
|
75
|
+
# }
|
76
|
+
# name_descriptor: {
|
77
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
+
# }
|
81
|
+
# };
|
82
|
+
# }
|
83
|
+
#
|
84
|
+
# The ResourceDescriptor Yaml config will look like:
|
85
|
+
#
|
86
|
+
# resources:
|
87
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
+
# name_descriptor:
|
89
|
+
# - pattern: "projects/{project}/logs/{log}"
|
90
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
91
|
+
# parent_name_extractor: "projects/{project}"
|
92
|
+
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
+
# parent_name_extractor: "folders/{folder}"
|
95
|
+
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
+
# parent_name_extractor: "organizations/{organization}"
|
98
|
+
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
+
#
|
102
|
+
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
+
# the resource itself has parents for policy evaluation.
|
104
|
+
#
|
105
|
+
# Example:
|
106
|
+
#
|
107
|
+
# message Shelf {
|
108
|
+
# option (google.api.resource) = {
|
109
|
+
# type: "library.googleapis.com/Shelf"
|
110
|
+
# name_descriptor: {
|
111
|
+
# pattern: "shelves/{shelf}"
|
112
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
+
# }
|
114
|
+
# name_descriptor: {
|
115
|
+
# pattern: "shelves/{shelf}"
|
116
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
+
# }
|
118
|
+
# };
|
119
|
+
# }
|
120
|
+
#
|
121
|
+
# The ResourceDescriptor Yaml config will look like:
|
122
|
+
#
|
123
|
+
# resources:
|
124
|
+
# - type: 'library.googleapis.com/Shelf'
|
125
|
+
# name_descriptor:
|
126
|
+
# - pattern: "shelves/{shelf}"
|
127
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
+
# - pattern: "shelves/{shelf}"
|
129
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
|
+
# @!attribute [rw] type
|
131
|
+
# @return [::String]
|
132
|
+
# The resource type. It must be in the format of
|
133
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
|
+
# singular and must not include version numbers.
|
135
|
+
#
|
136
|
+
# Example: `storage.googleapis.com/Bucket`
|
137
|
+
#
|
138
|
+
# The value of the resource_type_kind must follow the regular expression
|
139
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
140
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
|
+
# characters allowed for the `resource_type_kind` is 100.
|
142
|
+
# @!attribute [rw] pattern
|
143
|
+
# @return [::Array<::String>]
|
144
|
+
# Optional. The relative resource name pattern associated with this resource
|
145
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
|
+
#
|
147
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
148
|
+
# syntax:
|
149
|
+
#
|
150
|
+
# Template = Segment { "/" Segment } ;
|
151
|
+
# Segment = LITERAL | Variable ;
|
152
|
+
# Variable = "{" LITERAL "}" ;
|
153
|
+
#
|
154
|
+
# Examples:
|
155
|
+
#
|
156
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
157
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
158
|
+
#
|
159
|
+
# The components in braces correspond to the IDs for each resource in the
|
160
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
161
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
162
|
+
# type of resource.
|
163
|
+
# @!attribute [rw] name_field
|
164
|
+
# @return [::String]
|
165
|
+
# Optional. The field on the resource that designates the resource name
|
166
|
+
# field. If omitted, this is assumed to be "name".
|
167
|
+
# @!attribute [rw] history
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
170
|
+
#
|
171
|
+
# Example:
|
172
|
+
#
|
173
|
+
# // The InspectTemplate message originally only supported resource
|
174
|
+
# // names with organization, and project was added later.
|
175
|
+
# message InspectTemplate {
|
176
|
+
# option (google.api.resource) = {
|
177
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
178
|
+
# pattern:
|
179
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
180
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
181
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
182
|
+
# };
|
183
|
+
# }
|
184
|
+
# @!attribute [rw] plural
|
185
|
+
# @return [::String]
|
186
|
+
# The plural name used in the resource name, such as 'projects' for
|
187
|
+
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
|
+
# field in k8s CRD spec
|
189
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
|
+
# @!attribute [rw] singular
|
191
|
+
# @return [::String]
|
192
|
+
# The same concept of the `singular` field in k8s CRD spec
|
193
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
|
+
class ResourceDescriptor
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
|
199
|
+
# A description of the historical or future-looking state of the
|
200
|
+
# resource pattern.
|
201
|
+
module History
|
202
|
+
# The "unset" value.
|
203
|
+
HISTORY_UNSPECIFIED = 0
|
204
|
+
|
205
|
+
# The resource originally had one pattern and launched as such, and
|
206
|
+
# additional patterns were added later.
|
207
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
208
|
+
|
209
|
+
# The resource has one pattern, but the API owner expects to add more
|
210
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
211
|
+
# that from being necessary once there are multiple patterns.)
|
212
|
+
FUTURE_MULTI_PATTERN = 2
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# Defines a proto annotation that describes a string field that refers to
|
217
|
+
# an API resource.
|
218
|
+
# @!attribute [rw] type
|
219
|
+
# @return [::String]
|
220
|
+
# The resource type that the annotated field references.
|
221
|
+
#
|
222
|
+
# Example:
|
223
|
+
#
|
224
|
+
# message Subscription {
|
225
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
226
|
+
# type: "pubsub.googleapis.com/Topic"
|
227
|
+
# }];
|
228
|
+
# }
|
229
|
+
# @!attribute [rw] child_type
|
230
|
+
# @return [::String]
|
231
|
+
# The resource type of a child collection that the annotated field
|
232
|
+
# references. This is useful for annotating the `parent` field that
|
233
|
+
# doesn't have a fixed resource type.
|
234
|
+
#
|
235
|
+
# Example:
|
236
|
+
#
|
237
|
+
# message ListLogEntriesRequest {
|
238
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
239
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
240
|
+
# };
|
241
|
+
# }
|
242
|
+
class ResourceReference
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
end
|
246
|
+
end
|
247
|
+
end
|