google-apis-discoveryengine_v1 0.20.0 → 0.21.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.
@@ -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
@@ -8767,10 +9210,11 @@ module Google
8767
9210
  # Search for Documents. * `view-item`: Detailed page view of a Document. * `view-
8768
9211
  # item-list`: View of a panel or ordered list of Documents. * `view-home-page`:
8769
9212
  # View of the home page. * `view-category-page`: View of a category page, e.g.
8770
- # Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to
8771
- # cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-
8772
- # related values: * `media-play`: Start/resume watching a video, playing a song,
8773
- # etc. * `media-complete`: Finished or stopped midway through a video, song, etc.
9213
+ # Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related
9214
+ # values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online
9215
+ # shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`
9216
+ # : Start/resume watching a video, playing a song, etc. * `media-complete`:
9217
+ # Finished or stopped midway through a video, song, etc.
8774
9218
  # Corresponds to the JSON property `eventType`
8775
9219
  # @return [String]
8776
9220
  attr_accessor :event_type
@@ -10002,6 +10446,28 @@ module Google
10002
10446
  end
10003
10447
  end
10004
10448
 
10449
+ # The historical crawl rate timeseries data, used for monitoring.
10450
+ class GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries
10451
+ include Google::Apis::Core::Hashable
10452
+
10453
+ # A collection of data points that describes the time-varying values of a metric.
10454
+ # A time series is identified by a combination of a fully-specified monitored
10455
+ # resource and a fully-specified metric. This type is used for both listing and
10456
+ # creating time series.
10457
+ # Corresponds to the JSON property `qpsTimeSeries`
10458
+ # @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TimeSeries]
10459
+ attr_accessor :qps_time_series
10460
+
10461
+ def initialize(**args)
10462
+ update!(**args)
10463
+ end
10464
+
10465
+ # Update properties of this object
10466
+ def update!(**args)
10467
+ @qps_time_series = args[:qps_time_series] if args.key?(:qps_time_series)
10468
+ end
10469
+ end
10470
+
10005
10471
  # Metadata related to the progress of the DataStoreService.CreateDataStore
10006
10472
  # operation. This will be returned by the google.longrunning.Operation.metadata
10007
10473
  # field.
@@ -10096,6 +10562,34 @@ module Google
10096
10562
  end
10097
10563
  end
10098
10564
 
10565
+ # Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
10566
+ # operation. This will be returned by the google.longrunning.Operation.metadata
10567
+ # field.
10568
+ class GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata
10569
+ include Google::Apis::Core::Hashable
10570
+
10571
+ # Operation create time.
10572
+ # Corresponds to the JSON property `createTime`
10573
+ # @return [String]
10574
+ attr_accessor :create_time
10575
+
10576
+ # Operation last update time. If the operation is done, this is also the finish
10577
+ # time.
10578
+ # Corresponds to the JSON property `updateTime`
10579
+ # @return [String]
10580
+ attr_accessor :update_time
10581
+
10582
+ def initialize(**args)
10583
+ update!(**args)
10584
+ end
10585
+
10586
+ # Update properties of this object
10587
+ def update!(**args)
10588
+ @create_time = args[:create_time] if args.key?(:create_time)
10589
+ @update_time = args[:update_time] if args.key?(:update_time)
10590
+ end
10591
+ end
10592
+
10099
10593
  # Metadata related to the progress of the SiteSearchEngineService.
10100
10594
  # CreateTargetSite operation. This will be returned by the google.longrunning.
10101
10595
  # Operation.metadata field.
@@ -10425,6 +10919,33 @@ module Google
10425
10919
  end
10426
10920
  end
10427
10921
 
10922
+ # The historical dedicated crawl rate timeseries data, used for monitoring.
10923
+ # Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
10924
+ # crawl is set.
10925
+ class GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries
10926
+ include Google::Apis::Core::Hashable
10927
+
10928
+ # The historical crawl rate timeseries data, used for monitoring.
10929
+ # Corresponds to the JSON property `autoRefreshCrawlRate`
10930
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
10931
+ attr_accessor :auto_refresh_crawl_rate
10932
+
10933
+ # The historical crawl rate timeseries data, used for monitoring.
10934
+ # Corresponds to the JSON property `userTriggeredCrawlRate`
10935
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
10936
+ attr_accessor :user_triggered_crawl_rate
10937
+
10938
+ def initialize(**args)
10939
+ update!(**args)
10940
+ end
10941
+
10942
+ # Update properties of this object
10943
+ def update!(**args)
10944
+ @auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
10945
+ @user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
10946
+ end
10947
+ end
10948
+
10428
10949
  # Metadata related to the progress of the DataStoreService.DeleteDataStore
10429
10950
  # operation. This will be returned by the google.longrunning.Operation.metadata
10430
10951
  # field.
@@ -10506,10 +11027,10 @@ module Google
10506
11027
  end
10507
11028
  end
10508
11029
 
10509
- # Metadata related to the progress of the SiteSearchEngineService.
10510
- # DeleteTargetSite operation. This will be returned by the google.longrunning.
10511
- # Operation.metadata field.
10512
- class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
11030
+ # Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
11031
+ # operation. This will be returned by the google.longrunning.Operation.metadata
11032
+ # field.
11033
+ class GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata
10513
11034
  include Google::Apis::Core::Hashable
10514
11035
 
10515
11036
  # Operation create time.
@@ -10535,9 +11056,9 @@ module Google
10535
11056
  end
10536
11057
 
10537
11058
  # Metadata related to the progress of the SiteSearchEngineService.
10538
- # DisableAdvancedSiteSearch operation. This will be returned by the google.
10539
- # longrunning.Operation.metadata field.
10540
- class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
11059
+ # DeleteTargetSite operation. This will be returned by the google.longrunning.
11060
+ # Operation.metadata field.
11061
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
10541
11062
  include Google::Apis::Core::Hashable
10542
11063
 
10543
11064
  # Operation create time.
@@ -10562,10 +11083,38 @@ module Google
10562
11083
  end
10563
11084
  end
10564
11085
 
10565
- # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
10566
- class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
10567
- include Google::Apis::Core::Hashable
10568
-
11086
+ # Metadata related to the progress of the SiteSearchEngineService.
11087
+ # DisableAdvancedSiteSearch operation. This will be returned by the google.
11088
+ # longrunning.Operation.metadata field.
11089
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
11090
+ include Google::Apis::Core::Hashable
11091
+
11092
+ # Operation create time.
11093
+ # Corresponds to the JSON property `createTime`
11094
+ # @return [String]
11095
+ attr_accessor :create_time
11096
+
11097
+ # Operation last update time. If the operation is done, this is also the finish
11098
+ # time.
11099
+ # Corresponds to the JSON property `updateTime`
11100
+ # @return [String]
11101
+ attr_accessor :update_time
11102
+
11103
+ def initialize(**args)
11104
+ update!(**args)
11105
+ end
11106
+
11107
+ # Update properties of this object
11108
+ def update!(**args)
11109
+ @create_time = args[:create_time] if args.key?(:create_time)
11110
+ @update_time = args[:update_time] if args.key?(:update_time)
11111
+ end
11112
+ end
11113
+
11114
+ # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
11115
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
11116
+ include Google::Apis::Core::Hashable
11117
+
10569
11118
  def initialize(**args)
10570
11119
  update!(**args)
10571
11120
  end
@@ -11360,6 +11909,44 @@ module Google
11360
11909
  end
11361
11910
  end
11362
11911
 
11912
+ # Response message for SiteSearchEngineService.FetchSitemaps method.
11913
+ class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
11914
+ include Google::Apis::Core::Hashable
11915
+
11916
+ # List of Sitemaps fetched.
11917
+ # Corresponds to the JSON property `sitemapsMetadata`
11918
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata>]
11919
+ attr_accessor :sitemaps_metadata
11920
+
11921
+ def initialize(**args)
11922
+ update!(**args)
11923
+ end
11924
+
11925
+ # Update properties of this object
11926
+ def update!(**args)
11927
+ @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
11928
+ end
11929
+ end
11930
+
11931
+ # Contains a Sitemap and its metadata.
11932
+ class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata
11933
+ include Google::Apis::Core::Hashable
11934
+
11935
+ # A sitemap for the SiteSearchEngine.
11936
+ # Corresponds to the JSON property `sitemap`
11937
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSitemap]
11938
+ attr_accessor :sitemap
11939
+
11940
+ def initialize(**args)
11941
+ update!(**args)
11942
+ end
11943
+
11944
+ # Update properties of this object
11945
+ def update!(**args)
11946
+ @sitemap = args[:sitemap] if args.key?(:sitemap)
11947
+ end
11948
+ end
11949
+
11363
11950
  # Configurations for fields of a schema. For example, configuring a field is
11364
11951
  # indexable, or searchable.
11365
11952
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -12058,6 +12645,83 @@ module Google
12058
12645
  end
12059
12646
  end
12060
12647
 
12648
+ # Response message for CrawlRateManagementService.ObtainCrawlRate method. The
12649
+ # response contains organcic or dedicated crawl rate time series data for
12650
+ # monitoring, depending on whether dedicated crawl rate is set.
12651
+ class GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse
12652
+ include Google::Apis::Core::Hashable
12653
+
12654
+ # The historical dedicated crawl rate timeseries data, used for monitoring.
12655
+ # Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
12656
+ # crawl is set.
12657
+ # Corresponds to the JSON property `dedicatedCrawlRateTimeSeries`
12658
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries]
12659
+ attr_accessor :dedicated_crawl_rate_time_series
12660
+
12661
+ # The `Status` type defines a logical error model that is suitable for different
12662
+ # programming environments, including REST APIs and RPC APIs. It is used by [
12663
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
12664
+ # data: error code, error message, and error details. You can find out more
12665
+ # about this error model and how to work with it in the [API Design Guide](https:
12666
+ # //cloud.google.com/apis/design/errors).
12667
+ # Corresponds to the JSON property `error`
12668
+ # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
12669
+ attr_accessor :error
12670
+
12671
+ # The historical organic crawl rate timeseries data, used for monitoring.
12672
+ # Organic crawl is auto-determined by Google to crawl the user's website when
12673
+ # dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
12674
+ # to the user's website.
12675
+ # Corresponds to the JSON property `organicCrawlRateTimeSeries`
12676
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries]
12677
+ attr_accessor :organic_crawl_rate_time_series
12678
+
12679
+ # Output only. The state of the response.
12680
+ # Corresponds to the JSON property `state`
12681
+ # @return [String]
12682
+ attr_accessor :state
12683
+
12684
+ def initialize(**args)
12685
+ update!(**args)
12686
+ end
12687
+
12688
+ # Update properties of this object
12689
+ def update!(**args)
12690
+ @dedicated_crawl_rate_time_series = args[:dedicated_crawl_rate_time_series] if args.key?(:dedicated_crawl_rate_time_series)
12691
+ @error = args[:error] if args.key?(:error)
12692
+ @organic_crawl_rate_time_series = args[:organic_crawl_rate_time_series] if args.key?(:organic_crawl_rate_time_series)
12693
+ @state = args[:state] if args.key?(:state)
12694
+ end
12695
+ end
12696
+
12697
+ # The historical organic crawl rate timeseries data, used for monitoring.
12698
+ # Organic crawl is auto-determined by Google to crawl the user's website when
12699
+ # dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
12700
+ # to the user's website.
12701
+ class GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries
12702
+ include Google::Apis::Core::Hashable
12703
+
12704
+ # The historical crawl rate timeseries data, used for monitoring.
12705
+ # Corresponds to the JSON property `googleOrganicCrawlRate`
12706
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
12707
+ attr_accessor :google_organic_crawl_rate
12708
+
12709
+ # The historical crawl rate timeseries data, used for monitoring.
12710
+ # Corresponds to the JSON property `vertexAiOrganicCrawlRate`
12711
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
12712
+ attr_accessor :vertex_ai_organic_crawl_rate
12713
+
12714
+ def initialize(**args)
12715
+ update!(**args)
12716
+ end
12717
+
12718
+ # Update properties of this object
12719
+ def update!(**args)
12720
+ @google_organic_crawl_rate = args[:google_organic_crawl_rate] if args.key?(:google_organic_crawl_rate)
12721
+ @vertex_ai_organic_crawl_rate = args[:vertex_ai_organic_crawl_rate] if args.key?(:vertex_ai_organic_crawl_rate)
12722
+ end
12723
+ end
12724
+
12061
12725
  # Metadata and configurations for a Google Cloud project in the service.
12062
12726
  class GoogleCloudDiscoveryengineV1alphaProject
12063
12727
  include Google::Apis::Core::Hashable
@@ -14055,6 +14719,39 @@ module Google
14055
14719
  end
14056
14720
  end
14057
14721
 
14722
+ # A sitemap for the SiteSearchEngine.
14723
+ class GoogleCloudDiscoveryengineV1alphaSitemap
14724
+ include Google::Apis::Core::Hashable
14725
+
14726
+ # Output only. The sitemap's creation time.
14727
+ # Corresponds to the JSON property `createTime`
14728
+ # @return [String]
14729
+ attr_accessor :create_time
14730
+
14731
+ # Output only. The fully qualified resource name of the sitemap. `projects/*/
14732
+ # locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
14733
+ # sitemap_id` suffix is system-generated.
14734
+ # Corresponds to the JSON property `name`
14735
+ # @return [String]
14736
+ attr_accessor :name
14737
+
14738
+ # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
14739
+ # Corresponds to the JSON property `uri`
14740
+ # @return [String]
14741
+ attr_accessor :uri
14742
+
14743
+ def initialize(**args)
14744
+ update!(**args)
14745
+ end
14746
+
14747
+ # Update properties of this object
14748
+ def update!(**args)
14749
+ @create_time = args[:create_time] if args.key?(:create_time)
14750
+ @name = args[:name] if args.key?(:name)
14751
+ @uri = args[:uri] if args.key?(:uri)
14752
+ end
14753
+ end
14754
+
14058
14755
  # A target site for the SiteSearchEngine.
14059
14756
  class GoogleCloudDiscoveryengineV1alphaTargetSite
14060
14757
  include Google::Apis::Core::Hashable
@@ -14936,6 +15633,34 @@ module Google
14936
15633
  end
14937
15634
  end
14938
15635
 
15636
+ # Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
15637
+ # operation. This will be returned by the google.longrunning.Operation.metadata
15638
+ # field.
15639
+ class GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata
15640
+ include Google::Apis::Core::Hashable
15641
+
15642
+ # Operation create time.
15643
+ # Corresponds to the JSON property `createTime`
15644
+ # @return [String]
15645
+ attr_accessor :create_time
15646
+
15647
+ # Operation last update time. If the operation is done, this is also the finish
15648
+ # time.
15649
+ # Corresponds to the JSON property `updateTime`
15650
+ # @return [String]
15651
+ attr_accessor :update_time
15652
+
15653
+ def initialize(**args)
15654
+ update!(**args)
15655
+ end
15656
+
15657
+ # Update properties of this object
15658
+ def update!(**args)
15659
+ @create_time = args[:create_time] if args.key?(:create_time)
15660
+ @update_time = args[:update_time] if args.key?(:update_time)
15661
+ end
15662
+ end
15663
+
14939
15664
  # Metadata related to the progress of the SiteSearchEngineService.
14940
15665
  # CreateTargetSite operation. This will be returned by the google.longrunning.
14941
15666
  # Operation.metadata field.
@@ -15308,6 +16033,34 @@ module Google
15308
16033
  end
15309
16034
  end
15310
16035
 
16036
+ # Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
16037
+ # operation. This will be returned by the google.longrunning.Operation.metadata
16038
+ # field.
16039
+ class GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata
16040
+ include Google::Apis::Core::Hashable
16041
+
16042
+ # Operation create time.
16043
+ # Corresponds to the JSON property `createTime`
16044
+ # @return [String]
16045
+ attr_accessor :create_time
16046
+
16047
+ # Operation last update time. If the operation is done, this is also the finish
16048
+ # time.
16049
+ # Corresponds to the JSON property `updateTime`
16050
+ # @return [String]
16051
+ attr_accessor :update_time
16052
+
16053
+ def initialize(**args)
16054
+ update!(**args)
16055
+ end
16056
+
16057
+ # Update properties of this object
16058
+ def update!(**args)
16059
+ @create_time = args[:create_time] if args.key?(:create_time)
16060
+ @update_time = args[:update_time] if args.key?(:update_time)
16061
+ end
16062
+ end
16063
+
15311
16064
  # Metadata related to the progress of the SiteSearchEngineService.
15312
16065
  # DeleteTargetSite operation. This will be returned by the google.longrunning.
15313
16066
  # Operation.metadata field.
@@ -15962,6 +16715,44 @@ module Google
15962
16715
  end
15963
16716
  end
15964
16717
 
16718
+ # Response message for SiteSearchEngineService.FetchSitemaps method.
16719
+ class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
16720
+ include Google::Apis::Core::Hashable
16721
+
16722
+ # List of Sitemaps fetched.
16723
+ # Corresponds to the JSON property `sitemapsMetadata`
16724
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata>]
16725
+ attr_accessor :sitemaps_metadata
16726
+
16727
+ def initialize(**args)
16728
+ update!(**args)
16729
+ end
16730
+
16731
+ # Update properties of this object
16732
+ def update!(**args)
16733
+ @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
16734
+ end
16735
+ end
16736
+
16737
+ # Contains a Sitemap and its metadata.
16738
+ class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata
16739
+ include Google::Apis::Core::Hashable
16740
+
16741
+ # A sitemap for the SiteSearchEngine.
16742
+ # Corresponds to the JSON property `sitemap`
16743
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSitemap]
16744
+ attr_accessor :sitemap
16745
+
16746
+ def initialize(**args)
16747
+ update!(**args)
16748
+ end
16749
+
16750
+ # Update properties of this object
16751
+ def update!(**args)
16752
+ @sitemap = args[:sitemap] if args.key?(:sitemap)
16753
+ end
16754
+ end
16755
+
15965
16756
  # Metadata related to the progress of the ImportCompletionSuggestions operation.
15966
16757
  # This will be returned by the google.longrunning.Operation.metadata field.
15967
16758
  class GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata
@@ -18022,6 +18813,39 @@ module Google
18022
18813
  end
18023
18814
  end
18024
18815
 
18816
+ # A sitemap for the SiteSearchEngine.
18817
+ class GoogleCloudDiscoveryengineV1betaSitemap
18818
+ include Google::Apis::Core::Hashable
18819
+
18820
+ # Output only. The sitemap's creation time.
18821
+ # Corresponds to the JSON property `createTime`
18822
+ # @return [String]
18823
+ attr_accessor :create_time
18824
+
18825
+ # Output only. The fully qualified resource name of the sitemap. `projects/*/
18826
+ # locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
18827
+ # sitemap_id` suffix is system-generated.
18828
+ # Corresponds to the JSON property `name`
18829
+ # @return [String]
18830
+ attr_accessor :name
18831
+
18832
+ # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
18833
+ # Corresponds to the JSON property `uri`
18834
+ # @return [String]
18835
+ attr_accessor :uri
18836
+
18837
+ def initialize(**args)
18838
+ update!(**args)
18839
+ end
18840
+
18841
+ # Update properties of this object
18842
+ def update!(**args)
18843
+ @create_time = args[:create_time] if args.key?(:create_time)
18844
+ @name = args[:name] if args.key?(:name)
18845
+ @uri = args[:uri] if args.key?(:uri)
18846
+ end
18847
+ end
18848
+
18025
18849
  # A target site for the SiteSearchEngine.
18026
18850
  class GoogleCloudDiscoveryengineV1betaTargetSite
18027
18851
  include Google::Apis::Core::Hashable
@@ -18484,6 +19308,214 @@ module Google
18484
19308
  end
18485
19309
  end
18486
19310
 
19311
+ # A single data point in a time series.
19312
+ class GoogleMonitoringV3Point
19313
+ include Google::Apis::Core::Hashable
19314
+
19315
+ # A time interval extending just after a start time through an end time. If the
19316
+ # start time is the same as the end time, then the interval represents a single
19317
+ # point in time.
19318
+ # Corresponds to the JSON property `interval`
19319
+ # @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TimeInterval]
19320
+ attr_accessor :interval
19321
+
19322
+ # A single strongly-typed value.
19323
+ # Corresponds to the JSON property `value`
19324
+ # @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TypedValue]
19325
+ attr_accessor :value
19326
+
19327
+ def initialize(**args)
19328
+ update!(**args)
19329
+ end
19330
+
19331
+ # Update properties of this object
19332
+ def update!(**args)
19333
+ @interval = args[:interval] if args.key?(:interval)
19334
+ @value = args[:value] if args.key?(:value)
19335
+ end
19336
+ end
19337
+
19338
+ # A time interval extending just after a start time through an end time. If the
19339
+ # start time is the same as the end time, then the interval represents a single
19340
+ # point in time.
19341
+ class GoogleMonitoringV3TimeInterval
19342
+ include Google::Apis::Core::Hashable
19343
+
19344
+ # Required. The end of the time interval.
19345
+ # Corresponds to the JSON property `endTime`
19346
+ # @return [String]
19347
+ attr_accessor :end_time
19348
+
19349
+ # Optional. The beginning of the time interval. The default value for the start
19350
+ # time is the end time. The start time must not be later than the end time.
19351
+ # Corresponds to the JSON property `startTime`
19352
+ # @return [String]
19353
+ attr_accessor :start_time
19354
+
19355
+ def initialize(**args)
19356
+ update!(**args)
19357
+ end
19358
+
19359
+ # Update properties of this object
19360
+ def update!(**args)
19361
+ @end_time = args[:end_time] if args.key?(:end_time)
19362
+ @start_time = args[:start_time] if args.key?(:start_time)
19363
+ end
19364
+ end
19365
+
19366
+ # A collection of data points that describes the time-varying values of a metric.
19367
+ # A time series is identified by a combination of a fully-specified monitored
19368
+ # resource and a fully-specified metric. This type is used for both listing and
19369
+ # creating time series.
19370
+ class GoogleMonitoringV3TimeSeries
19371
+ include Google::Apis::Core::Hashable
19372
+
19373
+ # Input only. A detailed description of the time series that will be associated
19374
+ # with the google.api.MetricDescriptor for the metric. Once set, this field
19375
+ # cannot be changed through CreateTimeSeries.
19376
+ # Corresponds to the JSON property `description`
19377
+ # @return [String]
19378
+ attr_accessor :description
19379
+
19380
+ # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects
19381
+ # contain the minimum set of information to uniquely identify a monitored
19382
+ # resource instance. There is some other useful auxiliary metadata. Monitoring
19383
+ # and Logging use an ingestion pipeline to extract metadata for cloud resources
19384
+ # of all types, and store the metadata in this message.
19385
+ # Corresponds to the JSON property `metadata`
19386
+ # @return [Google::Apis::DiscoveryengineV1::GoogleApiMonitoredResourceMetadata]
19387
+ attr_accessor :metadata
19388
+
19389
+ # A specific metric, identified by specifying values for all of the labels of a `
19390
+ # MetricDescriptor`.
19391
+ # Corresponds to the JSON property `metric`
19392
+ # @return [Google::Apis::DiscoveryengineV1::GoogleApiMetric]
19393
+ attr_accessor :metric
19394
+
19395
+ # The metric kind of the time series. When listing time series, this metric kind
19396
+ # might be different from the metric kind of the associated metric if this time
19397
+ # series is an alignment or reduction of other time series. When creating a time
19398
+ # series, this field is optional. If present, it must be the same as the metric
19399
+ # kind of the associated metric. If the associated metric's descriptor must be
19400
+ # auto-created, then this field specifies the metric kind of the new descriptor
19401
+ # and must be either `GAUGE` (the default) or `CUMULATIVE`.
19402
+ # Corresponds to the JSON property `metricKind`
19403
+ # @return [String]
19404
+ attr_accessor :metric_kind
19405
+
19406
+ # The data points of this time series. When listing time series, points are
19407
+ # returned in reverse time order. When creating a time series, this field must
19408
+ # contain exactly one point and the point's type must be the same as the value
19409
+ # type of the associated metric. If the associated metric's descriptor must be
19410
+ # auto-created, then the value type of the descriptor is determined by the point'
19411
+ # s type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
19412
+ # Corresponds to the JSON property `points`
19413
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleMonitoringV3Point>]
19414
+ attr_accessor :points
19415
+
19416
+ # An object representing a resource that can be used for monitoring, logging,
19417
+ # billing, or other purposes. Examples include virtual machine instances,
19418
+ # databases, and storage devices such as disks. The `type` field identifies a
19419
+ # MonitoredResourceDescriptor object that describes the resource's schema.
19420
+ # Information in the `labels` field identifies the actual resource and its
19421
+ # attributes according to the schema. For example, a particular Compute Engine
19422
+ # VM instance could be represented by the following object, because the
19423
+ # MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"
19424
+ # instance_id"` and `"zone"`: ` "type": "gce_instance", "labels": ` "project_id":
19425
+ # "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" ``
19426
+ # Corresponds to the JSON property `resource`
19427
+ # @return [Google::Apis::DiscoveryengineV1::GoogleApiMonitoredResource]
19428
+ attr_accessor :resource
19429
+
19430
+ # The units in which the metric value is reported. It is only applicable if the `
19431
+ # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
19432
+ # representation of the stored metric values. This field can only be changed
19433
+ # through CreateTimeSeries when it is empty.
19434
+ # Corresponds to the JSON property `unit`
19435
+ # @return [String]
19436
+ attr_accessor :unit
19437
+
19438
+ # The value type of the time series. When listing time series, this value type
19439
+ # might be different from the value type of the associated metric if this time
19440
+ # series is an alignment or reduction of other time series. When creating a time
19441
+ # series, this field is optional. If present, it must be the same as the type of
19442
+ # the data in the `points` field.
19443
+ # Corresponds to the JSON property `valueType`
19444
+ # @return [String]
19445
+ attr_accessor :value_type
19446
+
19447
+ def initialize(**args)
19448
+ update!(**args)
19449
+ end
19450
+
19451
+ # Update properties of this object
19452
+ def update!(**args)
19453
+ @description = args[:description] if args.key?(:description)
19454
+ @metadata = args[:metadata] if args.key?(:metadata)
19455
+ @metric = args[:metric] if args.key?(:metric)
19456
+ @metric_kind = args[:metric_kind] if args.key?(:metric_kind)
19457
+ @points = args[:points] if args.key?(:points)
19458
+ @resource = args[:resource] if args.key?(:resource)
19459
+ @unit = args[:unit] if args.key?(:unit)
19460
+ @value_type = args[:value_type] if args.key?(:value_type)
19461
+ end
19462
+ end
19463
+
19464
+ # A single strongly-typed value.
19465
+ class GoogleMonitoringV3TypedValue
19466
+ include Google::Apis::Core::Hashable
19467
+
19468
+ # A Boolean value: `true` or `false`.
19469
+ # Corresponds to the JSON property `boolValue`
19470
+ # @return [Boolean]
19471
+ attr_accessor :bool_value
19472
+ alias_method :bool_value?, :bool_value
19473
+
19474
+ # `Distribution` contains summary statistics for a population of values. It
19475
+ # optionally contains a histogram representing the distribution of those values
19476
+ # across a set of buckets. The summary statistics are the count, mean, sum of
19477
+ # the squared deviation from the mean, the minimum, and the maximum of the set
19478
+ # of population of values. The histogram is based on a sequence of buckets and
19479
+ # gives a count of values that fall into each bucket. The boundaries of the
19480
+ # buckets are given either explicitly or by formulas for buckets of fixed or
19481
+ # exponentially increasing widths. Although it is not forbidden, it is generally
19482
+ # a bad idea to include non-finite values (infinities or NaNs) in the population
19483
+ # of values, as this will render the `mean` and `sum_of_squared_deviation`
19484
+ # fields meaningless.
19485
+ # Corresponds to the JSON property `distributionValue`
19486
+ # @return [Google::Apis::DiscoveryengineV1::GoogleApiDistribution]
19487
+ attr_accessor :distribution_value
19488
+
19489
+ # A 64-bit double-precision floating-point number. Its magnitude is
19490
+ # approximately ±10±300 and it has 16 significant digits of precision.
19491
+ # Corresponds to the JSON property `doubleValue`
19492
+ # @return [Float]
19493
+ attr_accessor :double_value
19494
+
19495
+ # A 64-bit integer. Its range is approximately ±9.2x1018.
19496
+ # Corresponds to the JSON property `int64Value`
19497
+ # @return [Fixnum]
19498
+ attr_accessor :int64_value
19499
+
19500
+ # A variable-length string value.
19501
+ # Corresponds to the JSON property `stringValue`
19502
+ # @return [String]
19503
+ attr_accessor :string_value
19504
+
19505
+ def initialize(**args)
19506
+ update!(**args)
19507
+ end
19508
+
19509
+ # Update properties of this object
19510
+ def update!(**args)
19511
+ @bool_value = args[:bool_value] if args.key?(:bool_value)
19512
+ @distribution_value = args[:distribution_value] if args.key?(:distribution_value)
19513
+ @double_value = args[:double_value] if args.key?(:double_value)
19514
+ @int64_value = args[:int64_value] if args.key?(:int64_value)
19515
+ @string_value = args[:string_value] if args.key?(:string_value)
19516
+ end
19517
+ end
19518
+
18487
19519
  # A generic empty message that you can re-use to avoid defining duplicated empty
18488
19520
  # messages in your APIs. A typical example is to use it as the request or the
18489
19521
  # response type of an API method. For instance: service Foo ` rpc Bar(google.