google-apis-discoveryengine_v1 0.20.0 → 0.22.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/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1213 -52
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +514 -11
- data/lib/google/apis/discoveryengine_v1/service.rb +135 -0
- metadata +4 -4
@@ -22,6 +22,320 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module DiscoveryengineV1
|
24
24
|
|
25
|
+
# `Distribution` contains summary statistics for a population of values. It
|
26
|
+
# optionally contains a histogram representing the distribution of those values
|
27
|
+
# across a set of buckets. The summary statistics are the count, mean, sum of
|
28
|
+
# the squared deviation from the mean, the minimum, and the maximum of the set
|
29
|
+
# of population of values. The histogram is based on a sequence of buckets and
|
30
|
+
# gives a count of values that fall into each bucket. The boundaries of the
|
31
|
+
# buckets are given either explicitly or by formulas for buckets of fixed or
|
32
|
+
# exponentially increasing widths. Although it is not forbidden, it is generally
|
33
|
+
# a bad idea to include non-finite values (infinities or NaNs) in the population
|
34
|
+
# of values, as this will render the `mean` and `sum_of_squared_deviation`
|
35
|
+
# fields meaningless.
|
36
|
+
class GoogleApiDistribution
|
37
|
+
include Google::Apis::Core::Hashable
|
38
|
+
|
39
|
+
# The number of values in each bucket of the histogram, as described in `
|
40
|
+
# bucket_options`. If the distribution does not have a histogram, then omit this
|
41
|
+
# field. If there is a histogram, then the sum of the values in `bucket_counts`
|
42
|
+
# must equal the value in the `count` field of the distribution. If present, `
|
43
|
+
# bucket_counts` should contain N values, where N is the number of buckets
|
44
|
+
# specified in `bucket_options`. If you supply fewer than N values, the
|
45
|
+
# remaining values are assumed to be 0. The order of the values in `
|
46
|
+
# bucket_counts` follows the bucket numbering schemes described for the three
|
47
|
+
# bucket types. The first value must be the count for the underflow bucket (
|
48
|
+
# number 0). The next N-2 values are the counts for the finite buckets (number 1
|
49
|
+
# through N-2). The N'th value in `bucket_counts` is the count for the overflow
|
50
|
+
# bucket (number N-1).
|
51
|
+
# Corresponds to the JSON property `bucketCounts`
|
52
|
+
# @return [Array<Fixnum>]
|
53
|
+
attr_accessor :bucket_counts
|
54
|
+
|
55
|
+
# `BucketOptions` describes the bucket boundaries used to create a histogram for
|
56
|
+
# the distribution. The buckets can be in a linear sequence, an exponential
|
57
|
+
# sequence, or each bucket can be specified explicitly. `BucketOptions` does not
|
58
|
+
# include the number of values in each bucket. A bucket has an inclusive lower
|
59
|
+
# bound and exclusive upper bound for the values that are counted for that
|
60
|
+
# bucket. The upper bound of a bucket must be strictly greater than the lower
|
61
|
+
# bound. The sequence of N buckets for a distribution consists of an underflow
|
62
|
+
# bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an
|
63
|
+
# overflow bucket (number N - 1). The buckets are contiguous: the lower bound of
|
64
|
+
# bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets
|
65
|
+
# span the whole range of finite values: lower bound of the underflow bucket is -
|
66
|
+
# infinity and the upper bound of the overflow bucket is +infinity. The finite
|
67
|
+
# buckets are so-called because both bounds are finite.
|
68
|
+
# Corresponds to the JSON property `bucketOptions`
|
69
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptions]
|
70
|
+
attr_accessor :bucket_options
|
71
|
+
|
72
|
+
# The number of values in the population. Must be non-negative. This value must
|
73
|
+
# equal the sum of the values in `bucket_counts` if a histogram is provided.
|
74
|
+
# Corresponds to the JSON property `count`
|
75
|
+
# @return [Fixnum]
|
76
|
+
attr_accessor :count
|
77
|
+
|
78
|
+
# Must be in increasing order of `value` field.
|
79
|
+
# Corresponds to the JSON property `exemplars`
|
80
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleApiDistributionExemplar>]
|
81
|
+
attr_accessor :exemplars
|
82
|
+
|
83
|
+
# The arithmetic mean of the values in the population. If `count` is zero then
|
84
|
+
# this field must be zero.
|
85
|
+
# Corresponds to the JSON property `mean`
|
86
|
+
# @return [Float]
|
87
|
+
attr_accessor :mean
|
88
|
+
|
89
|
+
# The range of the population values.
|
90
|
+
# Corresponds to the JSON property `range`
|
91
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistributionRange]
|
92
|
+
attr_accessor :range
|
93
|
+
|
94
|
+
# The sum of squared deviations from the mean of the values in the population.
|
95
|
+
# For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of
|
96
|
+
# Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's
|
97
|
+
# method for accumulating this sum in one pass. If `count` is zero then this
|
98
|
+
# field must be zero.
|
99
|
+
# Corresponds to the JSON property `sumOfSquaredDeviation`
|
100
|
+
# @return [Float]
|
101
|
+
attr_accessor :sum_of_squared_deviation
|
102
|
+
|
103
|
+
def initialize(**args)
|
104
|
+
update!(**args)
|
105
|
+
end
|
106
|
+
|
107
|
+
# Update properties of this object
|
108
|
+
def update!(**args)
|
109
|
+
@bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts)
|
110
|
+
@bucket_options = args[:bucket_options] if args.key?(:bucket_options)
|
111
|
+
@count = args[:count] if args.key?(:count)
|
112
|
+
@exemplars = args[:exemplars] if args.key?(:exemplars)
|
113
|
+
@mean = args[:mean] if args.key?(:mean)
|
114
|
+
@range = args[:range] if args.key?(:range)
|
115
|
+
@sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation)
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
# `BucketOptions` describes the bucket boundaries used to create a histogram for
|
120
|
+
# the distribution. The buckets can be in a linear sequence, an exponential
|
121
|
+
# sequence, or each bucket can be specified explicitly. `BucketOptions` does not
|
122
|
+
# include the number of values in each bucket. A bucket has an inclusive lower
|
123
|
+
# bound and exclusive upper bound for the values that are counted for that
|
124
|
+
# bucket. The upper bound of a bucket must be strictly greater than the lower
|
125
|
+
# bound. The sequence of N buckets for a distribution consists of an underflow
|
126
|
+
# bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an
|
127
|
+
# overflow bucket (number N - 1). The buckets are contiguous: the lower bound of
|
128
|
+
# bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets
|
129
|
+
# span the whole range of finite values: lower bound of the underflow bucket is -
|
130
|
+
# infinity and the upper bound of the overflow bucket is +infinity. The finite
|
131
|
+
# buckets are so-called because both bounds are finite.
|
132
|
+
class GoogleApiDistributionBucketOptions
|
133
|
+
include Google::Apis::Core::Hashable
|
134
|
+
|
135
|
+
# Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1`
|
136
|
+
# (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i <
|
137
|
+
# N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field
|
138
|
+
# must contain at least one element. If `bounds` has only one element, then
|
139
|
+
# there are no finite buckets, and that single element is the common boundary of
|
140
|
+
# the overflow and underflow buckets.
|
141
|
+
# Corresponds to the JSON property `explicitBuckets`
|
142
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptionsExplicit]
|
143
|
+
attr_accessor :explicit_buckets
|
144
|
+
|
145
|
+
# Specifies an exponential sequence of buckets that have a width that is
|
146
|
+
# proportional to the value of the lower bound. Each bucket represents a
|
147
|
+
# constant relative uncertainty on a specific value in the bucket. There are `
|
148
|
+
# num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries:
|
149
|
+
# Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i <
|
150
|
+
# N): scale * (growth_factor ^ (i - 1)).
|
151
|
+
# Corresponds to the JSON property `exponentialBuckets`
|
152
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptionsExponential]
|
153
|
+
attr_accessor :exponential_buckets
|
154
|
+
|
155
|
+
# Specifies a linear sequence of buckets that all have the same width (except
|
156
|
+
# overflow and underflow). Each bucket represents a constant absolute
|
157
|
+
# uncertainty on the specific value in the bucket. There are `num_finite_buckets
|
158
|
+
# + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <=
|
159
|
+
# i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i
|
160
|
+
# - 1)).
|
161
|
+
# Corresponds to the JSON property `linearBuckets`
|
162
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptionsLinear]
|
163
|
+
attr_accessor :linear_buckets
|
164
|
+
|
165
|
+
def initialize(**args)
|
166
|
+
update!(**args)
|
167
|
+
end
|
168
|
+
|
169
|
+
# Update properties of this object
|
170
|
+
def update!(**args)
|
171
|
+
@explicit_buckets = args[:explicit_buckets] if args.key?(:explicit_buckets)
|
172
|
+
@exponential_buckets = args[:exponential_buckets] if args.key?(:exponential_buckets)
|
173
|
+
@linear_buckets = args[:linear_buckets] if args.key?(:linear_buckets)
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
# Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1`
|
178
|
+
# (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i <
|
179
|
+
# N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field
|
180
|
+
# must contain at least one element. If `bounds` has only one element, then
|
181
|
+
# there are no finite buckets, and that single element is the common boundary of
|
182
|
+
# the overflow and underflow buckets.
|
183
|
+
class GoogleApiDistributionBucketOptionsExplicit
|
184
|
+
include Google::Apis::Core::Hashable
|
185
|
+
|
186
|
+
# The values must be monotonically increasing.
|
187
|
+
# Corresponds to the JSON property `bounds`
|
188
|
+
# @return [Array<Float>]
|
189
|
+
attr_accessor :bounds
|
190
|
+
|
191
|
+
def initialize(**args)
|
192
|
+
update!(**args)
|
193
|
+
end
|
194
|
+
|
195
|
+
# Update properties of this object
|
196
|
+
def update!(**args)
|
197
|
+
@bounds = args[:bounds] if args.key?(:bounds)
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
# Specifies an exponential sequence of buckets that have a width that is
|
202
|
+
# proportional to the value of the lower bound. Each bucket represents a
|
203
|
+
# constant relative uncertainty on a specific value in the bucket. There are `
|
204
|
+
# num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries:
|
205
|
+
# Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i <
|
206
|
+
# N): scale * (growth_factor ^ (i - 1)).
|
207
|
+
class GoogleApiDistributionBucketOptionsExponential
|
208
|
+
include Google::Apis::Core::Hashable
|
209
|
+
|
210
|
+
# Must be greater than 1.
|
211
|
+
# Corresponds to the JSON property `growthFactor`
|
212
|
+
# @return [Float]
|
213
|
+
attr_accessor :growth_factor
|
214
|
+
|
215
|
+
# Must be greater than 0.
|
216
|
+
# Corresponds to the JSON property `numFiniteBuckets`
|
217
|
+
# @return [Fixnum]
|
218
|
+
attr_accessor :num_finite_buckets
|
219
|
+
|
220
|
+
# Must be greater than 0.
|
221
|
+
# Corresponds to the JSON property `scale`
|
222
|
+
# @return [Float]
|
223
|
+
attr_accessor :scale
|
224
|
+
|
225
|
+
def initialize(**args)
|
226
|
+
update!(**args)
|
227
|
+
end
|
228
|
+
|
229
|
+
# Update properties of this object
|
230
|
+
def update!(**args)
|
231
|
+
@growth_factor = args[:growth_factor] if args.key?(:growth_factor)
|
232
|
+
@num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets)
|
233
|
+
@scale = args[:scale] if args.key?(:scale)
|
234
|
+
end
|
235
|
+
end
|
236
|
+
|
237
|
+
# Specifies a linear sequence of buckets that all have the same width (except
|
238
|
+
# overflow and underflow). Each bucket represents a constant absolute
|
239
|
+
# uncertainty on the specific value in the bucket. There are `num_finite_buckets
|
240
|
+
# + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <=
|
241
|
+
# i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i
|
242
|
+
# - 1)).
|
243
|
+
class GoogleApiDistributionBucketOptionsLinear
|
244
|
+
include Google::Apis::Core::Hashable
|
245
|
+
|
246
|
+
# Must be greater than 0.
|
247
|
+
# Corresponds to the JSON property `numFiniteBuckets`
|
248
|
+
# @return [Fixnum]
|
249
|
+
attr_accessor :num_finite_buckets
|
250
|
+
|
251
|
+
# Lower bound of the first bucket.
|
252
|
+
# Corresponds to the JSON property `offset`
|
253
|
+
# @return [Float]
|
254
|
+
attr_accessor :offset
|
255
|
+
|
256
|
+
# Must be greater than 0.
|
257
|
+
# Corresponds to the JSON property `width`
|
258
|
+
# @return [Float]
|
259
|
+
attr_accessor :width
|
260
|
+
|
261
|
+
def initialize(**args)
|
262
|
+
update!(**args)
|
263
|
+
end
|
264
|
+
|
265
|
+
# Update properties of this object
|
266
|
+
def update!(**args)
|
267
|
+
@num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets)
|
268
|
+
@offset = args[:offset] if args.key?(:offset)
|
269
|
+
@width = args[:width] if args.key?(:width)
|
270
|
+
end
|
271
|
+
end
|
272
|
+
|
273
|
+
# Exemplars are example points that may be used to annotate aggregated
|
274
|
+
# distribution values. They are metadata that gives information about a
|
275
|
+
# particular value added to a Distribution bucket, such as a trace ID that was
|
276
|
+
# active when a value was added. They may contain further information, such as a
|
277
|
+
# example values and timestamps, origin, etc.
|
278
|
+
class GoogleApiDistributionExemplar
|
279
|
+
include Google::Apis::Core::Hashable
|
280
|
+
|
281
|
+
# Contextual information about the example value. Examples are: Trace: type.
|
282
|
+
# googleapis.com/google.monitoring.v3.SpanContext Literal string: type.
|
283
|
+
# googleapis.com/google.protobuf.StringValue Labels dropped during aggregation:
|
284
|
+
# type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a
|
285
|
+
# single attachment of any given message type in a single exemplar, and this is
|
286
|
+
# enforced by the system.
|
287
|
+
# Corresponds to the JSON property `attachments`
|
288
|
+
# @return [Array<Hash<String,Object>>]
|
289
|
+
attr_accessor :attachments
|
290
|
+
|
291
|
+
# The observation (sampling) time of the above value.
|
292
|
+
# Corresponds to the JSON property `timestamp`
|
293
|
+
# @return [String]
|
294
|
+
attr_accessor :timestamp
|
295
|
+
|
296
|
+
# Value of the exemplar point. This value determines to which bucket the
|
297
|
+
# exemplar belongs.
|
298
|
+
# Corresponds to the JSON property `value`
|
299
|
+
# @return [Float]
|
300
|
+
attr_accessor :value
|
301
|
+
|
302
|
+
def initialize(**args)
|
303
|
+
update!(**args)
|
304
|
+
end
|
305
|
+
|
306
|
+
# Update properties of this object
|
307
|
+
def update!(**args)
|
308
|
+
@attachments = args[:attachments] if args.key?(:attachments)
|
309
|
+
@timestamp = args[:timestamp] if args.key?(:timestamp)
|
310
|
+
@value = args[:value] if args.key?(:value)
|
311
|
+
end
|
312
|
+
end
|
313
|
+
|
314
|
+
# The range of the population values.
|
315
|
+
class GoogleApiDistributionRange
|
316
|
+
include Google::Apis::Core::Hashable
|
317
|
+
|
318
|
+
# The maximum of the population values.
|
319
|
+
# Corresponds to the JSON property `max`
|
320
|
+
# @return [Float]
|
321
|
+
attr_accessor :max
|
322
|
+
|
323
|
+
# The minimum of the population values.
|
324
|
+
# Corresponds to the JSON property `min`
|
325
|
+
# @return [Float]
|
326
|
+
attr_accessor :min
|
327
|
+
|
328
|
+
def initialize(**args)
|
329
|
+
update!(**args)
|
330
|
+
end
|
331
|
+
|
332
|
+
# Update properties of this object
|
333
|
+
def update!(**args)
|
334
|
+
@max = args[:max] if args.key?(:max)
|
335
|
+
@min = args[:min] if args.key?(:min)
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
25
339
|
# Message that represents an arbitrary HTTP body. It should only be used for
|
26
340
|
# payload formats that can't be represented as JSON, such as raw binary or an
|
27
341
|
# HTML page. This message can be used both in streaming and non-streaming API
|
@@ -70,6 +384,107 @@ module Google
|
|
70
384
|
end
|
71
385
|
end
|
72
386
|
|
387
|
+
# A specific metric, identified by specifying values for all of the labels of a `
|
388
|
+
# MetricDescriptor`.
|
389
|
+
class GoogleApiMetric
|
390
|
+
include Google::Apis::Core::Hashable
|
391
|
+
|
392
|
+
# The set of label values that uniquely identify this metric. All labels listed
|
393
|
+
# in the `MetricDescriptor` must be assigned values.
|
394
|
+
# Corresponds to the JSON property `labels`
|
395
|
+
# @return [Hash<String,String>]
|
396
|
+
attr_accessor :labels
|
397
|
+
|
398
|
+
# An existing metric type, see google.api.MetricDescriptor. For example, `custom.
|
399
|
+
# googleapis.com/invoice/paid/amount`.
|
400
|
+
# Corresponds to the JSON property `type`
|
401
|
+
# @return [String]
|
402
|
+
attr_accessor :type
|
403
|
+
|
404
|
+
def initialize(**args)
|
405
|
+
update!(**args)
|
406
|
+
end
|
407
|
+
|
408
|
+
# Update properties of this object
|
409
|
+
def update!(**args)
|
410
|
+
@labels = args[:labels] if args.key?(:labels)
|
411
|
+
@type = args[:type] if args.key?(:type)
|
412
|
+
end
|
413
|
+
end
|
414
|
+
|
415
|
+
# An object representing a resource that can be used for monitoring, logging,
|
416
|
+
# billing, or other purposes. Examples include virtual machine instances,
|
417
|
+
# databases, and storage devices such as disks. The `type` field identifies a
|
418
|
+
# MonitoredResourceDescriptor object that describes the resource's schema.
|
419
|
+
# Information in the `labels` field identifies the actual resource and its
|
420
|
+
# attributes according to the schema. For example, a particular Compute Engine
|
421
|
+
# VM instance could be represented by the following object, because the
|
422
|
+
# MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"
|
423
|
+
# instance_id"` and `"zone"`: ` "type": "gce_instance", "labels": ` "project_id":
|
424
|
+
# "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" ``
|
425
|
+
class GoogleApiMonitoredResource
|
426
|
+
include Google::Apis::Core::Hashable
|
427
|
+
|
428
|
+
# Required. Values for all of the labels listed in the associated monitored
|
429
|
+
# resource descriptor. For example, Compute Engine VM instances use the labels `"
|
430
|
+
# project_id"`, `"instance_id"`, and `"zone"`.
|
431
|
+
# Corresponds to the JSON property `labels`
|
432
|
+
# @return [Hash<String,String>]
|
433
|
+
attr_accessor :labels
|
434
|
+
|
435
|
+
# Required. The monitored resource type. This field must match the `type` field
|
436
|
+
# of a MonitoredResourceDescriptor object. For example, the type of a Compute
|
437
|
+
# Engine VM instance is `gce_instance`. Some descriptors include the service
|
438
|
+
# name in the type; for example, the type of a Datastream stream is `datastream.
|
439
|
+
# googleapis.com/Stream`.
|
440
|
+
# Corresponds to the JSON property `type`
|
441
|
+
# @return [String]
|
442
|
+
attr_accessor :type
|
443
|
+
|
444
|
+
def initialize(**args)
|
445
|
+
update!(**args)
|
446
|
+
end
|
447
|
+
|
448
|
+
# Update properties of this object
|
449
|
+
def update!(**args)
|
450
|
+
@labels = args[:labels] if args.key?(:labels)
|
451
|
+
@type = args[:type] if args.key?(:type)
|
452
|
+
end
|
453
|
+
end
|
454
|
+
|
455
|
+
# Auxiliary metadata for a MonitoredResource object. MonitoredResource objects
|
456
|
+
# contain the minimum set of information to uniquely identify a monitored
|
457
|
+
# resource instance. There is some other useful auxiliary metadata. Monitoring
|
458
|
+
# and Logging use an ingestion pipeline to extract metadata for cloud resources
|
459
|
+
# of all types, and store the metadata in this message.
|
460
|
+
class GoogleApiMonitoredResourceMetadata
|
461
|
+
include Google::Apis::Core::Hashable
|
462
|
+
|
463
|
+
# Output only. Values for predefined system metadata labels. System labels are a
|
464
|
+
# kind of metadata extracted by Google, including "machine_image", "vpc", "
|
465
|
+
# subnet_id", "security_group", "name", etc. System label values can be only
|
466
|
+
# strings, Boolean values, or a list of strings. For example: ` "name": "my-test-
|
467
|
+
# instance", "security_group": ["a", "b", "c"], "spot_instance": false `
|
468
|
+
# Corresponds to the JSON property `systemLabels`
|
469
|
+
# @return [Hash<String,Object>]
|
470
|
+
attr_accessor :system_labels
|
471
|
+
|
472
|
+
# Output only. A map of user-defined metadata labels.
|
473
|
+
# Corresponds to the JSON property `userLabels`
|
474
|
+
# @return [Hash<String,String>]
|
475
|
+
attr_accessor :user_labels
|
476
|
+
|
477
|
+
def initialize(**args)
|
478
|
+
update!(**args)
|
479
|
+
end
|
480
|
+
|
481
|
+
# Update properties of this object
|
482
|
+
def update!(**args)
|
483
|
+
@system_labels = args[:system_labels] if args.key?(:system_labels)
|
484
|
+
@user_labels = args[:user_labels] if args.key?(:user_labels)
|
485
|
+
end
|
486
|
+
end
|
487
|
+
|
73
488
|
# A description of the context in which an error occurred.
|
74
489
|
class GoogleCloudDiscoveryengineLoggingErrorContext
|
75
490
|
include Google::Apis::Core::Hashable
|
@@ -498,6 +913,11 @@ module Google
|
|
498
913
|
attr_accessor :asynchronous_mode
|
499
914
|
alias_method :asynchronous_mode?, :asynchronous_mode
|
500
915
|
|
916
|
+
# Grounding specification.
|
917
|
+
# Corresponds to the JSON property `groundingSpec`
|
918
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec]
|
919
|
+
attr_accessor :grounding_spec
|
920
|
+
|
501
921
|
# Defines a user inputed query.
|
502
922
|
# Corresponds to the JSON property `query`
|
503
923
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query]
|
@@ -565,6 +985,7 @@ module Google
|
|
565
985
|
def update!(**args)
|
566
986
|
@answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
|
567
987
|
@asynchronous_mode = args[:asynchronous_mode] if args.key?(:asynchronous_mode)
|
988
|
+
@grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
|
568
989
|
@query = args[:query] if args.key?(:query)
|
569
990
|
@query_understanding_spec = args[:query_understanding_spec] if args.key?(:query_understanding_spec)
|
570
991
|
@related_questions_spec = args[:related_questions_spec] if args.key?(:related_questions_spec)
|
@@ -704,6 +1125,28 @@ module Google
|
|
704
1125
|
end
|
705
1126
|
end
|
706
1127
|
|
1128
|
+
# Grounding specification.
|
1129
|
+
class GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
|
1130
|
+
include Google::Apis::Core::Hashable
|
1131
|
+
|
1132
|
+
# Optional. Specifies whether to include grounding_supports in the answer. The
|
1133
|
+
# default value is `false`. When this field is set to `true`, returned answer
|
1134
|
+
# will have `grounding_score` and will contain GroundingSupports for each claim.
|
1135
|
+
# Corresponds to the JSON property `includeGroundingSupports`
|
1136
|
+
# @return [Boolean]
|
1137
|
+
attr_accessor :include_grounding_supports
|
1138
|
+
alias_method :include_grounding_supports?, :include_grounding_supports
|
1139
|
+
|
1140
|
+
def initialize(**args)
|
1141
|
+
update!(**args)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Update properties of this object
|
1145
|
+
def update!(**args)
|
1146
|
+
@include_grounding_supports = args[:include_grounding_supports] if args.key?(:include_grounding_supports)
|
1147
|
+
end
|
1148
|
+
end
|
1149
|
+
|
707
1150
|
# Query understanding specification.
|
708
1151
|
class GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec
|
709
1152
|
include Google::Apis::Core::Hashable
|
@@ -2094,9 +2537,15 @@ module Google
|
|
2094
2537
|
# List of facts cited across all claims in the answer candidate. These are
|
2095
2538
|
# derived from the facts supplied in the request.
|
2096
2539
|
# Corresponds to the JSON property `citedChunks`
|
2097
|
-
# @return [Array<Google::Apis::DiscoveryengineV1::
|
2540
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk>]
|
2098
2541
|
attr_accessor :cited_chunks
|
2099
2542
|
|
2543
|
+
# List of facts cited across all claims in the answer candidate. These are
|
2544
|
+
# derived from the facts supplied in the request.
|
2545
|
+
# Corresponds to the JSON property `citedFacts`
|
2546
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk>]
|
2547
|
+
attr_accessor :cited_facts
|
2548
|
+
|
2100
2549
|
# Claim texts and citation info across all claims in the answer candidate.
|
2101
2550
|
# Corresponds to the JSON property `claims`
|
2102
2551
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim>]
|
@@ -2116,11 +2565,31 @@ module Google
|
|
2116
2565
|
# Update properties of this object
|
2117
2566
|
def update!(**args)
|
2118
2567
|
@cited_chunks = args[:cited_chunks] if args.key?(:cited_chunks)
|
2568
|
+
@cited_facts = args[:cited_facts] if args.key?(:cited_facts)
|
2119
2569
|
@claims = args[:claims] if args.key?(:claims)
|
2120
2570
|
@support_score = args[:support_score] if args.key?(:support_score)
|
2121
2571
|
end
|
2122
2572
|
end
|
2123
2573
|
|
2574
|
+
# Fact chunk for grounding check.
|
2575
|
+
class GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk
|
2576
|
+
include Google::Apis::Core::Hashable
|
2577
|
+
|
2578
|
+
# Text content of the fact chunk. Can be at most 10K characters long.
|
2579
|
+
# Corresponds to the JSON property `chunkText`
|
2580
|
+
# @return [String]
|
2581
|
+
attr_accessor :chunk_text
|
2582
|
+
|
2583
|
+
def initialize(**args)
|
2584
|
+
update!(**args)
|
2585
|
+
end
|
2586
|
+
|
2587
|
+
# Update properties of this object
|
2588
|
+
def update!(**args)
|
2589
|
+
@chunk_text = args[:chunk_text] if args.key?(:chunk_text)
|
2590
|
+
end
|
2591
|
+
end
|
2592
|
+
|
2124
2593
|
# Text and citation info for a claim in the answer candidate.
|
2125
2594
|
class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
|
2126
2595
|
include Google::Apis::Core::Hashable
|
@@ -2174,33 +2643,6 @@ module Google
|
|
2174
2643
|
end
|
2175
2644
|
end
|
2176
2645
|
|
2177
|
-
# Fact chunk for grounding check.
|
2178
|
-
class GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk
|
2179
|
-
include Google::Apis::Core::Hashable
|
2180
|
-
|
2181
|
-
# Text content of the fact chunk. Can be at most 10K characters long.
|
2182
|
-
# Corresponds to the JSON property `chunkText`
|
2183
|
-
# @return [String]
|
2184
|
-
attr_accessor :chunk_text
|
2185
|
-
|
2186
|
-
# Source from which this fact chunk was retrieved. For a fact chunk retrieved
|
2187
|
-
# from inline facts, this field will contain the index of the specific fact from
|
2188
|
-
# which this chunk was retrieved.
|
2189
|
-
# Corresponds to the JSON property `source`
|
2190
|
-
# @return [String]
|
2191
|
-
attr_accessor :source
|
2192
|
-
|
2193
|
-
def initialize(**args)
|
2194
|
-
update!(**args)
|
2195
|
-
end
|
2196
|
-
|
2197
|
-
# Update properties of this object
|
2198
|
-
def update!(**args)
|
2199
|
-
@chunk_text = args[:chunk_text] if args.key?(:chunk_text)
|
2200
|
-
@source = args[:source] if args.key?(:source)
|
2201
|
-
end
|
2202
|
-
end
|
2203
|
-
|
2204
2646
|
# Specification for the grounding check.
|
2205
2647
|
class GoogleCloudDiscoveryengineV1CheckGroundingSpec
|
2206
2648
|
include Google::Apis::Core::Hashable
|
@@ -4425,6 +4867,116 @@ module Google
|
|
4425
4867
|
end
|
4426
4868
|
end
|
4427
4869
|
|
4870
|
+
# Fact Chunk.
|
4871
|
+
class GoogleCloudDiscoveryengineV1FactChunk
|
4872
|
+
include Google::Apis::Core::Hashable
|
4873
|
+
|
4874
|
+
# Text content of the fact chunk. Can be at most 10K characters long.
|
4875
|
+
# Corresponds to the JSON property `chunkText`
|
4876
|
+
# @return [String]
|
4877
|
+
attr_accessor :chunk_text
|
4878
|
+
|
4879
|
+
# The index of this chunk. Currently, only used for the streaming mode.
|
4880
|
+
# Corresponds to the JSON property `index`
|
4881
|
+
# @return [Fixnum]
|
4882
|
+
attr_accessor :index
|
4883
|
+
|
4884
|
+
# Source from which this fact chunk was retrieved. If it was retrieved from the
|
4885
|
+
# GroundingFacts provided in the request then this field will contain the index
|
4886
|
+
# of the specific fact from which this chunk was retrieved.
|
4887
|
+
# Corresponds to the JSON property `source`
|
4888
|
+
# @return [String]
|
4889
|
+
attr_accessor :source
|
4890
|
+
|
4891
|
+
# More fine-grained information for the source reference.
|
4892
|
+
# Corresponds to the JSON property `sourceMetadata`
|
4893
|
+
# @return [Hash<String,String>]
|
4894
|
+
attr_accessor :source_metadata
|
4895
|
+
|
4896
|
+
def initialize(**args)
|
4897
|
+
update!(**args)
|
4898
|
+
end
|
4899
|
+
|
4900
|
+
# Update properties of this object
|
4901
|
+
def update!(**args)
|
4902
|
+
@chunk_text = args[:chunk_text] if args.key?(:chunk_text)
|
4903
|
+
@index = args[:index] if args.key?(:index)
|
4904
|
+
@source = args[:source] if args.key?(:source)
|
4905
|
+
@source_metadata = args[:source_metadata] if args.key?(:source_metadata)
|
4906
|
+
end
|
4907
|
+
end
|
4908
|
+
|
4909
|
+
# Information about the user feedback. This information will be used for logging
|
4910
|
+
# and metrics purpose.
|
4911
|
+
class GoogleCloudDiscoveryengineV1Feedback
|
4912
|
+
include Google::Apis::Core::Hashable
|
4913
|
+
|
4914
|
+
# Optional. The additional user comment of the feedback if user gives a thumb
|
4915
|
+
# down.
|
4916
|
+
# Corresponds to the JSON property `comment`
|
4917
|
+
# @return [String]
|
4918
|
+
attr_accessor :comment
|
4919
|
+
|
4920
|
+
# The conversation information such as the question index and session name.
|
4921
|
+
# Corresponds to the JSON property `conversationInfo`
|
4922
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FeedbackConversationInfo]
|
4923
|
+
attr_accessor :conversation_info
|
4924
|
+
|
4925
|
+
# Required. Indicate whether the user gives a positive or negative feedback. If
|
4926
|
+
# the user gives a negative feedback, there might be more feedback details.
|
4927
|
+
# Corresponds to the JSON property `feedbackType`
|
4928
|
+
# @return [String]
|
4929
|
+
attr_accessor :feedback_type
|
4930
|
+
|
4931
|
+
# The version of the LLM model that was used to generate the response.
|
4932
|
+
# Corresponds to the JSON property `llmModelVersion`
|
4933
|
+
# @return [String]
|
4934
|
+
attr_accessor :llm_model_version
|
4935
|
+
|
4936
|
+
# Optional. The reason if user gives a thumb down.
|
4937
|
+
# Corresponds to the JSON property `reasons`
|
4938
|
+
# @return [Array<String>]
|
4939
|
+
attr_accessor :reasons
|
4940
|
+
|
4941
|
+
def initialize(**args)
|
4942
|
+
update!(**args)
|
4943
|
+
end
|
4944
|
+
|
4945
|
+
# Update properties of this object
|
4946
|
+
def update!(**args)
|
4947
|
+
@comment = args[:comment] if args.key?(:comment)
|
4948
|
+
@conversation_info = args[:conversation_info] if args.key?(:conversation_info)
|
4949
|
+
@feedback_type = args[:feedback_type] if args.key?(:feedback_type)
|
4950
|
+
@llm_model_version = args[:llm_model_version] if args.key?(:llm_model_version)
|
4951
|
+
@reasons = args[:reasons] if args.key?(:reasons)
|
4952
|
+
end
|
4953
|
+
end
|
4954
|
+
|
4955
|
+
# The conversation information such as the question index and session name.
|
4956
|
+
class GoogleCloudDiscoveryengineV1FeedbackConversationInfo
|
4957
|
+
include Google::Apis::Core::Hashable
|
4958
|
+
|
4959
|
+
# The index of the user input within the conversation messages.
|
4960
|
+
# Corresponds to the JSON property `questionIndex`
|
4961
|
+
# @return [Fixnum]
|
4962
|
+
attr_accessor :question_index
|
4963
|
+
|
4964
|
+
# Name of the newly generated or continued session.
|
4965
|
+
# Corresponds to the JSON property `session`
|
4966
|
+
# @return [String]
|
4967
|
+
attr_accessor :session
|
4968
|
+
|
4969
|
+
def initialize(**args)
|
4970
|
+
update!(**args)
|
4971
|
+
end
|
4972
|
+
|
4973
|
+
# Update properties of this object
|
4974
|
+
def update!(**args)
|
4975
|
+
@question_index = args[:question_index] if args.key?(:question_index)
|
4976
|
+
@session = args[:session] if args.key?(:session)
|
4977
|
+
end
|
4978
|
+
end
|
4979
|
+
|
4428
4980
|
# Response message for SiteSearchEngineService.FetchDomainVerificationStatus
|
4429
4981
|
# method.
|
4430
4982
|
class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
|
@@ -5564,6 +6116,11 @@ module Google
|
|
5564
6116
|
# @return [String]
|
5565
6117
|
attr_accessor :display_name
|
5566
6118
|
|
6119
|
+
# Optional. The document IDs associated with this panel.
|
6120
|
+
# Corresponds to the JSON property `documents`
|
6121
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo>]
|
6122
|
+
attr_accessor :documents
|
6123
|
+
|
5567
6124
|
# Required. The panel ID.
|
5568
6125
|
# Corresponds to the JSON property `panelId`
|
5569
6126
|
# @return [String]
|
@@ -5588,6 +6145,7 @@ module Google
|
|
5588
6145
|
# Update properties of this object
|
5589
6146
|
def update!(**args)
|
5590
6147
|
@display_name = args[:display_name] if args.key?(:display_name)
|
6148
|
+
@documents = args[:documents] if args.key?(:documents)
|
5591
6149
|
@panel_id = args[:panel_id] if args.key?(:panel_id)
|
5592
6150
|
@panel_position = args[:panel_position] if args.key?(:panel_position)
|
5593
6151
|
@total_panels = args[:total_panels] if args.key?(:total_panels)
|
@@ -8767,14 +9325,21 @@ module Google
|
|
8767
9325
|
# Search for Documents. * `view-item`: Detailed page view of a Document. * `view-
|
8768
9326
|
# item-list`: View of a panel or ordered list of Documents. * `view-home-page`:
|
8769
9327
|
# View of the home page. * `view-category-page`: View of a category page, e.g.
|
8770
|
-
# Home > Men > Jeans
|
8771
|
-
#
|
8772
|
-
#
|
8773
|
-
#
|
9328
|
+
# Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related
|
9329
|
+
# values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online
|
9330
|
+
# shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`
|
9331
|
+
# : Start/resume watching a video, playing a song, etc. * `media-complete`:
|
9332
|
+
# Finished or stopped midway through a video, song, etc.
|
8774
9333
|
# Corresponds to the JSON property `eventType`
|
8775
9334
|
# @return [String]
|
8776
9335
|
attr_accessor :event_type
|
8777
9336
|
|
9337
|
+
# Information about the user feedback. This information will be used for logging
|
9338
|
+
# and metrics purpose.
|
9339
|
+
# Corresponds to the JSON property `feedback`
|
9340
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Feedback]
|
9341
|
+
attr_accessor :feedback
|
9342
|
+
|
8778
9343
|
# The filter syntax consists of an expression language for constructing a
|
8779
9344
|
# predicate from one or more fields of the documents being filtered. One example
|
8780
9345
|
# is for `search` events, the associated SearchRequest may contain a filter
|
@@ -8803,6 +9368,12 @@ module Google
|
|
8803
9368
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo]
|
8804
9369
|
attr_accessor :panel
|
8805
9370
|
|
9371
|
+
# Optional. List of panels associated with this event. Used for page-level
|
9372
|
+
# impression data.
|
9373
|
+
# Corresponds to the JSON property `panels`
|
9374
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo>]
|
9375
|
+
attr_accessor :panels
|
9376
|
+
|
8806
9377
|
# The promotion IDs if this is an event associated with promotions. Currently,
|
8807
9378
|
# this field is restricted to at most one ID.
|
8808
9379
|
# Corresponds to the JSON property `promotionIds`
|
@@ -8870,10 +9441,12 @@ module Google
|
|
8870
9441
|
@engine = args[:engine] if args.key?(:engine)
|
8871
9442
|
@event_time = args[:event_time] if args.key?(:event_time)
|
8872
9443
|
@event_type = args[:event_type] if args.key?(:event_type)
|
9444
|
+
@feedback = args[:feedback] if args.key?(:feedback)
|
8873
9445
|
@filter = args[:filter] if args.key?(:filter)
|
8874
9446
|
@media_info = args[:media_info] if args.key?(:media_info)
|
8875
9447
|
@page_info = args[:page_info] if args.key?(:page_info)
|
8876
9448
|
@panel = args[:panel] if args.key?(:panel)
|
9449
|
+
@panels = args[:panels] if args.key?(:panels)
|
8877
9450
|
@promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
|
8878
9451
|
@search_info = args[:search_info] if args.key?(:search_info)
|
8879
9452
|
@session_id = args[:session_id] if args.key?(:session_id)
|
@@ -10002,6 +10575,28 @@ module Google
|
|
10002
10575
|
end
|
10003
10576
|
end
|
10004
10577
|
|
10578
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
10579
|
+
class GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries
|
10580
|
+
include Google::Apis::Core::Hashable
|
10581
|
+
|
10582
|
+
# A collection of data points that describes the time-varying values of a metric.
|
10583
|
+
# A time series is identified by a combination of a fully-specified monitored
|
10584
|
+
# resource and a fully-specified metric. This type is used for both listing and
|
10585
|
+
# creating time series.
|
10586
|
+
# Corresponds to the JSON property `qpsTimeSeries`
|
10587
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TimeSeries]
|
10588
|
+
attr_accessor :qps_time_series
|
10589
|
+
|
10590
|
+
def initialize(**args)
|
10591
|
+
update!(**args)
|
10592
|
+
end
|
10593
|
+
|
10594
|
+
# Update properties of this object
|
10595
|
+
def update!(**args)
|
10596
|
+
@qps_time_series = args[:qps_time_series] if args.key?(:qps_time_series)
|
10597
|
+
end
|
10598
|
+
end
|
10599
|
+
|
10005
10600
|
# Metadata related to the progress of the DataStoreService.CreateDataStore
|
10006
10601
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
10007
10602
|
# field.
|
@@ -10096,6 +10691,34 @@ module Google
|
|
10096
10691
|
end
|
10097
10692
|
end
|
10098
10693
|
|
10694
|
+
# Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
|
10695
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
10696
|
+
# field.
|
10697
|
+
class GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata
|
10698
|
+
include Google::Apis::Core::Hashable
|
10699
|
+
|
10700
|
+
# Operation create time.
|
10701
|
+
# Corresponds to the JSON property `createTime`
|
10702
|
+
# @return [String]
|
10703
|
+
attr_accessor :create_time
|
10704
|
+
|
10705
|
+
# Operation last update time. If the operation is done, this is also the finish
|
10706
|
+
# time.
|
10707
|
+
# Corresponds to the JSON property `updateTime`
|
10708
|
+
# @return [String]
|
10709
|
+
attr_accessor :update_time
|
10710
|
+
|
10711
|
+
def initialize(**args)
|
10712
|
+
update!(**args)
|
10713
|
+
end
|
10714
|
+
|
10715
|
+
# Update properties of this object
|
10716
|
+
def update!(**args)
|
10717
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
10718
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
10719
|
+
end
|
10720
|
+
end
|
10721
|
+
|
10099
10722
|
# Metadata related to the progress of the SiteSearchEngineService.
|
10100
10723
|
# CreateTargetSite operation. This will be returned by the google.longrunning.
|
10101
10724
|
# Operation.metadata field.
|
@@ -10425,6 +11048,33 @@ module Google
|
|
10425
11048
|
end
|
10426
11049
|
end
|
10427
11050
|
|
11051
|
+
# The historical dedicated crawl rate timeseries data, used for monitoring.
|
11052
|
+
# Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
|
11053
|
+
# crawl is set.
|
11054
|
+
class GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries
|
11055
|
+
include Google::Apis::Core::Hashable
|
11056
|
+
|
11057
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
11058
|
+
# Corresponds to the JSON property `autoRefreshCrawlRate`
|
11059
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
11060
|
+
attr_accessor :auto_refresh_crawl_rate
|
11061
|
+
|
11062
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
11063
|
+
# Corresponds to the JSON property `userTriggeredCrawlRate`
|
11064
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
11065
|
+
attr_accessor :user_triggered_crawl_rate
|
11066
|
+
|
11067
|
+
def initialize(**args)
|
11068
|
+
update!(**args)
|
11069
|
+
end
|
11070
|
+
|
11071
|
+
# Update properties of this object
|
11072
|
+
def update!(**args)
|
11073
|
+
@auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
|
11074
|
+
@user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
|
11075
|
+
end
|
11076
|
+
end
|
11077
|
+
|
10428
11078
|
# Metadata related to the progress of the DataStoreService.DeleteDataStore
|
10429
11079
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
10430
11080
|
# field.
|
@@ -10506,6 +11156,34 @@ module Google
|
|
10506
11156
|
end
|
10507
11157
|
end
|
10508
11158
|
|
11159
|
+
# Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
|
11160
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
11161
|
+
# field.
|
11162
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata
|
11163
|
+
include Google::Apis::Core::Hashable
|
11164
|
+
|
11165
|
+
# Operation create time.
|
11166
|
+
# Corresponds to the JSON property `createTime`
|
11167
|
+
# @return [String]
|
11168
|
+
attr_accessor :create_time
|
11169
|
+
|
11170
|
+
# Operation last update time. If the operation is done, this is also the finish
|
11171
|
+
# time.
|
11172
|
+
# Corresponds to the JSON property `updateTime`
|
11173
|
+
# @return [String]
|
11174
|
+
attr_accessor :update_time
|
11175
|
+
|
11176
|
+
def initialize(**args)
|
11177
|
+
update!(**args)
|
11178
|
+
end
|
11179
|
+
|
11180
|
+
# Update properties of this object
|
11181
|
+
def update!(**args)
|
11182
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
11183
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
11184
|
+
end
|
11185
|
+
end
|
11186
|
+
|
10509
11187
|
# Metadata related to the progress of the SiteSearchEngineService.
|
10510
11188
|
# DeleteTargetSite operation. This will be returned by the google.longrunning.
|
10511
11189
|
# Operation.metadata field.
|
@@ -11360,6 +12038,44 @@ module Google
|
|
11360
12038
|
end
|
11361
12039
|
end
|
11362
12040
|
|
12041
|
+
# Response message for SiteSearchEngineService.FetchSitemaps method.
|
12042
|
+
class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
|
12043
|
+
include Google::Apis::Core::Hashable
|
12044
|
+
|
12045
|
+
# List of Sitemaps fetched.
|
12046
|
+
# Corresponds to the JSON property `sitemapsMetadata`
|
12047
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata>]
|
12048
|
+
attr_accessor :sitemaps_metadata
|
12049
|
+
|
12050
|
+
def initialize(**args)
|
12051
|
+
update!(**args)
|
12052
|
+
end
|
12053
|
+
|
12054
|
+
# Update properties of this object
|
12055
|
+
def update!(**args)
|
12056
|
+
@sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
|
12057
|
+
end
|
12058
|
+
end
|
12059
|
+
|
12060
|
+
# Contains a Sitemap and its metadata.
|
12061
|
+
class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata
|
12062
|
+
include Google::Apis::Core::Hashable
|
12063
|
+
|
12064
|
+
# A sitemap for the SiteSearchEngine.
|
12065
|
+
# Corresponds to the JSON property `sitemap`
|
12066
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSitemap]
|
12067
|
+
attr_accessor :sitemap
|
12068
|
+
|
12069
|
+
def initialize(**args)
|
12070
|
+
update!(**args)
|
12071
|
+
end
|
12072
|
+
|
12073
|
+
# Update properties of this object
|
12074
|
+
def update!(**args)
|
12075
|
+
@sitemap = args[:sitemap] if args.key?(:sitemap)
|
12076
|
+
end
|
12077
|
+
end
|
12078
|
+
|
11363
12079
|
# Configurations for fields of a schema. For example, configuring a field is
|
11364
12080
|
# indexable, or searchable.
|
11365
12081
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -12004,7 +12720,49 @@ module Google
|
|
12004
12720
|
# -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
|
12005
12721
|
# Corresponds to the JSON property `region`
|
12006
12722
|
# @return [String]
|
12007
|
-
attr_accessor :region
|
12723
|
+
attr_accessor :region
|
12724
|
+
|
12725
|
+
def initialize(**args)
|
12726
|
+
update!(**args)
|
12727
|
+
end
|
12728
|
+
|
12729
|
+
# Update properties of this object
|
12730
|
+
def update!(**args)
|
12731
|
+
@language = args[:language] if args.key?(:language)
|
12732
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
12733
|
+
@normalized_language_code = args[:normalized_language_code] if args.key?(:normalized_language_code)
|
12734
|
+
@region = args[:region] if args.key?(:region)
|
12735
|
+
end
|
12736
|
+
end
|
12737
|
+
|
12738
|
+
# Response message for SearchTuningService.ListCustomModels method.
|
12739
|
+
class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
|
12740
|
+
include Google::Apis::Core::Hashable
|
12741
|
+
|
12742
|
+
# List of custom tuning models.
|
12743
|
+
# Corresponds to the JSON property `models`
|
12744
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
|
12745
|
+
attr_accessor :models
|
12746
|
+
|
12747
|
+
def initialize(**args)
|
12748
|
+
update!(**args)
|
12749
|
+
end
|
12750
|
+
|
12751
|
+
# Update properties of this object
|
12752
|
+
def update!(**args)
|
12753
|
+
@models = args[:models] if args.key?(:models)
|
12754
|
+
end
|
12755
|
+
end
|
12756
|
+
|
12757
|
+
# Configuration for Natural Language Query Understanding.
|
12758
|
+
class GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig
|
12759
|
+
include Google::Apis::Core::Hashable
|
12760
|
+
|
12761
|
+
# Mode of Natural Language Query Understanding. If this field is unset, the
|
12762
|
+
# behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
|
12763
|
+
# Corresponds to the JSON property `mode`
|
12764
|
+
# @return [String]
|
12765
|
+
attr_accessor :mode
|
12008
12766
|
|
12009
12767
|
def initialize(**args)
|
12010
12768
|
update!(**args)
|
@@ -12012,21 +12770,45 @@ module Google
|
|
12012
12770
|
|
12013
12771
|
# Update properties of this object
|
12014
12772
|
def update!(**args)
|
12015
|
-
@
|
12016
|
-
@language_code = args[:language_code] if args.key?(:language_code)
|
12017
|
-
@normalized_language_code = args[:normalized_language_code] if args.key?(:normalized_language_code)
|
12018
|
-
@region = args[:region] if args.key?(:region)
|
12773
|
+
@mode = args[:mode] if args.key?(:mode)
|
12019
12774
|
end
|
12020
12775
|
end
|
12021
12776
|
|
12022
|
-
# Response message for
|
12023
|
-
|
12777
|
+
# Response message for CrawlRateManagementService.ObtainCrawlRate method. The
|
12778
|
+
# response contains organcic or dedicated crawl rate time series data for
|
12779
|
+
# monitoring, depending on whether dedicated crawl rate is set.
|
12780
|
+
class GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse
|
12024
12781
|
include Google::Apis::Core::Hashable
|
12025
12782
|
|
12026
|
-
#
|
12027
|
-
#
|
12028
|
-
#
|
12029
|
-
|
12783
|
+
# The historical dedicated crawl rate timeseries data, used for monitoring.
|
12784
|
+
# Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
|
12785
|
+
# crawl is set.
|
12786
|
+
# Corresponds to the JSON property `dedicatedCrawlRateTimeSeries`
|
12787
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries]
|
12788
|
+
attr_accessor :dedicated_crawl_rate_time_series
|
12789
|
+
|
12790
|
+
# The `Status` type defines a logical error model that is suitable for different
|
12791
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
12792
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
12793
|
+
# data: error code, error message, and error details. You can find out more
|
12794
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
12795
|
+
# //cloud.google.com/apis/design/errors).
|
12796
|
+
# Corresponds to the JSON property `error`
|
12797
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
|
12798
|
+
attr_accessor :error
|
12799
|
+
|
12800
|
+
# The historical organic crawl rate timeseries data, used for monitoring.
|
12801
|
+
# Organic crawl is auto-determined by Google to crawl the user's website when
|
12802
|
+
# dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
|
12803
|
+
# to the user's website.
|
12804
|
+
# Corresponds to the JSON property `organicCrawlRateTimeSeries`
|
12805
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries]
|
12806
|
+
attr_accessor :organic_crawl_rate_time_series
|
12807
|
+
|
12808
|
+
# Output only. The state of the response.
|
12809
|
+
# Corresponds to the JSON property `state`
|
12810
|
+
# @return [String]
|
12811
|
+
attr_accessor :state
|
12030
12812
|
|
12031
12813
|
def initialize(**args)
|
12032
12814
|
update!(**args)
|
@@ -12034,19 +12816,29 @@ module Google
|
|
12034
12816
|
|
12035
12817
|
# Update properties of this object
|
12036
12818
|
def update!(**args)
|
12037
|
-
@
|
12819
|
+
@dedicated_crawl_rate_time_series = args[:dedicated_crawl_rate_time_series] if args.key?(:dedicated_crawl_rate_time_series)
|
12820
|
+
@error = args[:error] if args.key?(:error)
|
12821
|
+
@organic_crawl_rate_time_series = args[:organic_crawl_rate_time_series] if args.key?(:organic_crawl_rate_time_series)
|
12822
|
+
@state = args[:state] if args.key?(:state)
|
12038
12823
|
end
|
12039
12824
|
end
|
12040
12825
|
|
12041
|
-
#
|
12042
|
-
|
12826
|
+
# The historical organic crawl rate timeseries data, used for monitoring.
|
12827
|
+
# Organic crawl is auto-determined by Google to crawl the user's website when
|
12828
|
+
# dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
|
12829
|
+
# to the user's website.
|
12830
|
+
class GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries
|
12043
12831
|
include Google::Apis::Core::Hashable
|
12044
12832
|
|
12045
|
-
#
|
12046
|
-
#
|
12047
|
-
#
|
12048
|
-
|
12049
|
-
|
12833
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
12834
|
+
# Corresponds to the JSON property `googleOrganicCrawlRate`
|
12835
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
12836
|
+
attr_accessor :google_organic_crawl_rate
|
12837
|
+
|
12838
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
12839
|
+
# Corresponds to the JSON property `vertexAiOrganicCrawlRate`
|
12840
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
|
12841
|
+
attr_accessor :vertex_ai_organic_crawl_rate
|
12050
12842
|
|
12051
12843
|
def initialize(**args)
|
12052
12844
|
update!(**args)
|
@@ -12054,7 +12846,8 @@ module Google
|
|
12054
12846
|
|
12055
12847
|
# Update properties of this object
|
12056
12848
|
def update!(**args)
|
12057
|
-
@
|
12849
|
+
@google_organic_crawl_rate = args[:google_organic_crawl_rate] if args.key?(:google_organic_crawl_rate)
|
12850
|
+
@vertex_ai_organic_crawl_rate = args[:vertex_ai_organic_crawl_rate] if args.key?(:vertex_ai_organic_crawl_rate)
|
12058
12851
|
end
|
12059
12852
|
end
|
12060
12853
|
|
@@ -14055,6 +14848,39 @@ module Google
|
|
14055
14848
|
end
|
14056
14849
|
end
|
14057
14850
|
|
14851
|
+
# A sitemap for the SiteSearchEngine.
|
14852
|
+
class GoogleCloudDiscoveryengineV1alphaSitemap
|
14853
|
+
include Google::Apis::Core::Hashable
|
14854
|
+
|
14855
|
+
# Output only. The sitemap's creation time.
|
14856
|
+
# Corresponds to the JSON property `createTime`
|
14857
|
+
# @return [String]
|
14858
|
+
attr_accessor :create_time
|
14859
|
+
|
14860
|
+
# Output only. The fully qualified resource name of the sitemap. `projects/*/
|
14861
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
|
14862
|
+
# sitemap_id` suffix is system-generated.
|
14863
|
+
# Corresponds to the JSON property `name`
|
14864
|
+
# @return [String]
|
14865
|
+
attr_accessor :name
|
14866
|
+
|
14867
|
+
# Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
|
14868
|
+
# Corresponds to the JSON property `uri`
|
14869
|
+
# @return [String]
|
14870
|
+
attr_accessor :uri
|
14871
|
+
|
14872
|
+
def initialize(**args)
|
14873
|
+
update!(**args)
|
14874
|
+
end
|
14875
|
+
|
14876
|
+
# Update properties of this object
|
14877
|
+
def update!(**args)
|
14878
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
14879
|
+
@name = args[:name] if args.key?(:name)
|
14880
|
+
@uri = args[:uri] if args.key?(:uri)
|
14881
|
+
end
|
14882
|
+
end
|
14883
|
+
|
14058
14884
|
# A target site for the SiteSearchEngine.
|
14059
14885
|
class GoogleCloudDiscoveryengineV1alphaTargetSite
|
14060
14886
|
include Google::Apis::Core::Hashable
|
@@ -14936,6 +15762,34 @@ module Google
|
|
14936
15762
|
end
|
14937
15763
|
end
|
14938
15764
|
|
15765
|
+
# Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
|
15766
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
15767
|
+
# field.
|
15768
|
+
class GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata
|
15769
|
+
include Google::Apis::Core::Hashable
|
15770
|
+
|
15771
|
+
# Operation create time.
|
15772
|
+
# Corresponds to the JSON property `createTime`
|
15773
|
+
# @return [String]
|
15774
|
+
attr_accessor :create_time
|
15775
|
+
|
15776
|
+
# Operation last update time. If the operation is done, this is also the finish
|
15777
|
+
# time.
|
15778
|
+
# Corresponds to the JSON property `updateTime`
|
15779
|
+
# @return [String]
|
15780
|
+
attr_accessor :update_time
|
15781
|
+
|
15782
|
+
def initialize(**args)
|
15783
|
+
update!(**args)
|
15784
|
+
end
|
15785
|
+
|
15786
|
+
# Update properties of this object
|
15787
|
+
def update!(**args)
|
15788
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
15789
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
15790
|
+
end
|
15791
|
+
end
|
15792
|
+
|
14939
15793
|
# Metadata related to the progress of the SiteSearchEngineService.
|
14940
15794
|
# CreateTargetSite operation. This will be returned by the google.longrunning.
|
14941
15795
|
# Operation.metadata field.
|
@@ -15308,6 +16162,34 @@ module Google
|
|
15308
16162
|
end
|
15309
16163
|
end
|
15310
16164
|
|
16165
|
+
# Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
|
16166
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
16167
|
+
# field.
|
16168
|
+
class GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata
|
16169
|
+
include Google::Apis::Core::Hashable
|
16170
|
+
|
16171
|
+
# Operation create time.
|
16172
|
+
# Corresponds to the JSON property `createTime`
|
16173
|
+
# @return [String]
|
16174
|
+
attr_accessor :create_time
|
16175
|
+
|
16176
|
+
# Operation last update time. If the operation is done, this is also the finish
|
16177
|
+
# time.
|
16178
|
+
# Corresponds to the JSON property `updateTime`
|
16179
|
+
# @return [String]
|
16180
|
+
attr_accessor :update_time
|
16181
|
+
|
16182
|
+
def initialize(**args)
|
16183
|
+
update!(**args)
|
16184
|
+
end
|
16185
|
+
|
16186
|
+
# Update properties of this object
|
16187
|
+
def update!(**args)
|
16188
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
16189
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
16190
|
+
end
|
16191
|
+
end
|
16192
|
+
|
15311
16193
|
# Metadata related to the progress of the SiteSearchEngineService.
|
15312
16194
|
# DeleteTargetSite operation. This will be returned by the google.longrunning.
|
15313
16195
|
# Operation.metadata field.
|
@@ -15962,6 +16844,44 @@ module Google
|
|
15962
16844
|
end
|
15963
16845
|
end
|
15964
16846
|
|
16847
|
+
# Response message for SiteSearchEngineService.FetchSitemaps method.
|
16848
|
+
class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
|
16849
|
+
include Google::Apis::Core::Hashable
|
16850
|
+
|
16851
|
+
# List of Sitemaps fetched.
|
16852
|
+
# Corresponds to the JSON property `sitemapsMetadata`
|
16853
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata>]
|
16854
|
+
attr_accessor :sitemaps_metadata
|
16855
|
+
|
16856
|
+
def initialize(**args)
|
16857
|
+
update!(**args)
|
16858
|
+
end
|
16859
|
+
|
16860
|
+
# Update properties of this object
|
16861
|
+
def update!(**args)
|
16862
|
+
@sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
|
16863
|
+
end
|
16864
|
+
end
|
16865
|
+
|
16866
|
+
# Contains a Sitemap and its metadata.
|
16867
|
+
class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata
|
16868
|
+
include Google::Apis::Core::Hashable
|
16869
|
+
|
16870
|
+
# A sitemap for the SiteSearchEngine.
|
16871
|
+
# Corresponds to the JSON property `sitemap`
|
16872
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSitemap]
|
16873
|
+
attr_accessor :sitemap
|
16874
|
+
|
16875
|
+
def initialize(**args)
|
16876
|
+
update!(**args)
|
16877
|
+
end
|
16878
|
+
|
16879
|
+
# Update properties of this object
|
16880
|
+
def update!(**args)
|
16881
|
+
@sitemap = args[:sitemap] if args.key?(:sitemap)
|
16882
|
+
end
|
16883
|
+
end
|
16884
|
+
|
15965
16885
|
# Metadata related to the progress of the ImportCompletionSuggestions operation.
|
15966
16886
|
# This will be returned by the google.longrunning.Operation.metadata field.
|
15967
16887
|
class GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata
|
@@ -18022,6 +18942,39 @@ module Google
|
|
18022
18942
|
end
|
18023
18943
|
end
|
18024
18944
|
|
18945
|
+
# A sitemap for the SiteSearchEngine.
|
18946
|
+
class GoogleCloudDiscoveryengineV1betaSitemap
|
18947
|
+
include Google::Apis::Core::Hashable
|
18948
|
+
|
18949
|
+
# Output only. The sitemap's creation time.
|
18950
|
+
# Corresponds to the JSON property `createTime`
|
18951
|
+
# @return [String]
|
18952
|
+
attr_accessor :create_time
|
18953
|
+
|
18954
|
+
# Output only. The fully qualified resource name of the sitemap. `projects/*/
|
18955
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
|
18956
|
+
# sitemap_id` suffix is system-generated.
|
18957
|
+
# Corresponds to the JSON property `name`
|
18958
|
+
# @return [String]
|
18959
|
+
attr_accessor :name
|
18960
|
+
|
18961
|
+
# Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
|
18962
|
+
# Corresponds to the JSON property `uri`
|
18963
|
+
# @return [String]
|
18964
|
+
attr_accessor :uri
|
18965
|
+
|
18966
|
+
def initialize(**args)
|
18967
|
+
update!(**args)
|
18968
|
+
end
|
18969
|
+
|
18970
|
+
# Update properties of this object
|
18971
|
+
def update!(**args)
|
18972
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
18973
|
+
@name = args[:name] if args.key?(:name)
|
18974
|
+
@uri = args[:uri] if args.key?(:uri)
|
18975
|
+
end
|
18976
|
+
end
|
18977
|
+
|
18025
18978
|
# A target site for the SiteSearchEngine.
|
18026
18979
|
class GoogleCloudDiscoveryengineV1betaTargetSite
|
18027
18980
|
include Google::Apis::Core::Hashable
|
@@ -18484,6 +19437,214 @@ module Google
|
|
18484
19437
|
end
|
18485
19438
|
end
|
18486
19439
|
|
19440
|
+
# A single data point in a time series.
|
19441
|
+
class GoogleMonitoringV3Point
|
19442
|
+
include Google::Apis::Core::Hashable
|
19443
|
+
|
19444
|
+
# A time interval extending just after a start time through an end time. If the
|
19445
|
+
# start time is the same as the end time, then the interval represents a single
|
19446
|
+
# point in time.
|
19447
|
+
# Corresponds to the JSON property `interval`
|
19448
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TimeInterval]
|
19449
|
+
attr_accessor :interval
|
19450
|
+
|
19451
|
+
# A single strongly-typed value.
|
19452
|
+
# Corresponds to the JSON property `value`
|
19453
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TypedValue]
|
19454
|
+
attr_accessor :value
|
19455
|
+
|
19456
|
+
def initialize(**args)
|
19457
|
+
update!(**args)
|
19458
|
+
end
|
19459
|
+
|
19460
|
+
# Update properties of this object
|
19461
|
+
def update!(**args)
|
19462
|
+
@interval = args[:interval] if args.key?(:interval)
|
19463
|
+
@value = args[:value] if args.key?(:value)
|
19464
|
+
end
|
19465
|
+
end
|
19466
|
+
|
19467
|
+
# A time interval extending just after a start time through an end time. If the
|
19468
|
+
# start time is the same as the end time, then the interval represents a single
|
19469
|
+
# point in time.
|
19470
|
+
class GoogleMonitoringV3TimeInterval
|
19471
|
+
include Google::Apis::Core::Hashable
|
19472
|
+
|
19473
|
+
# Required. The end of the time interval.
|
19474
|
+
# Corresponds to the JSON property `endTime`
|
19475
|
+
# @return [String]
|
19476
|
+
attr_accessor :end_time
|
19477
|
+
|
19478
|
+
# Optional. The beginning of the time interval. The default value for the start
|
19479
|
+
# time is the end time. The start time must not be later than the end time.
|
19480
|
+
# Corresponds to the JSON property `startTime`
|
19481
|
+
# @return [String]
|
19482
|
+
attr_accessor :start_time
|
19483
|
+
|
19484
|
+
def initialize(**args)
|
19485
|
+
update!(**args)
|
19486
|
+
end
|
19487
|
+
|
19488
|
+
# Update properties of this object
|
19489
|
+
def update!(**args)
|
19490
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
19491
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
19492
|
+
end
|
19493
|
+
end
|
19494
|
+
|
19495
|
+
# A collection of data points that describes the time-varying values of a metric.
|
19496
|
+
# A time series is identified by a combination of a fully-specified monitored
|
19497
|
+
# resource and a fully-specified metric. This type is used for both listing and
|
19498
|
+
# creating time series.
|
19499
|
+
class GoogleMonitoringV3TimeSeries
|
19500
|
+
include Google::Apis::Core::Hashable
|
19501
|
+
|
19502
|
+
# Input only. A detailed description of the time series that will be associated
|
19503
|
+
# with the google.api.MetricDescriptor for the metric. Once set, this field
|
19504
|
+
# cannot be changed through CreateTimeSeries.
|
19505
|
+
# Corresponds to the JSON property `description`
|
19506
|
+
# @return [String]
|
19507
|
+
attr_accessor :description
|
19508
|
+
|
19509
|
+
# Auxiliary metadata for a MonitoredResource object. MonitoredResource objects
|
19510
|
+
# contain the minimum set of information to uniquely identify a monitored
|
19511
|
+
# resource instance. There is some other useful auxiliary metadata. Monitoring
|
19512
|
+
# and Logging use an ingestion pipeline to extract metadata for cloud resources
|
19513
|
+
# of all types, and store the metadata in this message.
|
19514
|
+
# Corresponds to the JSON property `metadata`
|
19515
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiMonitoredResourceMetadata]
|
19516
|
+
attr_accessor :metadata
|
19517
|
+
|
19518
|
+
# A specific metric, identified by specifying values for all of the labels of a `
|
19519
|
+
# MetricDescriptor`.
|
19520
|
+
# Corresponds to the JSON property `metric`
|
19521
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiMetric]
|
19522
|
+
attr_accessor :metric
|
19523
|
+
|
19524
|
+
# The metric kind of the time series. When listing time series, this metric kind
|
19525
|
+
# might be different from the metric kind of the associated metric if this time
|
19526
|
+
# series is an alignment or reduction of other time series. When creating a time
|
19527
|
+
# series, this field is optional. If present, it must be the same as the metric
|
19528
|
+
# kind of the associated metric. If the associated metric's descriptor must be
|
19529
|
+
# auto-created, then this field specifies the metric kind of the new descriptor
|
19530
|
+
# and must be either `GAUGE` (the default) or `CUMULATIVE`.
|
19531
|
+
# Corresponds to the JSON property `metricKind`
|
19532
|
+
# @return [String]
|
19533
|
+
attr_accessor :metric_kind
|
19534
|
+
|
19535
|
+
# The data points of this time series. When listing time series, points are
|
19536
|
+
# returned in reverse time order. When creating a time series, this field must
|
19537
|
+
# contain exactly one point and the point's type must be the same as the value
|
19538
|
+
# type of the associated metric. If the associated metric's descriptor must be
|
19539
|
+
# auto-created, then the value type of the descriptor is determined by the point'
|
19540
|
+
# s type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
|
19541
|
+
# Corresponds to the JSON property `points`
|
19542
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleMonitoringV3Point>]
|
19543
|
+
attr_accessor :points
|
19544
|
+
|
19545
|
+
# An object representing a resource that can be used for monitoring, logging,
|
19546
|
+
# billing, or other purposes. Examples include virtual machine instances,
|
19547
|
+
# databases, and storage devices such as disks. The `type` field identifies a
|
19548
|
+
# MonitoredResourceDescriptor object that describes the resource's schema.
|
19549
|
+
# Information in the `labels` field identifies the actual resource and its
|
19550
|
+
# attributes according to the schema. For example, a particular Compute Engine
|
19551
|
+
# VM instance could be represented by the following object, because the
|
19552
|
+
# MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"
|
19553
|
+
# instance_id"` and `"zone"`: ` "type": "gce_instance", "labels": ` "project_id":
|
19554
|
+
# "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" ``
|
19555
|
+
# Corresponds to the JSON property `resource`
|
19556
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiMonitoredResource]
|
19557
|
+
attr_accessor :resource
|
19558
|
+
|
19559
|
+
# The units in which the metric value is reported. It is only applicable if the `
|
19560
|
+
# value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
|
19561
|
+
# representation of the stored metric values. This field can only be changed
|
19562
|
+
# through CreateTimeSeries when it is empty.
|
19563
|
+
# Corresponds to the JSON property `unit`
|
19564
|
+
# @return [String]
|
19565
|
+
attr_accessor :unit
|
19566
|
+
|
19567
|
+
# The value type of the time series. When listing time series, this value type
|
19568
|
+
# might be different from the value type of the associated metric if this time
|
19569
|
+
# series is an alignment or reduction of other time series. When creating a time
|
19570
|
+
# series, this field is optional. If present, it must be the same as the type of
|
19571
|
+
# the data in the `points` field.
|
19572
|
+
# Corresponds to the JSON property `valueType`
|
19573
|
+
# @return [String]
|
19574
|
+
attr_accessor :value_type
|
19575
|
+
|
19576
|
+
def initialize(**args)
|
19577
|
+
update!(**args)
|
19578
|
+
end
|
19579
|
+
|
19580
|
+
# Update properties of this object
|
19581
|
+
def update!(**args)
|
19582
|
+
@description = args[:description] if args.key?(:description)
|
19583
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
19584
|
+
@metric = args[:metric] if args.key?(:metric)
|
19585
|
+
@metric_kind = args[:metric_kind] if args.key?(:metric_kind)
|
19586
|
+
@points = args[:points] if args.key?(:points)
|
19587
|
+
@resource = args[:resource] if args.key?(:resource)
|
19588
|
+
@unit = args[:unit] if args.key?(:unit)
|
19589
|
+
@value_type = args[:value_type] if args.key?(:value_type)
|
19590
|
+
end
|
19591
|
+
end
|
19592
|
+
|
19593
|
+
# A single strongly-typed value.
|
19594
|
+
class GoogleMonitoringV3TypedValue
|
19595
|
+
include Google::Apis::Core::Hashable
|
19596
|
+
|
19597
|
+
# A Boolean value: `true` or `false`.
|
19598
|
+
# Corresponds to the JSON property `boolValue`
|
19599
|
+
# @return [Boolean]
|
19600
|
+
attr_accessor :bool_value
|
19601
|
+
alias_method :bool_value?, :bool_value
|
19602
|
+
|
19603
|
+
# `Distribution` contains summary statistics for a population of values. It
|
19604
|
+
# optionally contains a histogram representing the distribution of those values
|
19605
|
+
# across a set of buckets. The summary statistics are the count, mean, sum of
|
19606
|
+
# the squared deviation from the mean, the minimum, and the maximum of the set
|
19607
|
+
# of population of values. The histogram is based on a sequence of buckets and
|
19608
|
+
# gives a count of values that fall into each bucket. The boundaries of the
|
19609
|
+
# buckets are given either explicitly or by formulas for buckets of fixed or
|
19610
|
+
# exponentially increasing widths. Although it is not forbidden, it is generally
|
19611
|
+
# a bad idea to include non-finite values (infinities or NaNs) in the population
|
19612
|
+
# of values, as this will render the `mean` and `sum_of_squared_deviation`
|
19613
|
+
# fields meaningless.
|
19614
|
+
# Corresponds to the JSON property `distributionValue`
|
19615
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleApiDistribution]
|
19616
|
+
attr_accessor :distribution_value
|
19617
|
+
|
19618
|
+
# A 64-bit double-precision floating-point number. Its magnitude is
|
19619
|
+
# approximately ±10±300 and it has 16 significant digits of precision.
|
19620
|
+
# Corresponds to the JSON property `doubleValue`
|
19621
|
+
# @return [Float]
|
19622
|
+
attr_accessor :double_value
|
19623
|
+
|
19624
|
+
# A 64-bit integer. Its range is approximately ±9.2x1018.
|
19625
|
+
# Corresponds to the JSON property `int64Value`
|
19626
|
+
# @return [Fixnum]
|
19627
|
+
attr_accessor :int64_value
|
19628
|
+
|
19629
|
+
# A variable-length string value.
|
19630
|
+
# Corresponds to the JSON property `stringValue`
|
19631
|
+
# @return [String]
|
19632
|
+
attr_accessor :string_value
|
19633
|
+
|
19634
|
+
def initialize(**args)
|
19635
|
+
update!(**args)
|
19636
|
+
end
|
19637
|
+
|
19638
|
+
# Update properties of this object
|
19639
|
+
def update!(**args)
|
19640
|
+
@bool_value = args[:bool_value] if args.key?(:bool_value)
|
19641
|
+
@distribution_value = args[:distribution_value] if args.key?(:distribution_value)
|
19642
|
+
@double_value = args[:double_value] if args.key?(:double_value)
|
19643
|
+
@int64_value = args[:int64_value] if args.key?(:int64_value)
|
19644
|
+
@string_value = args[:string_value] if args.key?(:string_value)
|
19645
|
+
end
|
19646
|
+
end
|
19647
|
+
|
18487
19648
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
18488
19649
|
# messages in your APIs. A typical example is to use it as the request or the
|
18489
19650
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|