google-cloud-eventarc-v1 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +2 -2
- data/lib/google/cloud/eventarc/v1/bindings_override.rb +183 -0
- data/lib/google/cloud/eventarc/v1/channel_pb.rb +1 -0
- data/lib/google/cloud/eventarc/v1/eventarc/client.rb +272 -57
- data/lib/google/cloud/eventarc/v1/eventarc/operations.rb +12 -14
- data/lib/google/cloud/eventarc/v1/eventarc/paths.rb +57 -0
- data/lib/google/cloud/eventarc/v1/eventarc/rest/client.rb +1686 -0
- data/lib/google/cloud/eventarc/v1/eventarc/rest/operations.rb +793 -0
- data/lib/google/cloud/eventarc/v1/eventarc/rest/service_stub.rb +1116 -0
- data/lib/google/cloud/eventarc/v1/eventarc/rest.rb +55 -0
- data/lib/google/cloud/eventarc/v1/eventarc.rb +7 -1
- data/lib/google/cloud/eventarc/v1/eventarc_pb.rb +11 -0
- data/lib/google/cloud/eventarc/v1/eventarc_services_pb.rb +4 -0
- data/lib/google/cloud/eventarc/v1/google_channel_config_pb.rb +28 -0
- data/lib/google/cloud/eventarc/v1/rest.rb +38 -0
- data/lib/google/cloud/eventarc/v1/trigger_pb.rb +8 -0
- data/lib/google/cloud/eventarc/v1/version.rb +1 -1
- data/lib/google/cloud/eventarc/v1.rb +7 -2
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/eventarc/v1/channel.rb +20 -10
- data/proto_docs/google/cloud/eventarc/v1/eventarc.rb +35 -4
- data/proto_docs/google/cloud/eventarc/v1/google_channel_config.rb +50 -0
- data/proto_docs/google/cloud/eventarc/v1/trigger.rb +31 -1
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/rpc/code.rb +185 -0
- data/proto_docs/google/rpc/status.rb +4 -2
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +60 -8
@@ -27,13 +27,14 @@ module Google
|
|
27
27
|
# channel. Note that a channel is associated with exactly one event provider.
|
28
28
|
# @!attribute [rw] name
|
29
29
|
# @return [::String]
|
30
|
-
# Required. The resource name of the channel. Must be unique within the
|
31
|
-
# on the project and must be in
|
30
|
+
# Required. The resource name of the channel. Must be unique within the
|
31
|
+
# location on the project and must be in
|
32
32
|
# `projects/{project}/locations/{location}/channels/{channel_id}` format.
|
33
33
|
# @!attribute [r] uid
|
34
34
|
# @return [::String]
|
35
|
-
# Output only. Server assigned unique identifier for the channel. The value
|
36
|
-
# string and guaranteed to remain unchanged until the resource is
|
35
|
+
# Output only. Server assigned unique identifier for the channel. The value
|
36
|
+
# is a UUID4 string and guaranteed to remain unchanged until the resource is
|
37
|
+
# deleted.
|
37
38
|
# @!attribute [r] create_time
|
38
39
|
# @return [::Google::Protobuf::Timestamp]
|
39
40
|
# Output only. The creation time.
|
@@ -42,22 +43,29 @@ module Google
|
|
42
43
|
# Output only. The last-modified time.
|
43
44
|
# @!attribute [rw] provider
|
44
45
|
# @return [::String]
|
45
|
-
#
|
46
|
+
# The name of the event provider (e.g. Eventarc SaaS partner) associated
|
46
47
|
# with the channel. This provider will be granted permissions to publish
|
47
48
|
# events to the channel. Format:
|
48
49
|
# `projects/{project}/locations/{location}/providers/{provider_id}`.
|
49
50
|
# @!attribute [r] pubsub_topic
|
50
51
|
# @return [::String]
|
51
|
-
# Output only. The name of the Pub/Sub topic created and managed by
|
52
|
-
# a transport for the event delivery. Format:
|
52
|
+
# Output only. The name of the Pub/Sub topic created and managed by
|
53
|
+
# Eventarc system as a transport for the event delivery. Format:
|
53
54
|
# `projects/{project}/topics/{topic_id}`.
|
54
55
|
# @!attribute [r] state
|
55
56
|
# @return [::Google::Cloud::Eventarc::V1::Channel::State]
|
56
57
|
# Output only. The state of a Channel.
|
57
58
|
# @!attribute [r] activation_token
|
58
59
|
# @return [::String]
|
59
|
-
# Output only. The activation token for the channel. The token must be used
|
60
|
-
# provider to register the channel for publishing.
|
60
|
+
# Output only. The activation token for the channel. The token must be used
|
61
|
+
# by the provider to register the channel for publishing.
|
62
|
+
# @!attribute [rw] crypto_key_name
|
63
|
+
# @return [::String]
|
64
|
+
# Optional. Resource name of a KMS crypto key (managed by the user) used to
|
65
|
+
# encrypt/decrypt their event data.
|
66
|
+
#
|
67
|
+
# It must match the pattern
|
68
|
+
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
61
69
|
class Channel
|
62
70
|
include ::Google::Protobuf::MessageExts
|
63
71
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -78,11 +86,13 @@ module Google
|
|
78
86
|
# event provider.
|
79
87
|
ACTIVE = 2
|
80
88
|
|
81
|
-
# The INACTIVE state
|
89
|
+
# The INACTIVE state indicates that the Channel cannot receive events
|
82
90
|
# permanently. There are two possible cases this state can happen:
|
91
|
+
#
|
83
92
|
# 1. The SaaS provider disconnected from this Channel.
|
84
93
|
# 2. The Channel activation token has expired but the SaaS provider
|
85
94
|
# wasn't connected.
|
95
|
+
#
|
86
96
|
# To re-establish a Connection with a provider, the subscriber
|
87
97
|
# should create a new Channel and give it to the provider.
|
88
98
|
INACTIVE = 3
|
@@ -37,6 +37,7 @@ module Google
|
|
37
37
|
# @!attribute [rw] page_size
|
38
38
|
# @return [::Integer]
|
39
39
|
# The maximum number of triggers to return on each page.
|
40
|
+
#
|
40
41
|
# Note: The service may send fewer.
|
41
42
|
# @!attribute [rw] page_token
|
42
43
|
# @return [::String]
|
@@ -51,6 +52,11 @@ module Google
|
|
51
52
|
# comma-separated list of fields. The default sorting order is ascending. To
|
52
53
|
# specify descending order for a field, append a `desc` suffix; for example:
|
53
54
|
# `name desc, trigger_id`.
|
55
|
+
# @!attribute [rw] filter
|
56
|
+
# @return [::String]
|
57
|
+
# Filter field. Used to filter the Triggers to be listed. Possible filters
|
58
|
+
# are described in https://google.aip.dev/160. For example, using
|
59
|
+
# "?filter=destination:gke" would list only Triggers with a gke destination.
|
54
60
|
class ListTriggersRequest
|
55
61
|
include ::Google::Protobuf::MessageExts
|
56
62
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -62,7 +68,7 @@ module Google
|
|
62
68
|
# The requested triggers, up to the number specified in `page_size`.
|
63
69
|
# @!attribute [rw] next_page_token
|
64
70
|
# @return [::String]
|
65
|
-
# A page token that can be sent to ListTriggers to request the next page.
|
71
|
+
# A page token that can be sent to `ListTriggers` to request the next page.
|
66
72
|
# If this is empty, then there are no more pages.
|
67
73
|
# @!attribute [rw] unreachable
|
68
74
|
# @return [::Array<::String>]
|
@@ -150,6 +156,7 @@ module Google
|
|
150
156
|
# @!attribute [rw] page_size
|
151
157
|
# @return [::Integer]
|
152
158
|
# The maximum number of channels to return on each page.
|
159
|
+
#
|
153
160
|
# Note: The service may send fewer.
|
154
161
|
# @!attribute [rw] page_token
|
155
162
|
# @return [::String]
|
@@ -175,7 +182,7 @@ module Google
|
|
175
182
|
# The requested channels, up to the number specified in `page_size`.
|
176
183
|
# @!attribute [rw] next_page_token
|
177
184
|
# @return [::String]
|
178
|
-
# A page token that can be sent to ListChannels to request the next page.
|
185
|
+
# A page token that can be sent to `ListChannels` to request the next page.
|
179
186
|
# If this is empty, then there are no more pages.
|
180
187
|
# @!attribute [rw] unreachable
|
181
188
|
# @return [::Array<::String>]
|
@@ -278,7 +285,7 @@ module Google
|
|
278
285
|
# The requested providers, up to the number specified in `page_size`.
|
279
286
|
# @!attribute [rw] next_page_token
|
280
287
|
# @return [::String]
|
281
|
-
# A page token that can be sent to ListProviders to request the next page.
|
288
|
+
# A page token that can be sent to `ListProviders` to request the next page.
|
282
289
|
# If this is empty, then there are no more pages.
|
283
290
|
# @!attribute [rw] unreachable
|
284
291
|
# @return [::Array<::String>]
|
@@ -304,6 +311,7 @@ module Google
|
|
304
311
|
# @!attribute [rw] page_size
|
305
312
|
# @return [::Integer]
|
306
313
|
# The maximum number of channel connections to return on each page.
|
314
|
+
#
|
307
315
|
# Note: The service may send fewer responses.
|
308
316
|
# @!attribute [rw] page_token
|
309
317
|
# @return [::String]
|
@@ -324,7 +332,7 @@ module Google
|
|
324
332
|
# `page_size`.
|
325
333
|
# @!attribute [rw] next_page_token
|
326
334
|
# @return [::String]
|
327
|
-
# A page token that can be sent to ListChannelConnections to request the
|
335
|
+
# A page token that can be sent to `ListChannelConnections` to request the
|
328
336
|
# next page.
|
329
337
|
# If this is empty, then there are no more pages.
|
330
338
|
# @!attribute [rw] unreachable
|
@@ -359,6 +367,29 @@ module Google
|
|
359
367
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
360
368
|
end
|
361
369
|
|
370
|
+
# The request message for the UpdateGoogleChannelConfig method.
|
371
|
+
# @!attribute [rw] google_channel_config
|
372
|
+
# @return [::Google::Cloud::Eventarc::V1::GoogleChannelConfig]
|
373
|
+
# Required. The config to be updated.
|
374
|
+
# @!attribute [rw] update_mask
|
375
|
+
# @return [::Google::Protobuf::FieldMask]
|
376
|
+
# The fields to be updated; only fields explicitly provided are updated.
|
377
|
+
# If no field mask is provided, all provided fields in the request are
|
378
|
+
# updated. To update all fields, provide a field mask of "*".
|
379
|
+
class UpdateGoogleChannelConfigRequest
|
380
|
+
include ::Google::Protobuf::MessageExts
|
381
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
382
|
+
end
|
383
|
+
|
384
|
+
# The request message for the GetGoogleChannelConfig method.
|
385
|
+
# @!attribute [rw] name
|
386
|
+
# @return [::String]
|
387
|
+
# Required. The name of the config to get.
|
388
|
+
class GetGoogleChannelConfigRequest
|
389
|
+
include ::Google::Protobuf::MessageExts
|
390
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
391
|
+
end
|
392
|
+
|
362
393
|
# Represents the metadata of the long-running operation.
|
363
394
|
# @!attribute [r] create_time
|
364
395
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 Cloud
|
22
|
+
module Eventarc
|
23
|
+
module V1
|
24
|
+
# A GoogleChannelConfig is a resource that stores the custom settings
|
25
|
+
# respected by Eventarc first-party triggers in the matching region.
|
26
|
+
# Once configured, first-party event data will be protected
|
27
|
+
# using the specified custom managed encryption key instead of Google-managed
|
28
|
+
# encryption keys.
|
29
|
+
# @!attribute [rw] name
|
30
|
+
# @return [::String]
|
31
|
+
# Required. The resource name of the config. Must be in the format of,
|
32
|
+
# `projects/{project}/locations/{location}/googleChannelConfig`.
|
33
|
+
# @!attribute [r] update_time
|
34
|
+
# @return [::Google::Protobuf::Timestamp]
|
35
|
+
# Output only. The last-modified time.
|
36
|
+
# @!attribute [rw] crypto_key_name
|
37
|
+
# @return [::String]
|
38
|
+
# Optional. Resource name of a KMS crypto key (managed by the user) used to
|
39
|
+
# encrypt/decrypt their event data.
|
40
|
+
#
|
41
|
+
# It must match the pattern
|
42
|
+
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
|
43
|
+
class GoogleChannelConfig
|
44
|
+
include ::Google::Protobuf::MessageExts
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -39,7 +39,7 @@ module Google
|
|
39
39
|
# Output only. The last-modified time.
|
40
40
|
# @!attribute [rw] event_filters
|
41
41
|
# @return [::Array<::Google::Cloud::Eventarc::V1::EventFilter>]
|
42
|
-
# Required.
|
42
|
+
# Required. Unordered list. The list of filters that applies to event attributes. Only events that
|
43
43
|
# match all the provided filters are sent to the destination.
|
44
44
|
# @!attribute [rw] service_account
|
45
45
|
# @return [::String]
|
@@ -74,6 +74,9 @@ module Google
|
|
74
74
|
# Optional. The name of the channel associated with the trigger in
|
75
75
|
# `projects/{project}/locations/{location}/channels/{channel}` format.
|
76
76
|
# You must provide a channel to receive events from Eventarc SaaS partners.
|
77
|
+
# @!attribute [r] conditions
|
78
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Eventarc::V1::StateCondition}]
|
79
|
+
# Output only. The reason(s) why a trigger is in FAILED state.
|
77
80
|
# @!attribute [r] etag
|
78
81
|
# @return [::String]
|
79
82
|
# Output only. This checksum is computed by the server based on the value of other
|
@@ -91,6 +94,15 @@ module Google
|
|
91
94
|
include ::Google::Protobuf::MessageExts
|
92
95
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
93
96
|
end
|
97
|
+
|
98
|
+
# @!attribute [rw] key
|
99
|
+
# @return [::String]
|
100
|
+
# @!attribute [rw] value
|
101
|
+
# @return [::Google::Cloud::Eventarc::V1::StateCondition]
|
102
|
+
class ConditionsEntry
|
103
|
+
include ::Google::Protobuf::MessageExts
|
104
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
105
|
+
end
|
94
106
|
end
|
95
107
|
|
96
108
|
# Filters events based on exact matches on the CloudEvents attributes.
|
@@ -114,6 +126,18 @@ module Google
|
|
114
126
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
115
127
|
end
|
116
128
|
|
129
|
+
# A condition that is part of the trigger state computation.
|
130
|
+
# @!attribute [rw] code
|
131
|
+
# @return [::Google::Rpc::Code]
|
132
|
+
# The canonical code of the condition.
|
133
|
+
# @!attribute [rw] message
|
134
|
+
# @return [::String]
|
135
|
+
# Human-readable message.
|
136
|
+
class StateCondition
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
|
117
141
|
# Represents a target of an invocation over HTTP.
|
118
142
|
# @!attribute [rw] cloud_run
|
119
143
|
# @return [::Google::Cloud::Eventarc::V1::CloudRun]
|
@@ -127,6 +151,12 @@ module Google
|
|
127
151
|
# @return [::Google::Cloud::Eventarc::V1::GKE]
|
128
152
|
# A GKE service capable of receiving events. The service should be running
|
129
153
|
# in the same project as the trigger.
|
154
|
+
# @!attribute [rw] workflow
|
155
|
+
# @return [::String]
|
156
|
+
# The resource name of the Workflow whose Executions are triggered by
|
157
|
+
# the events. The Workflow resource should be deployed in the same project
|
158
|
+
# as the trigger.
|
159
|
+
# Format: `projects/{project}/locations/{location}/workflows/{workflow}`
|
130
160
|
class Destination
|
131
161
|
include ::Google::Protobuf::MessageExts
|
132
162
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -26,8 +26,6 @@ module Google
|
|
26
26
|
# service Foo {
|
27
27
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
28
|
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
29
|
class Empty
|
32
30
|
include ::Google::Protobuf::MessageExts
|
33
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,185 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 Rpc
|
22
|
+
# The canonical error codes for gRPC APIs.
|
23
|
+
#
|
24
|
+
#
|
25
|
+
# Sometimes multiple error codes may apply. Services should return
|
26
|
+
# the most specific error code that applies. For example, prefer
|
27
|
+
# `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
|
28
|
+
# Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
|
29
|
+
module Code
|
30
|
+
# Not an error; returned on success.
|
31
|
+
#
|
32
|
+
# HTTP Mapping: 200 OK
|
33
|
+
OK = 0
|
34
|
+
|
35
|
+
# The operation was cancelled, typically by the caller.
|
36
|
+
#
|
37
|
+
# HTTP Mapping: 499 Client Closed Request
|
38
|
+
CANCELLED = 1
|
39
|
+
|
40
|
+
# Unknown error. For example, this error may be returned when
|
41
|
+
# a `Status` value received from another address space belongs to
|
42
|
+
# an error space that is not known in this address space. Also
|
43
|
+
# errors raised by APIs that do not return enough error information
|
44
|
+
# may be converted to this error.
|
45
|
+
#
|
46
|
+
# HTTP Mapping: 500 Internal Server Error
|
47
|
+
UNKNOWN = 2
|
48
|
+
|
49
|
+
# The client specified an invalid argument. Note that this differs
|
50
|
+
# from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
|
51
|
+
# that are problematic regardless of the state of the system
|
52
|
+
# (e.g., a malformed file name).
|
53
|
+
#
|
54
|
+
# HTTP Mapping: 400 Bad Request
|
55
|
+
INVALID_ARGUMENT = 3
|
56
|
+
|
57
|
+
# The deadline expired before the operation could complete. For operations
|
58
|
+
# that change the state of the system, this error may be returned
|
59
|
+
# even if the operation has completed successfully. For example, a
|
60
|
+
# successful response from a server could have been delayed long
|
61
|
+
# enough for the deadline to expire.
|
62
|
+
#
|
63
|
+
# HTTP Mapping: 504 Gateway Timeout
|
64
|
+
DEADLINE_EXCEEDED = 4
|
65
|
+
|
66
|
+
# Some requested entity (e.g., file or directory) was not found.
|
67
|
+
#
|
68
|
+
# Note to server developers: if a request is denied for an entire class
|
69
|
+
# of users, such as gradual feature rollout or undocumented allowlist,
|
70
|
+
# `NOT_FOUND` may be used. If a request is denied for some users within
|
71
|
+
# a class of users, such as user-based access control, `PERMISSION_DENIED`
|
72
|
+
# must be used.
|
73
|
+
#
|
74
|
+
# HTTP Mapping: 404 Not Found
|
75
|
+
NOT_FOUND = 5
|
76
|
+
|
77
|
+
# The entity that a client attempted to create (e.g., file or directory)
|
78
|
+
# already exists.
|
79
|
+
#
|
80
|
+
# HTTP Mapping: 409 Conflict
|
81
|
+
ALREADY_EXISTS = 6
|
82
|
+
|
83
|
+
# The caller does not have permission to execute the specified
|
84
|
+
# operation. `PERMISSION_DENIED` must not be used for rejections
|
85
|
+
# caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
|
86
|
+
# instead for those errors). `PERMISSION_DENIED` must not be
|
87
|
+
# used if the caller can not be identified (use `UNAUTHENTICATED`
|
88
|
+
# instead for those errors). This error code does not imply the
|
89
|
+
# request is valid or the requested entity exists or satisfies
|
90
|
+
# other pre-conditions.
|
91
|
+
#
|
92
|
+
# HTTP Mapping: 403 Forbidden
|
93
|
+
PERMISSION_DENIED = 7
|
94
|
+
|
95
|
+
# The request does not have valid authentication credentials for the
|
96
|
+
# operation.
|
97
|
+
#
|
98
|
+
# HTTP Mapping: 401 Unauthorized
|
99
|
+
UNAUTHENTICATED = 16
|
100
|
+
|
101
|
+
# Some resource has been exhausted, perhaps a per-user quota, or
|
102
|
+
# perhaps the entire file system is out of space.
|
103
|
+
#
|
104
|
+
# HTTP Mapping: 429 Too Many Requests
|
105
|
+
RESOURCE_EXHAUSTED = 8
|
106
|
+
|
107
|
+
# The operation was rejected because the system is not in a state
|
108
|
+
# required for the operation's execution. For example, the directory
|
109
|
+
# to be deleted is non-empty, an rmdir operation is applied to
|
110
|
+
# a non-directory, etc.
|
111
|
+
#
|
112
|
+
# Service implementors can use the following guidelines to decide
|
113
|
+
# between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
|
114
|
+
# (a) Use `UNAVAILABLE` if the client can retry just the failing call.
|
115
|
+
# (b) Use `ABORTED` if the client should retry at a higher level. For
|
116
|
+
# example, when a client-specified test-and-set fails, indicating the
|
117
|
+
# client should restart a read-modify-write sequence.
|
118
|
+
# (c) Use `FAILED_PRECONDITION` if the client should not retry until
|
119
|
+
# the system state has been explicitly fixed. For example, if an "rmdir"
|
120
|
+
# fails because the directory is non-empty, `FAILED_PRECONDITION`
|
121
|
+
# should be returned since the client should not retry unless
|
122
|
+
# the files are deleted from the directory.
|
123
|
+
#
|
124
|
+
# HTTP Mapping: 400 Bad Request
|
125
|
+
FAILED_PRECONDITION = 9
|
126
|
+
|
127
|
+
# The operation was aborted, typically due to a concurrency issue such as
|
128
|
+
# a sequencer check failure or transaction abort.
|
129
|
+
#
|
130
|
+
# See the guidelines above for deciding between `FAILED_PRECONDITION`,
|
131
|
+
# `ABORTED`, and `UNAVAILABLE`.
|
132
|
+
#
|
133
|
+
# HTTP Mapping: 409 Conflict
|
134
|
+
ABORTED = 10
|
135
|
+
|
136
|
+
# The operation was attempted past the valid range. E.g., seeking or
|
137
|
+
# reading past end-of-file.
|
138
|
+
#
|
139
|
+
# Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
|
140
|
+
# be fixed if the system state changes. For example, a 32-bit file
|
141
|
+
# system will generate `INVALID_ARGUMENT` if asked to read at an
|
142
|
+
# offset that is not in the range [0,2^32-1], but it will generate
|
143
|
+
# `OUT_OF_RANGE` if asked to read from an offset past the current
|
144
|
+
# file size.
|
145
|
+
#
|
146
|
+
# There is a fair bit of overlap between `FAILED_PRECONDITION` and
|
147
|
+
# `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
|
148
|
+
# error) when it applies so that callers who are iterating through
|
149
|
+
# a space can easily look for an `OUT_OF_RANGE` error to detect when
|
150
|
+
# they are done.
|
151
|
+
#
|
152
|
+
# HTTP Mapping: 400 Bad Request
|
153
|
+
OUT_OF_RANGE = 11
|
154
|
+
|
155
|
+
# The operation is not implemented or is not supported/enabled in this
|
156
|
+
# service.
|
157
|
+
#
|
158
|
+
# HTTP Mapping: 501 Not Implemented
|
159
|
+
UNIMPLEMENTED = 12
|
160
|
+
|
161
|
+
# Internal errors. This means that some invariants expected by the
|
162
|
+
# underlying system have been broken. This error code is reserved
|
163
|
+
# for serious errors.
|
164
|
+
#
|
165
|
+
# HTTP Mapping: 500 Internal Server Error
|
166
|
+
INTERNAL = 13
|
167
|
+
|
168
|
+
# The service is currently unavailable. This is most likely a
|
169
|
+
# transient condition, which can be corrected by retrying with
|
170
|
+
# a backoff. Note that it is not always safe to retry
|
171
|
+
# non-idempotent operations.
|
172
|
+
#
|
173
|
+
# See the guidelines above for deciding between `FAILED_PRECONDITION`,
|
174
|
+
# `ABORTED`, and `UNAVAILABLE`.
|
175
|
+
#
|
176
|
+
# HTTP Mapping: 503 Service Unavailable
|
177
|
+
UNAVAILABLE = 14
|
178
|
+
|
179
|
+
# Unrecoverable data loss or corruption.
|
180
|
+
#
|
181
|
+
# HTTP Mapping: 500 Internal Server Error
|
182
|
+
DATA_LOSS = 15
|
183
|
+
end
|
184
|
+
end
|
185
|
+
end
|
@@ -28,12 +28,14 @@ module Google
|
|
28
28
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
29
29
|
# @!attribute [rw] code
|
30
30
|
# @return [::Integer]
|
31
|
-
# The status code, which should be an enum value of
|
31
|
+
# The status code, which should be an enum value of
|
32
|
+
# {::Google::Rpc::Code google.rpc.Code}.
|
32
33
|
# @!attribute [rw] message
|
33
34
|
# @return [::String]
|
34
35
|
# A developer-facing error message, which should be in English. Any
|
35
36
|
# user-facing error message should be localized and sent in the
|
36
|
-
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
37
|
+
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
38
|
+
# by the client.
|
37
39
|
# @!attribute [rw] details
|
38
40
|
# @return [::Array<::Google::Protobuf::Any>]
|
39
41
|
# A list of messages that carry the error details. There is a common set of
|
@@ -0,0 +1,75 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 Type
|
22
|
+
# Represents a textual expression in the Common Expression Language (CEL)
|
23
|
+
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
|
24
|
+
# are documented at https://github.com/google/cel-spec.
|
25
|
+
#
|
26
|
+
# Example (Comparison):
|
27
|
+
#
|
28
|
+
# title: "Summary size limit"
|
29
|
+
# description: "Determines if a summary is less than 100 chars"
|
30
|
+
# expression: "document.summary.size() < 100"
|
31
|
+
#
|
32
|
+
# Example (Equality):
|
33
|
+
#
|
34
|
+
# title: "Requestor is owner"
|
35
|
+
# description: "Determines if requestor is the document owner"
|
36
|
+
# expression: "document.owner == request.auth.claims.email"
|
37
|
+
#
|
38
|
+
# Example (Logic):
|
39
|
+
#
|
40
|
+
# title: "Public documents"
|
41
|
+
# description: "Determine whether the document should be publicly visible"
|
42
|
+
# expression: "document.type != 'private' && document.type != 'internal'"
|
43
|
+
#
|
44
|
+
# Example (Data Manipulation):
|
45
|
+
#
|
46
|
+
# title: "Notification string"
|
47
|
+
# description: "Create a notification string with a timestamp."
|
48
|
+
# expression: "'New message received at ' + string(document.create_time)"
|
49
|
+
#
|
50
|
+
# The exact variables and functions that may be referenced within an expression
|
51
|
+
# are determined by the service that evaluates it. See the service
|
52
|
+
# documentation for additional information.
|
53
|
+
# @!attribute [rw] expression
|
54
|
+
# @return [::String]
|
55
|
+
# Textual representation of an expression in Common Expression Language
|
56
|
+
# syntax.
|
57
|
+
# @!attribute [rw] title
|
58
|
+
# @return [::String]
|
59
|
+
# Optional. Title for the expression, i.e. a short string describing
|
60
|
+
# its purpose. This can be used e.g. in UIs which allow to enter the
|
61
|
+
# expression.
|
62
|
+
# @!attribute [rw] description
|
63
|
+
# @return [::String]
|
64
|
+
# Optional. Description of the expression. This is a longer text which
|
65
|
+
# describes the expression, e.g. when hovered over it in a UI.
|
66
|
+
# @!attribute [rw] location
|
67
|
+
# @return [::String]
|
68
|
+
# Optional. String indicating the location of the expression for error
|
69
|
+
# reporting, e.g. a file name and a position in the file.
|
70
|
+
class Expr
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|