google-cloud-monitoring-dashboard-v1 0.6.5 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/README.md +11 -6
  5. data/lib/google/cloud/monitoring/dashboard/v1/version.rb +1 -1
  6. data/lib/google/cloud/monitoring/dashboard/v1.rb +2 -0
  7. data/lib/google/monitoring/dashboard/v1/alertchart_pb.rb +2 -1
  8. data/lib/google/monitoring/dashboard/v1/collapsible_group_pb.rb +24 -0
  9. data/lib/google/monitoring/dashboard/v1/common_pb.rb +2 -2
  10. data/lib/google/monitoring/dashboard/v1/dashboard_filter_pb.rb +40 -0
  11. data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +5 -1
  12. data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +3 -3
  13. data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb +0 -1
  14. data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +2 -1
  15. data/lib/google/monitoring/dashboard/v1/logs_panel_pb.rb +25 -0
  16. data/lib/google/monitoring/dashboard/v1/metrics_pb.rb +9 -1
  17. data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +2 -2
  18. data/lib/google/monitoring/dashboard/v1/table_display_options_pb.rb +26 -0
  19. data/lib/google/monitoring/dashboard/v1/table_pb.rb +36 -0
  20. data/lib/google/monitoring/dashboard/v1/widget_pb.rb +8 -1
  21. data/lib/google/monitoring/dashboard/v1/xychart_pb.rb +10 -1
  22. data/proto_docs/google/api/resource.rb +10 -71
  23. data/proto_docs/google/monitoring/dashboard/v1/collapsible_group.rb +38 -0
  24. data/proto_docs/google/monitoring/dashboard/v1/dashboard.rb +15 -0
  25. data/proto_docs/google/monitoring/dashboard/v1/dashboard_filter.rb +69 -0
  26. data/proto_docs/google/monitoring/dashboard/v1/logs_panel.rb +44 -0
  27. data/proto_docs/google/monitoring/dashboard/v1/metrics.rb +16 -0
  28. data/proto_docs/google/monitoring/dashboard/v1/table.rb +63 -0
  29. data/proto_docs/google/monitoring/dashboard/v1/table_display_options.rb +38 -0
  30. data/proto_docs/google/monitoring/dashboard/v1/widget.rb +10 -0
  31. data/proto_docs/google/monitoring/dashboard/v1/xychart.rb +18 -0
  32. metadata +22 -16
  33. data/proto_docs/google/api/distribution.rb +0 -225
  34. data/proto_docs/google/protobuf/any.rb +0 -141
  35. data/proto_docs/google/protobuf/field_mask.rb +0 -229
  36. data/proto_docs/google/protobuf/timestamp.rb +0 -129
@@ -1,225 +0,0 @@
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
- # `Distribution` contains summary statistics for a population of values. It
23
- # optionally contains a histogram representing the distribution of those values
24
- # across a set of buckets.
25
- #
26
- # The summary statistics are the count, mean, sum of the squared deviation from
27
- # the mean, the minimum, and the maximum of the set of population of values.
28
- # The histogram is based on a sequence of buckets and gives a count of values
29
- # that fall into each bucket. The boundaries of the buckets are given either
30
- # explicitly or by formulas for buckets of fixed or exponentially increasing
31
- # widths.
32
- #
33
- # Although it is not forbidden, it is generally a bad idea to include
34
- # non-finite values (infinities or NaNs) in the population of values, as this
35
- # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
36
- # @!attribute [rw] count
37
- # @return [::Integer]
38
- # The number of values in the population. Must be non-negative. This value
39
- # must equal the sum of the values in `bucket_counts` if a histogram is
40
- # provided.
41
- # @!attribute [rw] mean
42
- # @return [::Float]
43
- # The arithmetic mean of the values in the population. If `count` is zero
44
- # then this field must be zero.
45
- # @!attribute [rw] sum_of_squared_deviation
46
- # @return [::Float]
47
- # The sum of squared deviations from the mean of the values in the
48
- # population. For values x_i this is:
49
- #
50
- # Sum[i=1..n]((x_i - mean)^2)
51
- #
52
- # Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
53
- # describes Welford's method for accumulating this sum in one pass.
54
- #
55
- # If `count` is zero then this field must be zero.
56
- # @!attribute [rw] range
57
- # @return [::Google::Api::Distribution::Range]
58
- # If specified, contains the range of the population values. The field
59
- # must not be present if the `count` is zero.
60
- # @!attribute [rw] bucket_options
61
- # @return [::Google::Api::Distribution::BucketOptions]
62
- # Defines the histogram bucket boundaries. If the distribution does not
63
- # contain a histogram, then omit this field.
64
- # @!attribute [rw] bucket_counts
65
- # @return [::Array<::Integer>]
66
- # The number of values in each bucket of the histogram, as described in
67
- # `bucket_options`. If the distribution does not have a histogram, then omit
68
- # this field. If there is a histogram, then the sum of the values in
69
- # `bucket_counts` must equal the value in the `count` field of the
70
- # distribution.
71
- #
72
- # If present, `bucket_counts` should contain N values, where N is the number
73
- # of buckets specified in `bucket_options`. If you supply fewer than N
74
- # values, the remaining values are assumed to be 0.
75
- #
76
- # The order of the values in `bucket_counts` follows the bucket numbering
77
- # schemes described for the three bucket types. The first value must be the
78
- # count for the underflow bucket (number 0). The next N-2 values are the
79
- # counts for the finite buckets (number 1 through N-2). The N'th value in
80
- # `bucket_counts` is the count for the overflow bucket (number N-1).
81
- # @!attribute [rw] exemplars
82
- # @return [::Array<::Google::Api::Distribution::Exemplar>]
83
- # Must be in increasing order of `value` field.
84
- class Distribution
85
- include ::Google::Protobuf::MessageExts
86
- extend ::Google::Protobuf::MessageExts::ClassMethods
87
-
88
- # The range of the population values.
89
- # @!attribute [rw] min
90
- # @return [::Float]
91
- # The minimum of the population values.
92
- # @!attribute [rw] max
93
- # @return [::Float]
94
- # The maximum of the population values.
95
- class Range
96
- include ::Google::Protobuf::MessageExts
97
- extend ::Google::Protobuf::MessageExts::ClassMethods
98
- end
99
-
100
- # `BucketOptions` describes the bucket boundaries used to create a histogram
101
- # for the distribution. The buckets can be in a linear sequence, an
102
- # exponential sequence, or each bucket can be specified explicitly.
103
- # `BucketOptions` does not include the number of values in each bucket.
104
- #
105
- # A bucket has an inclusive lower bound and exclusive upper bound for the
106
- # values that are counted for that bucket. The upper bound of a bucket must
107
- # be strictly greater than the lower bound. The sequence of N buckets for a
108
- # distribution consists of an underflow bucket (number 0), zero or more
109
- # finite buckets (number 1 through N - 2) and an overflow bucket (number N -
110
- # 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
111
- # same as the upper bound of bucket i - 1. The buckets span the whole range
112
- # of finite values: lower bound of the underflow bucket is -infinity and the
113
- # upper bound of the overflow bucket is +infinity. The finite buckets are
114
- # so-called because both bounds are finite.
115
- # @!attribute [rw] linear_buckets
116
- # @return [::Google::Api::Distribution::BucketOptions::Linear]
117
- # The linear bucket.
118
- # @!attribute [rw] exponential_buckets
119
- # @return [::Google::Api::Distribution::BucketOptions::Exponential]
120
- # The exponential buckets.
121
- # @!attribute [rw] explicit_buckets
122
- # @return [::Google::Api::Distribution::BucketOptions::Explicit]
123
- # The explicit buckets.
124
- class BucketOptions
125
- include ::Google::Protobuf::MessageExts
126
- extend ::Google::Protobuf::MessageExts::ClassMethods
127
-
128
- # Specifies a linear sequence of buckets that all have the same width
129
- # (except overflow and underflow). Each bucket represents a constant
130
- # absolute uncertainty on the specific value in the bucket.
131
- #
132
- # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
133
- # following boundaries:
134
- #
135
- # Upper bound (0 <= i < N-1): offset + (width * i).
136
- # Lower bound (1 <= i < N): offset + (width * (i - 1)).
137
- # @!attribute [rw] num_finite_buckets
138
- # @return [::Integer]
139
- # Must be greater than 0.
140
- # @!attribute [rw] width
141
- # @return [::Float]
142
- # Must be greater than 0.
143
- # @!attribute [rw] offset
144
- # @return [::Float]
145
- # Lower bound of the first bucket.
146
- class Linear
147
- include ::Google::Protobuf::MessageExts
148
- extend ::Google::Protobuf::MessageExts::ClassMethods
149
- end
150
-
151
- # Specifies an exponential sequence of buckets that have a width that is
152
- # proportional to the value of the lower bound. Each bucket represents a
153
- # constant relative uncertainty on a specific value in the bucket.
154
- #
155
- # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
156
- # following boundaries:
157
- #
158
- # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
159
- # Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
160
- # @!attribute [rw] num_finite_buckets
161
- # @return [::Integer]
162
- # Must be greater than 0.
163
- # @!attribute [rw] growth_factor
164
- # @return [::Float]
165
- # Must be greater than 1.
166
- # @!attribute [rw] scale
167
- # @return [::Float]
168
- # Must be greater than 0.
169
- class Exponential
170
- include ::Google::Protobuf::MessageExts
171
- extend ::Google::Protobuf::MessageExts::ClassMethods
172
- end
173
-
174
- # Specifies a set of buckets with arbitrary widths.
175
- #
176
- # There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
177
- # boundaries:
178
- #
179
- # Upper bound (0 <= i < N-1): bounds[i]
180
- # Lower bound (1 <= i < N); bounds[i - 1]
181
- #
182
- # The `bounds` field must contain at least one element. If `bounds` has
183
- # only one element, then there are no finite buckets, and that single
184
- # element is the common boundary of the overflow and underflow buckets.
185
- # @!attribute [rw] bounds
186
- # @return [::Array<::Float>]
187
- # The values must be monotonically increasing.
188
- class Explicit
189
- include ::Google::Protobuf::MessageExts
190
- extend ::Google::Protobuf::MessageExts::ClassMethods
191
- end
192
- end
193
-
194
- # Exemplars are example points that may be used to annotate aggregated
195
- # distribution values. They are metadata that gives information about a
196
- # particular value added to a Distribution bucket, such as a trace ID that
197
- # was active when a value was added. They may contain further information,
198
- # such as a example values and timestamps, origin, etc.
199
- # @!attribute [rw] value
200
- # @return [::Float]
201
- # Value of the exemplar point. This value determines to which bucket the
202
- # exemplar belongs.
203
- # @!attribute [rw] timestamp
204
- # @return [::Google::Protobuf::Timestamp]
205
- # The observation (sampling) time of the above value.
206
- # @!attribute [rw] attachments
207
- # @return [::Array<::Google::Protobuf::Any>]
208
- # Contextual information about the example value. Examples are:
209
- #
210
- # Trace: type.googleapis.com/google.monitoring.v3.SpanContext
211
- #
212
- # Literal string: type.googleapis.com/google.protobuf.StringValue
213
- #
214
- # Labels dropped during aggregation:
215
- # type.googleapis.com/google.monitoring.v3.DroppedLabels
216
- #
217
- # There may be only a single attachment of any given message type in a
218
- # single exemplar, and this is enforced by the system.
219
- class Exemplar
220
- include ::Google::Protobuf::MessageExts
221
- extend ::Google::Protobuf::MessageExts::ClassMethods
222
- end
223
- end
224
- end
225
- end
@@ -1,141 +0,0 @@
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 Protobuf
22
- # `Any` contains an arbitrary serialized protocol buffer message along with a
23
- # URL that describes the type of the serialized message.
24
- #
25
- # Protobuf library provides support to pack/unpack Any values in the form
26
- # of utility functions or additional generated methods of the Any type.
27
- #
28
- # Example 1: Pack and unpack a message in C++.
29
- #
30
- # Foo foo = ...;
31
- # Any any;
32
- # any.PackFrom(foo);
33
- # ...
34
- # if (any.UnpackTo(&foo)) {
35
- # ...
36
- # }
37
- #
38
- # Example 2: Pack and unpack a message in Java.
39
- #
40
- # Foo foo = ...;
41
- # Any any = Any.pack(foo);
42
- # ...
43
- # if (any.is(Foo.class)) {
44
- # foo = any.unpack(Foo.class);
45
- # }
46
- #
47
- # Example 3: Pack and unpack a message in Python.
48
- #
49
- # foo = Foo(...)
50
- # any = Any()
51
- # any.Pack(foo)
52
- # ...
53
- # if any.Is(Foo.DESCRIPTOR):
54
- # any.Unpack(foo)
55
- # ...
56
- #
57
- # Example 4: Pack and unpack a message in Go
58
- #
59
- # foo := &pb.Foo{...}
60
- # any, err := anypb.New(foo)
61
- # if err != nil {
62
- # ...
63
- # }
64
- # ...
65
- # foo := &pb.Foo{}
66
- # if err := any.UnmarshalTo(foo); err != nil {
67
- # ...
68
- # }
69
- #
70
- # The pack methods provided by protobuf library will by default use
71
- # 'type.googleapis.com/full.type.name' as the type URL and the unpack
72
- # methods only use the fully qualified type name after the last '/'
73
- # in the type URL, for example "foo.bar.com/x/y.z" will yield type
74
- # name "y.z".
75
- #
76
- #
77
- # JSON
78
- # ====
79
- # The JSON representation of an `Any` value uses the regular
80
- # representation of the deserialized, embedded message, with an
81
- # additional field `@type` which contains the type URL. Example:
82
- #
83
- # package google.profile;
84
- # message Person {
85
- # string first_name = 1;
86
- # string last_name = 2;
87
- # }
88
- #
89
- # {
90
- # "@type": "type.googleapis.com/google.profile.Person",
91
- # "firstName": <string>,
92
- # "lastName": <string>
93
- # }
94
- #
95
- # If the embedded message type is well-known and has a custom JSON
96
- # representation, that representation will be embedded adding a field
97
- # `value` which holds the custom JSON in addition to the `@type`
98
- # field. Example (for message [google.protobuf.Duration][]):
99
- #
100
- # {
101
- # "@type": "type.googleapis.com/google.protobuf.Duration",
102
- # "value": "1.212s"
103
- # }
104
- # @!attribute [rw] type_url
105
- # @return [::String]
106
- # A URL/resource name that uniquely identifies the type of the serialized
107
- # protocol buffer message. This string must contain at least
108
- # one "/" character. The last segment of the URL's path must represent
109
- # the fully qualified name of the type (as in
110
- # `path/google.protobuf.Duration`). The name should be in a canonical form
111
- # (e.g., leading "." is not accepted).
112
- #
113
- # In practice, teams usually precompile into the binary all types that they
114
- # expect it to use in the context of Any. However, for URLs which use the
115
- # scheme `http`, `https`, or no scheme, one can optionally set up a type
116
- # server that maps type URLs to message definitions as follows:
117
- #
118
- # * If no scheme is provided, `https` is assumed.
119
- # * An HTTP GET on the URL must yield a [google.protobuf.Type][]
120
- # value in binary format, or produce an error.
121
- # * Applications are allowed to cache lookup results based on the
122
- # URL, or have them precompiled into a binary to avoid any
123
- # lookup. Therefore, binary compatibility needs to be preserved
124
- # on changes to types. (Use versioned type names to manage
125
- # breaking changes.)
126
- #
127
- # Note: this functionality is not currently available in the official
128
- # protobuf release, and it is not used for type URLs beginning with
129
- # type.googleapis.com.
130
- #
131
- # Schemes other than `http`, `https` (or the empty scheme) might be
132
- # used with implementation specific semantics.
133
- # @!attribute [rw] value
134
- # @return [::String]
135
- # Must be a valid serialized protocol buffer of the above specified type.
136
- class Any
137
- include ::Google::Protobuf::MessageExts
138
- extend ::Google::Protobuf::MessageExts::ClassMethods
139
- end
140
- end
141
- end
@@ -1,229 +0,0 @@
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 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