google-cloud-bigquery-migration-v2 0.1.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 +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_entities_pb.rb +89 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_error_details_pb.rb +39 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_metrics_pb.rb +52 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/client.rb +1016 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/credentials.rb +49 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service/paths.rb +92 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service.rb +51 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service_pb.rb +76 -0
- data/lib/google/cloud/bigquery/migration/v2/migration_service_services_pb.rb +62 -0
- data/lib/google/cloud/bigquery/migration/v2/translation_config_pb.rb +127 -0
- data/lib/google/cloud/bigquery/migration/v2/version.rb +30 -0
- data/lib/google/cloud/bigquery/migration/v2.rb +42 -0
- data/lib/google-cloud-bigquery-migration-v2.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/distribution.rb +225 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/label.rb +49 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/metric.rb +276 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_entities.rb +220 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_error_details.rb +72 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_metrics.rb +119 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/migration_service.rb +166 -0
- data/proto_docs/google/cloud/bigquery/migration/v2/translation_config.rb +275 -0
- data/proto_docs/google/protobuf/any.rb +141 -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 +129 -0
- data/proto_docs/google/rpc/error_details.rb +297 -0
- metadata +227 -0
@@ -0,0 +1,229 @@
|
|
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 Protobuf
|
22
|
+
# `FieldMask` represents a set of symbolic field paths, for example:
|
23
|
+
#
|
24
|
+
# paths: "f.a"
|
25
|
+
# paths: "f.b.d"
|
26
|
+
#
|
27
|
+
# Here `f` represents a field in some root message, `a` and `b`
|
28
|
+
# fields in the message found in `f`, and `d` a field found in the
|
29
|
+
# message in `f.b`.
|
30
|
+
#
|
31
|
+
# Field masks are used to specify a subset of fields that should be
|
32
|
+
# returned by a get operation or modified by an update operation.
|
33
|
+
# Field masks also have a custom JSON encoding (see below).
|
34
|
+
#
|
35
|
+
# # Field Masks in Projections
|
36
|
+
#
|
37
|
+
# When used in the context of a projection, a response message or
|
38
|
+
# sub-message is filtered by the API to only contain those fields as
|
39
|
+
# specified in the mask. For example, if the mask in the previous
|
40
|
+
# example is applied to a response message as follows:
|
41
|
+
#
|
42
|
+
# f {
|
43
|
+
# a : 22
|
44
|
+
# b {
|
45
|
+
# d : 1
|
46
|
+
# x : 2
|
47
|
+
# }
|
48
|
+
# y : 13
|
49
|
+
# }
|
50
|
+
# z: 8
|
51
|
+
#
|
52
|
+
# The result will not contain specific values for fields x,y and z
|
53
|
+
# (their value will be set to the default, and omitted in proto text
|
54
|
+
# output):
|
55
|
+
#
|
56
|
+
#
|
57
|
+
# f {
|
58
|
+
# a : 22
|
59
|
+
# b {
|
60
|
+
# d : 1
|
61
|
+
# }
|
62
|
+
# }
|
63
|
+
#
|
64
|
+
# A repeated field is not allowed except at the last position of a
|
65
|
+
# paths string.
|
66
|
+
#
|
67
|
+
# If a FieldMask object is not present in a get operation, the
|
68
|
+
# operation applies to all fields (as if a FieldMask of all fields
|
69
|
+
# had been specified).
|
70
|
+
#
|
71
|
+
# Note that a field mask does not necessarily apply to the
|
72
|
+
# top-level response message. In case of a REST get operation, the
|
73
|
+
# field mask applies directly to the response, but in case of a REST
|
74
|
+
# list operation, the mask instead applies to each individual message
|
75
|
+
# in the returned resource list. In case of a REST custom method,
|
76
|
+
# other definitions may be used. Where the mask applies will be
|
77
|
+
# clearly documented together with its declaration in the API. In
|
78
|
+
# any case, the effect on the returned resource/resources is required
|
79
|
+
# behavior for APIs.
|
80
|
+
#
|
81
|
+
# # Field Masks in Update Operations
|
82
|
+
#
|
83
|
+
# A field mask in update operations specifies which fields of the
|
84
|
+
# targeted resource are going to be updated. The API is required
|
85
|
+
# to only change the values of the fields as specified in the mask
|
86
|
+
# and leave the others untouched. If a resource is passed in to
|
87
|
+
# describe the updated values, the API ignores the values of all
|
88
|
+
# fields not covered by the mask.
|
89
|
+
#
|
90
|
+
# If a repeated field is specified for an update operation, new values will
|
91
|
+
# be appended to the existing repeated field in the target resource. Note that
|
92
|
+
# a repeated field is only allowed in the last position of a `paths` string.
|
93
|
+
#
|
94
|
+
# If a sub-message is specified in the last position of the field mask for an
|
95
|
+
# update operation, then new value will be merged into the existing sub-message
|
96
|
+
# in the target resource.
|
97
|
+
#
|
98
|
+
# For example, given the target message:
|
99
|
+
#
|
100
|
+
# f {
|
101
|
+
# b {
|
102
|
+
# d: 1
|
103
|
+
# x: 2
|
104
|
+
# }
|
105
|
+
# c: [1]
|
106
|
+
# }
|
107
|
+
#
|
108
|
+
# And an update message:
|
109
|
+
#
|
110
|
+
# f {
|
111
|
+
# b {
|
112
|
+
# d: 10
|
113
|
+
# }
|
114
|
+
# c: [2]
|
115
|
+
# }
|
116
|
+
#
|
117
|
+
# then if the field mask is:
|
118
|
+
#
|
119
|
+
# paths: ["f.b", "f.c"]
|
120
|
+
#
|
121
|
+
# then the result will be:
|
122
|
+
#
|
123
|
+
# f {
|
124
|
+
# b {
|
125
|
+
# d: 10
|
126
|
+
# x: 2
|
127
|
+
# }
|
128
|
+
# c: [1, 2]
|
129
|
+
# }
|
130
|
+
#
|
131
|
+
# An implementation may provide options to override this default behavior for
|
132
|
+
# repeated and message fields.
|
133
|
+
#
|
134
|
+
# In order to reset a field's value to the default, the field must
|
135
|
+
# be in the mask and set to the default value in the provided resource.
|
136
|
+
# Hence, in order to reset all fields of a resource, provide a default
|
137
|
+
# instance of the resource and set all fields in the mask, or do
|
138
|
+
# not provide a mask as described below.
|
139
|
+
#
|
140
|
+
# If a field mask is not present on update, the operation applies to
|
141
|
+
# all fields (as if a field mask of all fields has been specified).
|
142
|
+
# Note that in the presence of schema evolution, this may mean that
|
143
|
+
# fields the client does not know and has therefore not filled into
|
144
|
+
# the request will be reset to their default. If this is unwanted
|
145
|
+
# behavior, a specific service may require a client to always specify
|
146
|
+
# a field mask, producing an error if not.
|
147
|
+
#
|
148
|
+
# As with get operations, the location of the resource which
|
149
|
+
# describes the updated values in the request message depends on the
|
150
|
+
# operation kind. In any case, the effect of the field mask is
|
151
|
+
# required to be honored by the API.
|
152
|
+
#
|
153
|
+
# ## Considerations for HTTP REST
|
154
|
+
#
|
155
|
+
# The HTTP kind of an update operation which uses a field mask must
|
156
|
+
# be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
157
|
+
# (PUT must only be used for full updates).
|
158
|
+
#
|
159
|
+
# # JSON Encoding of Field Masks
|
160
|
+
#
|
161
|
+
# In JSON, a field mask is encoded as a single string where paths are
|
162
|
+
# separated by a comma. Fields name in each path are converted
|
163
|
+
# to/from lower-camel naming conventions.
|
164
|
+
#
|
165
|
+
# As an example, consider the following message declarations:
|
166
|
+
#
|
167
|
+
# message Profile {
|
168
|
+
# User user = 1;
|
169
|
+
# Photo photo = 2;
|
170
|
+
# }
|
171
|
+
# message User {
|
172
|
+
# string display_name = 1;
|
173
|
+
# string address = 2;
|
174
|
+
# }
|
175
|
+
#
|
176
|
+
# In proto a field mask for `Profile` may look as such:
|
177
|
+
#
|
178
|
+
# mask {
|
179
|
+
# paths: "user.display_name"
|
180
|
+
# paths: "photo"
|
181
|
+
# }
|
182
|
+
#
|
183
|
+
# In JSON, the same mask is represented as below:
|
184
|
+
#
|
185
|
+
# {
|
186
|
+
# mask: "user.displayName,photo"
|
187
|
+
# }
|
188
|
+
#
|
189
|
+
# # Field Masks and Oneof Fields
|
190
|
+
#
|
191
|
+
# Field masks treat fields in oneofs just as regular fields. Consider the
|
192
|
+
# following message:
|
193
|
+
#
|
194
|
+
# message SampleMessage {
|
195
|
+
# oneof test_oneof {
|
196
|
+
# string name = 4;
|
197
|
+
# SubMessage sub_message = 9;
|
198
|
+
# }
|
199
|
+
# }
|
200
|
+
#
|
201
|
+
# The field mask can be:
|
202
|
+
#
|
203
|
+
# mask {
|
204
|
+
# paths: "name"
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# Or:
|
208
|
+
#
|
209
|
+
# mask {
|
210
|
+
# paths: "sub_message"
|
211
|
+
# }
|
212
|
+
#
|
213
|
+
# Note that oneof type names ("test_oneof" in this case) cannot be used in
|
214
|
+
# paths.
|
215
|
+
#
|
216
|
+
# ## Field Mask Verification
|
217
|
+
#
|
218
|
+
# The implementation of any API method which has a FieldMask type field in the
|
219
|
+
# request should verify the included field paths, and return an
|
220
|
+
# `INVALID_ARGUMENT` error if any path is unmappable.
|
221
|
+
# @!attribute [rw] paths
|
222
|
+
# @return [::Array<::String>]
|
223
|
+
# The set of field mask paths.
|
224
|
+
class FieldMask
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|
@@ -0,0 +1,129 @@
|
|
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 Protobuf
|
22
|
+
# A Timestamp represents a point in time independent of any time zone or local
|
23
|
+
# calendar, encoded as a count of seconds and fractions of seconds at
|
24
|
+
# nanosecond resolution. The count is relative to an epoch at UTC midnight on
|
25
|
+
# January 1, 1970, in the proleptic Gregorian calendar which extends the
|
26
|
+
# Gregorian calendar backwards to year one.
|
27
|
+
#
|
28
|
+
# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
|
29
|
+
# second table is needed for interpretation, using a [24-hour linear
|
30
|
+
# smear](https://developers.google.com/time/smear).
|
31
|
+
#
|
32
|
+
# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
|
33
|
+
# restricting to that range, we ensure that we can convert to and from [RFC
|
34
|
+
# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
|
35
|
+
#
|
36
|
+
# # Examples
|
37
|
+
#
|
38
|
+
# Example 1: Compute Timestamp from POSIX `time()`.
|
39
|
+
#
|
40
|
+
# Timestamp timestamp;
|
41
|
+
# timestamp.set_seconds(time(NULL));
|
42
|
+
# timestamp.set_nanos(0);
|
43
|
+
#
|
44
|
+
# Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
45
|
+
#
|
46
|
+
# struct timeval tv;
|
47
|
+
# gettimeofday(&tv, NULL);
|
48
|
+
#
|
49
|
+
# Timestamp timestamp;
|
50
|
+
# timestamp.set_seconds(tv.tv_sec);
|
51
|
+
# timestamp.set_nanos(tv.tv_usec * 1000);
|
52
|
+
#
|
53
|
+
# Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
54
|
+
#
|
55
|
+
# FILETIME ft;
|
56
|
+
# GetSystemTimeAsFileTime(&ft);
|
57
|
+
# UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
|
58
|
+
#
|
59
|
+
# // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
|
60
|
+
# // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
|
61
|
+
# Timestamp timestamp;
|
62
|
+
# timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
63
|
+
# timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
64
|
+
#
|
65
|
+
# Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
66
|
+
#
|
67
|
+
# long millis = System.currentTimeMillis();
|
68
|
+
#
|
69
|
+
# Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
70
|
+
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
71
|
+
#
|
72
|
+
#
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
74
|
+
#
|
75
|
+
# Instant now = Instant.now();
|
76
|
+
#
|
77
|
+
# Timestamp timestamp =
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
79
|
+
# .setNanos(now.getNano()).build();
|
80
|
+
#
|
81
|
+
#
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
83
|
+
#
|
84
|
+
# timestamp = Timestamp()
|
85
|
+
# timestamp.GetCurrentTime()
|
86
|
+
#
|
87
|
+
# # JSON Mapping
|
88
|
+
#
|
89
|
+
# In JSON format, the Timestamp type is encoded as a string in the
|
90
|
+
# [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
|
91
|
+
# format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
|
92
|
+
# where \\{year} is always expressed using four digits while \\{month}, \\{day},
|
93
|
+
# \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
|
94
|
+
# seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
|
95
|
+
# are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
|
96
|
+
# is required. A proto3 JSON serializer should always use UTC (as indicated by
|
97
|
+
# "Z") when printing the Timestamp type and a proto3 JSON parser should be
|
98
|
+
# able to accept both UTC and other timezones (as indicated by an offset).
|
99
|
+
#
|
100
|
+
# For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
|
101
|
+
# 01:30 UTC on January 15, 2017.
|
102
|
+
#
|
103
|
+
# In JavaScript, one can convert a Date object to this format using the
|
104
|
+
# standard
|
105
|
+
# [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
106
|
+
# method. In Python, a standard `datetime.datetime` object can be converted
|
107
|
+
# to this format using
|
108
|
+
# [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
109
|
+
# the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
110
|
+
# the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
111
|
+
# http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
112
|
+
# ) to obtain a formatter capable of generating timestamps in this format.
|
113
|
+
# @!attribute [rw] seconds
|
114
|
+
# @return [::Integer]
|
115
|
+
# Represents seconds of UTC time since Unix epoch
|
116
|
+
# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
|
117
|
+
# 9999-12-31T23:59:59Z inclusive.
|
118
|
+
# @!attribute [rw] nanos
|
119
|
+
# @return [::Integer]
|
120
|
+
# Non-negative fractions of a second at nanosecond resolution. Negative
|
121
|
+
# second values with fractions must still have non-negative nanos values
|
122
|
+
# that count forward in time. Must be from 0 to 999,999,999
|
123
|
+
# inclusive.
|
124
|
+
class Timestamp
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
@@ -0,0 +1,297 @@
|
|
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
|
+
# Describes when the clients can retry a failed request. Clients could ignore
|
23
|
+
# the recommendation here or retry when this information is missing from error
|
24
|
+
# responses.
|
25
|
+
#
|
26
|
+
# It's always recommended that clients should use exponential backoff when
|
27
|
+
# retrying.
|
28
|
+
#
|
29
|
+
# Clients should wait until `retry_delay` amount of time has passed since
|
30
|
+
# receiving the error response before retrying. If retrying requests also
|
31
|
+
# fail, clients should use an exponential backoff scheme to gradually increase
|
32
|
+
# the delay between retries based on `retry_delay`, until either a maximum
|
33
|
+
# number of retries have been reached or a maximum retry delay cap has been
|
34
|
+
# reached.
|
35
|
+
# @!attribute [rw] retry_delay
|
36
|
+
# @return [::Google::Protobuf::Duration]
|
37
|
+
# Clients should wait at least this long between retrying the same request.
|
38
|
+
class RetryInfo
|
39
|
+
include ::Google::Protobuf::MessageExts
|
40
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
41
|
+
end
|
42
|
+
|
43
|
+
# Describes additional debugging info.
|
44
|
+
# @!attribute [rw] stack_entries
|
45
|
+
# @return [::Array<::String>]
|
46
|
+
# The stack trace entries indicating where the error occurred.
|
47
|
+
# @!attribute [rw] detail
|
48
|
+
# @return [::String]
|
49
|
+
# Additional debugging information provided by the server.
|
50
|
+
class DebugInfo
|
51
|
+
include ::Google::Protobuf::MessageExts
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
|
55
|
+
# Describes how a quota check failed.
|
56
|
+
#
|
57
|
+
# For example if a daily limit was exceeded for the calling project,
|
58
|
+
# a service could respond with a QuotaFailure detail containing the project
|
59
|
+
# id and the description of the quota limit that was exceeded. If the
|
60
|
+
# calling project hasn't enabled the service in the developer console, then
|
61
|
+
# a service could respond with the project id and set `service_disabled`
|
62
|
+
# to true.
|
63
|
+
#
|
64
|
+
# Also see RetryInfo and Help types for other details about handling a
|
65
|
+
# quota failure.
|
66
|
+
# @!attribute [rw] violations
|
67
|
+
# @return [::Array<::Google::Rpc::QuotaFailure::Violation>]
|
68
|
+
# Describes all quota violations.
|
69
|
+
class QuotaFailure
|
70
|
+
include ::Google::Protobuf::MessageExts
|
71
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
72
|
+
|
73
|
+
# A message type used to describe a single quota violation. For example, a
|
74
|
+
# daily quota or a custom quota that was exceeded.
|
75
|
+
# @!attribute [rw] subject
|
76
|
+
# @return [::String]
|
77
|
+
# The subject on which the quota check failed.
|
78
|
+
# For example, "clientip:<ip address of client>" or "project:<Google
|
79
|
+
# developer project id>".
|
80
|
+
# @!attribute [rw] description
|
81
|
+
# @return [::String]
|
82
|
+
# A description of how the quota check failed. Clients can use this
|
83
|
+
# description to find more about the quota configuration in the service's
|
84
|
+
# public documentation, or find the relevant quota limit to adjust through
|
85
|
+
# developer console.
|
86
|
+
#
|
87
|
+
# For example: "Service disabled" or "Daily Limit for read operations
|
88
|
+
# exceeded".
|
89
|
+
class Violation
|
90
|
+
include ::Google::Protobuf::MessageExts
|
91
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
# Describes the cause of the error with structured details.
|
96
|
+
#
|
97
|
+
# Example of an error when contacting the "pubsub.googleapis.com" API when it
|
98
|
+
# is not enabled:
|
99
|
+
#
|
100
|
+
# { "reason": "API_DISABLED"
|
101
|
+
# "domain": "googleapis.com"
|
102
|
+
# "metadata": {
|
103
|
+
# "resource": "projects/123",
|
104
|
+
# "service": "pubsub.googleapis.com"
|
105
|
+
# }
|
106
|
+
# }
|
107
|
+
#
|
108
|
+
# This response indicates that the pubsub.googleapis.com API is not enabled.
|
109
|
+
#
|
110
|
+
# Example of an error that is returned when attempting to create a Spanner
|
111
|
+
# instance in a region that is out of stock:
|
112
|
+
#
|
113
|
+
# { "reason": "STOCKOUT"
|
114
|
+
# "domain": "spanner.googleapis.com",
|
115
|
+
# "metadata": {
|
116
|
+
# "availableRegions": "us-central1,us-east2"
|
117
|
+
# }
|
118
|
+
# }
|
119
|
+
# @!attribute [rw] reason
|
120
|
+
# @return [::String]
|
121
|
+
# The reason of the error. This is a constant value that identifies the
|
122
|
+
# proximate cause of the error. Error reasons are unique within a particular
|
123
|
+
# domain of errors. This should be at most 63 characters and match
|
124
|
+
# /[A-Z0-9_]+/.
|
125
|
+
# @!attribute [rw] domain
|
126
|
+
# @return [::String]
|
127
|
+
# The logical grouping to which the "reason" belongs. The error domain
|
128
|
+
# is typically the registered service name of the tool or product that
|
129
|
+
# generates the error. Example: "pubsub.googleapis.com". If the error is
|
130
|
+
# generated by some common infrastructure, the error domain must be a
|
131
|
+
# globally unique value that identifies the infrastructure. For Google API
|
132
|
+
# infrastructure, the error domain is "googleapis.com".
|
133
|
+
# @!attribute [rw] metadata
|
134
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
135
|
+
# Additional structured details about this error.
|
136
|
+
#
|
137
|
+
# Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
|
138
|
+
# length. When identifying the current value of an exceeded limit, the units
|
139
|
+
# should be contained in the key, not the value. For example, rather than
|
140
|
+
# \\{"instanceLimit": "100/request"}, should be returned as,
|
141
|
+
# \\{"instanceLimitPerRequest": "100"}, if the client exceeds the number of
|
142
|
+
# instances that can be created in a single (batch) request.
|
143
|
+
class ErrorInfo
|
144
|
+
include ::Google::Protobuf::MessageExts
|
145
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
146
|
+
|
147
|
+
# @!attribute [rw] key
|
148
|
+
# @return [::String]
|
149
|
+
# @!attribute [rw] value
|
150
|
+
# @return [::String]
|
151
|
+
class MetadataEntry
|
152
|
+
include ::Google::Protobuf::MessageExts
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
end
|
155
|
+
end
|
156
|
+
|
157
|
+
# Describes what preconditions have failed.
|
158
|
+
#
|
159
|
+
# For example, if an RPC failed because it required the Terms of Service to be
|
160
|
+
# acknowledged, it could list the terms of service violation in the
|
161
|
+
# PreconditionFailure message.
|
162
|
+
# @!attribute [rw] violations
|
163
|
+
# @return [::Array<::Google::Rpc::PreconditionFailure::Violation>]
|
164
|
+
# Describes all precondition violations.
|
165
|
+
class PreconditionFailure
|
166
|
+
include ::Google::Protobuf::MessageExts
|
167
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
168
|
+
|
169
|
+
# A message type used to describe a single precondition failure.
|
170
|
+
# @!attribute [rw] type
|
171
|
+
# @return [::String]
|
172
|
+
# The type of PreconditionFailure. We recommend using a service-specific
|
173
|
+
# enum type to define the supported precondition violation subjects. For
|
174
|
+
# example, "TOS" for "Terms of Service violation".
|
175
|
+
# @!attribute [rw] subject
|
176
|
+
# @return [::String]
|
177
|
+
# The subject, relative to the type, that failed.
|
178
|
+
# For example, "google.com/cloud" relative to the "TOS" type would indicate
|
179
|
+
# which terms of service is being referenced.
|
180
|
+
# @!attribute [rw] description
|
181
|
+
# @return [::String]
|
182
|
+
# A description of how the precondition failed. Developers can use this
|
183
|
+
# description to understand how to fix the failure.
|
184
|
+
#
|
185
|
+
# For example: "Terms of service not accepted".
|
186
|
+
class Violation
|
187
|
+
include ::Google::Protobuf::MessageExts
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
# Describes violations in a client request. This error type focuses on the
|
193
|
+
# syntactic aspects of the request.
|
194
|
+
# @!attribute [rw] field_violations
|
195
|
+
# @return [::Array<::Google::Rpc::BadRequest::FieldViolation>]
|
196
|
+
# Describes all violations in a client request.
|
197
|
+
class BadRequest
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
|
201
|
+
# A message type used to describe a single bad request field.
|
202
|
+
# @!attribute [rw] field
|
203
|
+
# @return [::String]
|
204
|
+
# A path leading to a field in the request body. The value will be a
|
205
|
+
# sequence of dot-separated identifiers that identify a protocol buffer
|
206
|
+
# field. E.g., "field_violations.field" would identify this field.
|
207
|
+
# @!attribute [rw] description
|
208
|
+
# @return [::String]
|
209
|
+
# A description of why the request element is bad.
|
210
|
+
class FieldViolation
|
211
|
+
include ::Google::Protobuf::MessageExts
|
212
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# Contains metadata about the request that clients can attach when filing a bug
|
217
|
+
# or providing other forms of feedback.
|
218
|
+
# @!attribute [rw] request_id
|
219
|
+
# @return [::String]
|
220
|
+
# An opaque string that should only be interpreted by the service generating
|
221
|
+
# it. For example, it can be used to identify requests in the service's logs.
|
222
|
+
# @!attribute [rw] serving_data
|
223
|
+
# @return [::String]
|
224
|
+
# Any data that was used to serve this request. For example, an encrypted
|
225
|
+
# stack trace that can be sent back to the service provider for debugging.
|
226
|
+
class RequestInfo
|
227
|
+
include ::Google::Protobuf::MessageExts
|
228
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
229
|
+
end
|
230
|
+
|
231
|
+
# Describes the resource that is being accessed.
|
232
|
+
# @!attribute [rw] resource_type
|
233
|
+
# @return [::String]
|
234
|
+
# A name for the type of resource being accessed, e.g. "sql table",
|
235
|
+
# "cloud storage bucket", "file", "Google calendar"; or the type URL
|
236
|
+
# of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
|
237
|
+
# @!attribute [rw] resource_name
|
238
|
+
# @return [::String]
|
239
|
+
# The name of the resource being accessed. For example, a shared calendar
|
240
|
+
# name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current
|
241
|
+
# error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
|
242
|
+
# @!attribute [rw] owner
|
243
|
+
# @return [::String]
|
244
|
+
# The owner of the resource (optional).
|
245
|
+
# For example, "user:<owner email>" or "project:<Google developer project
|
246
|
+
# id>".
|
247
|
+
# @!attribute [rw] description
|
248
|
+
# @return [::String]
|
249
|
+
# Describes what error is encountered when accessing this resource.
|
250
|
+
# For example, updating a cloud project may require the `writer` permission
|
251
|
+
# on the developer console project.
|
252
|
+
class ResourceInfo
|
253
|
+
include ::Google::Protobuf::MessageExts
|
254
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
255
|
+
end
|
256
|
+
|
257
|
+
# Provides links to documentation or for performing an out of band action.
|
258
|
+
#
|
259
|
+
# For example, if a quota check failed with an error indicating the calling
|
260
|
+
# project hasn't enabled the accessed service, this can contain a URL pointing
|
261
|
+
# directly to the right place in the developer console to flip the bit.
|
262
|
+
# @!attribute [rw] links
|
263
|
+
# @return [::Array<::Google::Rpc::Help::Link>]
|
264
|
+
# URL(s) pointing to additional information on handling the current error.
|
265
|
+
class Help
|
266
|
+
include ::Google::Protobuf::MessageExts
|
267
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
268
|
+
|
269
|
+
# Describes a URL link.
|
270
|
+
# @!attribute [rw] description
|
271
|
+
# @return [::String]
|
272
|
+
# Describes what the link offers.
|
273
|
+
# @!attribute [rw] url
|
274
|
+
# @return [::String]
|
275
|
+
# The URL of the link.
|
276
|
+
class Link
|
277
|
+
include ::Google::Protobuf::MessageExts
|
278
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
279
|
+
end
|
280
|
+
end
|
281
|
+
|
282
|
+
# Provides a localized error message that is safe to return to the user
|
283
|
+
# which can be attached to an RPC error.
|
284
|
+
# @!attribute [rw] locale
|
285
|
+
# @return [::String]
|
286
|
+
# The locale used following the specification defined at
|
287
|
+
# http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
|
288
|
+
# Examples are: "en-US", "fr-CH", "es-MX"
|
289
|
+
# @!attribute [rw] message
|
290
|
+
# @return [::String]
|
291
|
+
# The localized error message in the above locale.
|
292
|
+
class LocalizedMessage
|
293
|
+
include ::Google::Protobuf::MessageExts
|
294
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
295
|
+
end
|
296
|
+
end
|
297
|
+
end
|