google-apis-cloudsearch_v1 0.15.0 → 0.19.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8c7f4be8d6e02cd206541311fa5738c5054bba28f4a079a7cad87518ed49f2da
4
- data.tar.gz: 5faf4550880e7e9bf868ef4556c1025e1ca26a54d8693c788ef70177a9aeb302
3
+ metadata.gz: 16b3d47ea6c18afb6ed35176cf9a924b7d32a9aa5f58c240dc10e5fbf890ed45
4
+ data.tar.gz: 060566d790bcadee23fe39f0341eb7ba031be0b417ceb6c87b6f2dd6cf14ea7e
5
5
  SHA512:
6
- metadata.gz: 130a1cd8b3c57b603886b326e0e26c2e7b8aa09b00c2eafb47bbe68056d4d53abd773e7e035c35c579ab5361c2c129a21d97634ca584d3a95226965674b79a72
7
- data.tar.gz: bae1c843b26895122481171ae7a294fdc6267bcbbc83d0cc70f833ab9fc18f8c8af77ad1501517e73ee9eb87a2a27df6647ce5d85c9c5be0aa3001deec073ec1
6
+ metadata.gz: 5092793fefe0b67e06314a28fe786d8865c502d64e292e88b318b7a95d406f75cfd0a191ef9f837d8c59375bebde838ee05477c77d4db7138418e7d83916a832
7
+ data.tar.gz: 6e47aaefb8b909e6d55b797d75521e2511b3b7689ba3099747673efdae2c2dc0b713d3c1360faf3a4bda390e80683223f1a4d164338cadd9e2d0943cf6ab3c8b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Release history for google-apis-cloudsearch_v1
2
2
 
3
+ ### v0.19.0 (2022-02-07)
4
+
5
+ * Regenerated from discovery document revision 20220201
6
+
7
+ ### v0.18.0 (2022-01-31)
8
+
9
+ * Regenerated from discovery document revision 20220125
10
+
11
+ ### v0.17.0 (2022-01-24)
12
+
13
+ * Regenerated from discovery document revision 20220118
14
+ * Regenerated using generator version 0.4.1
15
+
16
+ ### v0.16.0 (2021-12-16)
17
+
18
+ * Regenerated from discovery document revision 20211208
19
+
3
20
  ### v0.15.0 (2021-12-01)
4
21
 
5
22
  * Regenerated from discovery document revision 20211123
data/OVERVIEW.md CHANGED
@@ -51,7 +51,7 @@ require "google/apis/cloudsearch_v1"
51
51
  client = Google::Apis::CloudsearchV1::CloudSearchService.new
52
52
 
53
53
  # Authenticate calls
54
- client.authentication = # ... use the googleauth gem to create credentials
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
55
  ```
56
56
 
57
57
  See the class reference docs for information on the methods you can call from a client.
@@ -22,6 +22,37 @@ module Google
22
22
  module Apis
23
23
  module CloudsearchV1
24
24
 
25
+ # Next tag: 4
26
+ class AclInfo
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Number of groups which have at least read access to the document.
30
+ # Corresponds to the JSON property `groupsCount`
31
+ # @return [Fixnum]
32
+ attr_accessor :groups_count
33
+
34
+ # The scope to which the content was shared.
35
+ # Corresponds to the JSON property `scope`
36
+ # @return [String]
37
+ attr_accessor :scope
38
+
39
+ # Number of users which have at least read access to the document.
40
+ # Corresponds to the JSON property `usersCount`
41
+ # @return [Fixnum]
42
+ attr_accessor :users_count
43
+
44
+ def initialize(**args)
45
+ update!(**args)
46
+ end
47
+
48
+ # Update properties of this object
49
+ def update!(**args)
50
+ @groups_count = args[:groups_count] if args.key?(:groups_count)
51
+ @scope = args[:scope] if args.key?(:scope)
52
+ @users_count = args[:users_count] if args.key?(:users_count)
53
+ end
54
+ end
55
+
25
56
  # Represents the settings for Cloud audit logging
26
57
  class AuditLoggingSettings
27
58
  include Google::Apis::Core::Hashable
@@ -250,6 +281,35 @@ module Google
250
281
  end
251
282
  end
252
283
 
284
+ # Search application stats for a customer for the given date.
285
+ class CustomerSearchApplicationStats
286
+ include Google::Apis::Core::Hashable
287
+
288
+ # The count of search applications for the date.
289
+ # Corresponds to the JSON property `count`
290
+ # @return [Fixnum]
291
+ attr_accessor :count
292
+
293
+ # Represents a whole calendar date, for example a date of birth. The time of day
294
+ # and time zone are either specified elsewhere or are not significant. The date
295
+ # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/
296
+ # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date
297
+ # between the year 1 and 9999.
298
+ # Corresponds to the JSON property `date`
299
+ # @return [Google::Apis::CloudsearchV1::Date]
300
+ attr_accessor :date
301
+
302
+ def initialize(**args)
303
+ update!(**args)
304
+ end
305
+
306
+ # Update properties of this object
307
+ def update!(**args)
308
+ @count = args[:count] if args.key?(:count)
309
+ @date = args[:date] if args.key?(:date)
310
+ end
311
+ end
312
+
253
313
  #
254
314
  class CustomerSessionStats
255
315
  include Google::Apis::Core::Hashable
@@ -398,6 +458,12 @@ module Google
398
458
  # @return [Array<String>]
399
459
  attr_accessor :operation_ids
400
460
 
461
+ # Can a user request to get thumbnail URI for Items indexed in this data source.
462
+ # Corresponds to the JSON property `returnThumbnailUrls`
463
+ # @return [Boolean]
464
+ attr_accessor :return_thumbnail_urls
465
+ alias_method :return_thumbnail_urls?, :return_thumbnail_urls
466
+
401
467
  # A short name or alias for the source. This value will be used to match the '
402
468
  # source' operator. For example, if the short name is *<value>* then queries
403
469
  # like *source:<value>* will only return results for this source. The value must
@@ -422,6 +488,7 @@ module Google
422
488
  @items_visibility = args[:items_visibility] if args.key?(:items_visibility)
423
489
  @name = args[:name] if args.key?(:name)
424
490
  @operation_ids = args[:operation_ids] if args.key?(:operation_ids)
491
+ @return_thumbnail_urls = args[:return_thumbnail_urls] if args.key?(:return_thumbnail_urls)
425
492
  @short_name = args[:short_name] if args.key?(:short_name)
426
493
  end
427
494
  end
@@ -1319,6 +1386,11 @@ module Google
1319
1386
  class GetCustomerIndexStatsResponse
1320
1387
  include Google::Apis::Core::Hashable
1321
1388
 
1389
+ # Average item count for the given date range for which billing is done.
1390
+ # Corresponds to the JSON property `averageIndexedItemCount`
1391
+ # @return [Fixnum]
1392
+ attr_accessor :average_indexed_item_count
1393
+
1322
1394
  # Summary of indexed item counts, one for each day in the requested range.
1323
1395
  # Corresponds to the JSON property `stats`
1324
1396
  # @return [Array<Google::Apis::CloudsearchV1::CustomerIndexStats>]
@@ -1330,6 +1402,7 @@ module Google
1330
1402
 
1331
1403
  # Update properties of this object
1332
1404
  def update!(**args)
1405
+ @average_indexed_item_count = args[:average_indexed_item_count] if args.key?(:average_indexed_item_count)
1333
1406
  @stats = args[:stats] if args.key?(:stats)
1334
1407
  end
1335
1408
  end
@@ -1343,12 +1416,43 @@ module Google
1343
1416
  # @return [Array<Google::Apis::CloudsearchV1::CustomerQueryStats>]
1344
1417
  attr_accessor :stats
1345
1418
 
1419
+ # Total successful query count (status code 200) for the given date range.
1420
+ # Corresponds to the JSON property `totalQueryCount`
1421
+ # @return [Fixnum]
1422
+ attr_accessor :total_query_count
1423
+
1424
+ def initialize(**args)
1425
+ update!(**args)
1426
+ end
1427
+
1428
+ # Update properties of this object
1429
+ def update!(**args)
1430
+ @stats = args[:stats] if args.key?(:stats)
1431
+ @total_query_count = args[:total_query_count] if args.key?(:total_query_count)
1432
+ end
1433
+ end
1434
+
1435
+ # Response format for search application stats for a customer.
1436
+ class GetCustomerSearchApplicationStatsResponse
1437
+ include Google::Apis::Core::Hashable
1438
+
1439
+ # Average search application count for the given date range.
1440
+ # Corresponds to the JSON property `averageSearchApplicationCount`
1441
+ # @return [Fixnum]
1442
+ attr_accessor :average_search_application_count
1443
+
1444
+ # Search application stats by date.
1445
+ # Corresponds to the JSON property `stats`
1446
+ # @return [Array<Google::Apis::CloudsearchV1::CustomerSearchApplicationStats>]
1447
+ attr_accessor :stats
1448
+
1346
1449
  def initialize(**args)
1347
1450
  update!(**args)
1348
1451
  end
1349
1452
 
1350
1453
  # Update properties of this object
1351
1454
  def update!(**args)
1455
+ @average_search_application_count = args[:average_search_application_count] if args.key?(:average_search_application_count)
1352
1456
  @stats = args[:stats] if args.key?(:stats)
1353
1457
  end
1354
1458
  end
@@ -1395,6 +1499,11 @@ module Google
1395
1499
  class GetDataSourceIndexStatsResponse
1396
1500
  include Google::Apis::Core::Hashable
1397
1501
 
1502
+ # Average item count for the given date range for which billing is done.
1503
+ # Corresponds to the JSON property `averageIndexedItemCount`
1504
+ # @return [Fixnum]
1505
+ attr_accessor :average_indexed_item_count
1506
+
1398
1507
  # Summary of indexed item counts, one for each day in the requested range.
1399
1508
  # Corresponds to the JSON property `stats`
1400
1509
  # @return [Array<Google::Apis::CloudsearchV1::DataSourceIndexStats>]
@@ -1406,6 +1515,7 @@ module Google
1406
1515
 
1407
1516
  # Update properties of this object
1408
1517
  def update!(**args)
1518
+ @average_indexed_item_count = args[:average_indexed_item_count] if args.key?(:average_indexed_item_count)
1409
1519
  @stats = args[:stats] if args.key?(:stats)
1410
1520
  end
1411
1521
  end
@@ -1420,6 +1530,11 @@ module Google
1420
1530
  # @return [Array<Google::Apis::CloudsearchV1::SearchApplicationQueryStats>]
1421
1531
  attr_accessor :stats
1422
1532
 
1533
+ # Total successful query count (status code 200) for the given date range.
1534
+ # Corresponds to the JSON property `totalQueryCount`
1535
+ # @return [Fixnum]
1536
+ attr_accessor :total_query_count
1537
+
1423
1538
  def initialize(**args)
1424
1539
  update!(**args)
1425
1540
  end
@@ -1427,6 +1542,7 @@ module Google
1427
1542
  # Update properties of this object
1428
1543
  def update!(**args)
1429
1544
  @stats = args[:stats] if args.key?(:stats)
1545
+ @total_query_count = args[:total_query_count] if args.key?(:total_query_count)
1430
1546
  end
1431
1547
  end
1432
1548
 
@@ -1468,6 +1584,119 @@ module Google
1468
1584
  end
1469
1585
  end
1470
1586
 
1587
+ # The corpus specific metadata for office-type documents, from Google Docs and
1588
+ # other sources. This message is passed to the scorer and beyond. Next tag: 7
1589
+ class GoogleDocsMetadata
1590
+ include Google::Apis::Core::Hashable
1591
+
1592
+ # Next tag: 4
1593
+ # Corresponds to the JSON property `aclInfo`
1594
+ # @return [Google::Apis::CloudsearchV1::AclInfo]
1595
+ attr_accessor :acl_info
1596
+
1597
+ # The conceptual type (presentation, document, etc.) of this document.
1598
+ # Corresponds to the JSON property `documentType`
1599
+ # @return [String]
1600
+ attr_accessor :document_type
1601
+
1602
+ # The file extension of the document. NOTE: As of October 2018 this field is not
1603
+ # backfilled for old documents.
1604
+ # Corresponds to the JSON property `fileExtension`
1605
+ # @return [String]
1606
+ attr_accessor :file_extension
1607
+
1608
+ # The last time this document was modified, in seconds since epoch. Only counts
1609
+ # content modifications.
1610
+ # Corresponds to the JSON property `lastContentModifiedTimestamp`
1611
+ # @return [Fixnum]
1612
+ attr_accessor :last_content_modified_timestamp
1613
+
1614
+ # A message containing information about a specific result. This information is
1615
+ # passed to the scorer and beyond; in particular, GWS relies on it to format the
1616
+ # result in the UI. Split from GoogleDocsMetadata in case we later want to reuse
1617
+ # the message.
1618
+ # Corresponds to the JSON property `resultInfo`
1619
+ # @return [Google::Apis::CloudsearchV1::GoogleDocsResultInfo]
1620
+ attr_accessor :result_info
1621
+
1622
+ # Next tag: 2
1623
+ # Corresponds to the JSON property `typeInfo`
1624
+ # @return [Google::Apis::CloudsearchV1::TypeInfo]
1625
+ attr_accessor :type_info
1626
+
1627
+ def initialize(**args)
1628
+ update!(**args)
1629
+ end
1630
+
1631
+ # Update properties of this object
1632
+ def update!(**args)
1633
+ @acl_info = args[:acl_info] if args.key?(:acl_info)
1634
+ @document_type = args[:document_type] if args.key?(:document_type)
1635
+ @file_extension = args[:file_extension] if args.key?(:file_extension)
1636
+ @last_content_modified_timestamp = args[:last_content_modified_timestamp] if args.key?(:last_content_modified_timestamp)
1637
+ @result_info = args[:result_info] if args.key?(:result_info)
1638
+ @type_info = args[:type_info] if args.key?(:type_info)
1639
+ end
1640
+ end
1641
+
1642
+ # A message containing information about a specific result. This information is
1643
+ # passed to the scorer and beyond; in particular, GWS relies on it to format the
1644
+ # result in the UI. Split from GoogleDocsMetadata in case we later want to reuse
1645
+ # the message.
1646
+ class GoogleDocsResultInfo
1647
+ include Google::Apis::Core::Hashable
1648
+
1649
+ # The SHA1 hash of the object in Drive, if any.
1650
+ # Corresponds to the JSON property `attachmentSha1`
1651
+ # @return [String]
1652
+ attr_accessor :attachment_sha1
1653
+
1654
+ # Identifies a particular object, including both Users and DirEntries. This Id
1655
+ # is unique across the entire server instance, such as the production or qa
1656
+ # instance.
1657
+ # Corresponds to the JSON property `cosmoId`
1658
+ # @return [Google::Apis::CloudsearchV1::Id]
1659
+ attr_accessor :cosmo_id
1660
+
1661
+ # For Cosmo objects, the Cosmo namespace the object was in. This allows
1662
+ # downstream clients to identify whether a document was created in Writely or
1663
+ # Kix, Presently or Punch, or whether it was uploaded from GDrive. See
1664
+ # storage_cosmo.Id.NAME_SPACE for a list of all Cosmo name spaces.
1665
+ # Corresponds to the JSON property `cosmoNameSpace`
1666
+ # @return [Fixnum]
1667
+ attr_accessor :cosmo_name_space
1668
+
1669
+ # The encrypted (user-visible) id of this object. Knowing the id is sufficient
1670
+ # to create a canonical URL for this document.
1671
+ # Corresponds to the JSON property `encryptedId`
1672
+ # @return [String]
1673
+ attr_accessor :encrypted_id
1674
+
1675
+ # The mimetype of the document.
1676
+ # Corresponds to the JSON property `mimeType`
1677
+ # @return [String]
1678
+ attr_accessor :mime_type
1679
+
1680
+ # The visibility indicator in the UI will be based upon this.
1681
+ # Corresponds to the JSON property `shareScope`
1682
+ # @return [Google::Apis::CloudsearchV1::ShareScope]
1683
+ attr_accessor :share_scope
1684
+
1685
+ def initialize(**args)
1686
+ update!(**args)
1687
+ end
1688
+
1689
+ # Update properties of this object
1690
+ def update!(**args)
1691
+ @attachment_sha1 = args[:attachment_sha1] if args.key?(:attachment_sha1)
1692
+ @cosmo_id = args[:cosmo_id] if args.key?(:cosmo_id)
1693
+ @cosmo_name_space = args[:cosmo_name_space] if args.key?(:cosmo_name_space)
1694
+ @encrypted_id = args[:encrypted_id] if args.key?(:encrypted_id)
1695
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
1696
+ @share_scope = args[:share_scope] if args.key?(:share_scope)
1697
+ end
1698
+ end
1699
+
1471
1700
  # Used to provide a search operator for html properties. This is optional.
1472
1701
  # Search operators let users restrict the query to specific fields relevant to
1473
1702
  # the type of item being searched.
@@ -1543,6 +1772,48 @@ module Google
1543
1772
  end
1544
1773
  end
1545
1774
 
1775
+ # Identifies a particular object, including both Users and DirEntries. This Id
1776
+ # is unique across the entire server instance, such as the production or qa
1777
+ # instance.
1778
+ class Id
1779
+ include Google::Apis::Core::Hashable
1780
+
1781
+ # The User account in which the DirEntry was originally created. If name_space==
1782
+ # GAIA, then it's the gaia_id of the user this id is referring to.
1783
+ # Corresponds to the JSON property `creatorUserId`
1784
+ # @return [Fixnum]
1785
+ attr_accessor :creator_user_id
1786
+
1787
+ # The local identifier for the DirEntry (local to the creator's account).
1788
+ # local_id + app_name is guaranteed to be unique within the creator account, but
1789
+ # not across all User accounts. The string is case sensitive. Ignore if
1790
+ # name_space==GAIA. NB For name_space==COSMO, all local_id's should be defined
1791
+ # in google3/java/com/google/storage/cosmo/server/api/SpecialObjectIds.java as
1792
+ # they have a special predefined meaning. See cosmo.client.CosmoIdFactory.
1793
+ # createObjectId(long,String) for IMPORTANT recommendations when generating IDs.
1794
+ # Corresponds to the JSON property `localId`
1795
+ # @return [String]
1796
+ attr_accessor :local_id
1797
+
1798
+ # The name space in which this id is unique (typically the application that
1799
+ # created it). Values should be drawn from the above enum, but for
1800
+ # experimentation, use values greater than 1000.
1801
+ # Corresponds to the JSON property `nameSpace`
1802
+ # @return [Fixnum]
1803
+ attr_accessor :name_space
1804
+
1805
+ def initialize(**args)
1806
+ update!(**args)
1807
+ end
1808
+
1809
+ # Update properties of this object
1810
+ def update!(**args)
1811
+ @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id)
1812
+ @local_id = args[:local_id] if args.key?(:local_id)
1813
+ @name_space = args[:name_space] if args.key?(:name_space)
1814
+ end
1815
+ end
1816
+
1546
1817
  #
1547
1818
  class IndexItemOptions
1548
1819
  include Google::Apis::Core::Hashable
@@ -1832,6 +2103,9 @@ module Google
1832
2103
  # Item using lexical ordering. Cloud Search Indexing won't index or delete any
1833
2104
  # queued item with a version value that is less than or equal to the version of
1834
2105
  # the currently indexed item. The maximum length for this field is 1024 bytes.
2106
+ # For information on how item version affects the deletion process, refer to [
2107
+ # Handle revisions after manual deletes](https://developers.google.com/cloud-
2108
+ # search/docs/guides/operations).
1835
2109
  # Corresponds to the JSON property `version`
1836
2110
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
1837
2111
  # @return [String]
@@ -1925,8 +2199,8 @@ module Google
1925
2199
  include Google::Apis::Core::Hashable
1926
2200
 
1927
2201
  # Represents an upload session reference. This reference is created via upload
1928
- # method. Updating of item content may refer to this uploaded content via
1929
- # contentDataRef.
2202
+ # method. This reference is valid for 30 days after its creation. Updating of
2203
+ # item content may refer to this uploaded content via contentDataRef.
1930
2204
  # Corresponds to the JSON property `contentDataRef`
1931
2205
  # @return [Google::Apis::CloudsearchV1::UploadItemRef]
1932
2206
  attr_accessor :content_data_ref
@@ -1972,6 +2246,13 @@ module Google
1972
2246
  # @return [Fixnum]
1973
2247
  attr_accessor :count
1974
2248
 
2249
+ # Number of items matching the status code for which billing is done. This
2250
+ # excludes virtual container items from the total count. This count would not be
2251
+ # applicable for items with ERROR or NEW_ITEM status code.
2252
+ # Corresponds to the JSON property `indexedItemsCount`
2253
+ # @return [Fixnum]
2254
+ attr_accessor :indexed_items_count
2255
+
1975
2256
  # Status of the items.
1976
2257
  # Corresponds to the JSON property `statusCode`
1977
2258
  # @return [String]
@@ -1984,6 +2265,7 @@ module Google
1984
2265
  # Update properties of this object
1985
2266
  def update!(**args)
1986
2267
  @count = args[:count] if args.key?(:count)
2268
+ @indexed_items_count = args[:indexed_items_count] if args.key?(:indexed_items_count)
1987
2269
  @status_code = args[:status_code] if args.key?(:status_code)
1988
2270
  end
1989
2271
  end
@@ -2059,8 +2341,8 @@ module Google
2059
2341
  # @return [Google::Apis::CloudsearchV1::SearchQualityMetadata]
2060
2342
  attr_accessor :search_quality_metadata
2061
2343
 
2062
- # Link to the source repository serving the data. Search results apply this link
2063
- # to the title. Whitespace or special characters may cause Cloud Search result
2344
+ # Link to the source repository serving the data. Seach results apply this link
2345
+ # to the title. Whitespace or special characters may cause Cloud Seach result
2064
2346
  # links to trigger a redirect notice; to avoid this, encode the URL. The maximum
2065
2347
  # length is 2048 characters.
2066
2348
  # Corresponds to the JSON property `sourceRepositoryUrl`
@@ -2420,6 +2702,11 @@ module Google
2420
2702
  # @return [Google::Apis::CloudsearchV1::Source]
2421
2703
  attr_accessor :source
2422
2704
 
2705
+ # The thumbnail URL of the result.
2706
+ # Corresponds to the JSON property `thumbnailUrl`
2707
+ # @return [String]
2708
+ attr_accessor :thumbnail_url
2709
+
2423
2710
  # The last modified date for the object in the search result. If not set in the
2424
2711
  # item, the value returned here is empty. When `updateTime` is used for
2425
2712
  # calculating freshness and is not set, this value defaults to 2 years from the
@@ -2441,6 +2728,7 @@ module Google
2441
2728
  @object_type = args[:object_type] if args.key?(:object_type)
2442
2729
  @owner = args[:owner] if args.key?(:owner)
2443
2730
  @source = args[:source] if args.key?(:source)
2731
+ @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
2444
2732
  @update_time = args[:update_time] if args.key?(:update_time)
2445
2733
  end
2446
2734
  end
@@ -3969,6 +4257,12 @@ module Google
3969
4257
  # @return [Google::Apis::CloudsearchV1::QueryInterpretationConfig]
3970
4258
  attr_accessor :query_interpretation_config
3971
4259
 
4260
+ # With each result we should return the URI for its thumbnail (when applicable)
4261
+ # Corresponds to the JSON property `returnResultThumbnailUrls`
4262
+ # @return [Boolean]
4263
+ attr_accessor :return_result_thumbnail_urls
4264
+ alias_method :return_result_thumbnail_urls?, :return_result_thumbnail_urls
4265
+
3972
4266
  # Scoring configurations for a source while processing a Search or Suggest
3973
4267
  # request.
3974
4268
  # Corresponds to the JSON property `scoringConfig`
@@ -3994,6 +4288,7 @@ module Google
3994
4288
  @name = args[:name] if args.key?(:name)
3995
4289
  @operation_ids = args[:operation_ids] if args.key?(:operation_ids)
3996
4290
  @query_interpretation_config = args[:query_interpretation_config] if args.key?(:query_interpretation_config)
4291
+ @return_result_thumbnail_urls = args[:return_result_thumbnail_urls] if args.key?(:return_result_thumbnail_urls)
3997
4292
  @scoring_config = args[:scoring_config] if args.key?(:scoring_config)
3998
4293
  @source_config = args[:source_config] if args.key?(:source_config)
3999
4294
  end
@@ -4384,6 +4679,32 @@ module Google
4384
4679
  end
4385
4680
  end
4386
4681
 
4682
+ #
4683
+ class ShareScope
4684
+ include Google::Apis::Core::Hashable
4685
+
4686
+ # If scope is DOMAIN, this field contains the dasher domain, for example "google.
4687
+ # com".
4688
+ # Corresponds to the JSON property `domain`
4689
+ # @return [String]
4690
+ attr_accessor :domain
4691
+
4692
+ # The scope to which the content was shared.
4693
+ # Corresponds to the JSON property `scope`
4694
+ # @return [String]
4695
+ attr_accessor :scope
4696
+
4697
+ def initialize(**args)
4698
+ update!(**args)
4699
+ end
4700
+
4701
+ # Update properties of this object
4702
+ def update!(**args)
4703
+ @domain = args[:domain] if args.key?(:domain)
4704
+ @scope = args[:scope] if args.key?(:scope)
4705
+ end
4706
+ end
4707
+
4387
4708
  # Snippet of the search result, which summarizes the content of the resulting
4388
4709
  # page.
4389
4710
  class Snippet
@@ -4983,6 +5304,25 @@ module Google
4983
5304
  end
4984
5305
  end
4985
5306
 
5307
+ # Next tag: 2
5308
+ class TypeInfo
5309
+ include Google::Apis::Core::Hashable
5310
+
5311
+ # Next tag: 2
5312
+ # Corresponds to the JSON property `videoInfo`
5313
+ # @return [Google::Apis::CloudsearchV1::VideoInfo]
5314
+ attr_accessor :video_info
5315
+
5316
+ def initialize(**args)
5317
+ update!(**args)
5318
+ end
5319
+
5320
+ # Update properties of this object
5321
+ def update!(**args)
5322
+ @video_info = args[:video_info] if args.key?(:video_info)
5323
+ end
5324
+ end
5325
+
4986
5326
  #
4987
5327
  class UnmappedIdentity
4988
5328
  include Google::Apis::Core::Hashable
@@ -5101,8 +5441,8 @@ module Google
5101
5441
  end
5102
5442
 
5103
5443
  # Represents an upload session reference. This reference is created via upload
5104
- # method. Updating of item content may refer to this uploaded content via
5105
- # contentDataRef.
5444
+ # method. This reference is valid for 30 days after its creation. Updating of
5445
+ # item content may refer to this uploaded content via contentDataRef.
5106
5446
  class UploadItemRef
5107
5447
  include Google::Apis::Core::Hashable
5108
5448
 
@@ -5227,6 +5567,26 @@ module Google
5227
5567
  @value = args[:value] if args.key?(:value)
5228
5568
  end
5229
5569
  end
5570
+
5571
+ # Next tag: 2
5572
+ class VideoInfo
5573
+ include Google::Apis::Core::Hashable
5574
+
5575
+ # Duration of the video in milliseconds. This field can be absent for recently
5576
+ # uploaded video or inaccurate sometimes.
5577
+ # Corresponds to the JSON property `duration`
5578
+ # @return [Fixnum]
5579
+ attr_accessor :duration
5580
+
5581
+ def initialize(**args)
5582
+ update!(**args)
5583
+ end
5584
+
5585
+ # Update properties of this object
5586
+ def update!(**args)
5587
+ @duration = args[:duration] if args.key?(:duration)
5588
+ end
5589
+ end
5230
5590
  end
5231
5591
  end
5232
5592
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CloudsearchV1
18
18
  # Version of the google-apis-cloudsearch_v1 gem
19
- GEM_VERSION = "0.15.0"
19
+ GEM_VERSION = "0.19.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211123"
25
+ REVISION = "20220201"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,12 @@ module Google
22
22
  module Apis
23
23
  module CloudsearchV1
24
24
 
25
+ class AclInfo
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
25
31
  class AuditLoggingSettings
26
32
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
33
 
@@ -70,6 +76,12 @@ module Google
70
76
  include Google::Apis::Core::JsonObjectSupport
71
77
  end
72
78
 
79
+ class CustomerSearchApplicationStats
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
73
85
  class CustomerSessionStats
74
86
  class Representation < Google::Apis::Core::JsonRepresentation; end
75
87
 
@@ -292,6 +304,12 @@ module Google
292
304
  include Google::Apis::Core::JsonObjectSupport
293
305
  end
294
306
 
307
+ class GetCustomerSearchApplicationStatsResponse
308
+ class Representation < Google::Apis::Core::JsonRepresentation; end
309
+
310
+ include Google::Apis::Core::JsonObjectSupport
311
+ end
312
+
295
313
  class GetCustomerSessionStatsResponse
296
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
297
315
 
@@ -328,6 +346,18 @@ module Google
328
346
  include Google::Apis::Core::JsonObjectSupport
329
347
  end
330
348
 
349
+ class GoogleDocsMetadata
350
+ class Representation < Google::Apis::Core::JsonRepresentation; end
351
+
352
+ include Google::Apis::Core::JsonObjectSupport
353
+ end
354
+
355
+ class GoogleDocsResultInfo
356
+ class Representation < Google::Apis::Core::JsonRepresentation; end
357
+
358
+ include Google::Apis::Core::JsonObjectSupport
359
+ end
360
+
331
361
  class HtmlOperatorOptions
332
362
  class Representation < Google::Apis::Core::JsonRepresentation; end
333
363
 
@@ -346,6 +376,12 @@ module Google
346
376
  include Google::Apis::Core::JsonObjectSupport
347
377
  end
348
378
 
379
+ class Id
380
+ class Representation < Google::Apis::Core::JsonRepresentation; end
381
+
382
+ include Google::Apis::Core::JsonObjectSupport
383
+ end
384
+
349
385
  class IndexItemOptions
350
386
  class Representation < Google::Apis::Core::JsonRepresentation; end
351
387
 
@@ -796,6 +832,12 @@ module Google
796
832
  include Google::Apis::Core::JsonObjectSupport
797
833
  end
798
834
 
835
+ class ShareScope
836
+ class Representation < Google::Apis::Core::JsonRepresentation; end
837
+
838
+ include Google::Apis::Core::JsonObjectSupport
839
+ end
840
+
799
841
  class Snippet
800
842
  class Representation < Google::Apis::Core::JsonRepresentation; end
801
843
 
@@ -922,6 +964,12 @@ module Google
922
964
  include Google::Apis::Core::JsonObjectSupport
923
965
  end
924
966
 
967
+ class TypeInfo
968
+ class Representation < Google::Apis::Core::JsonRepresentation; end
969
+
970
+ include Google::Apis::Core::JsonObjectSupport
971
+ end
972
+
925
973
  class UnmappedIdentity
926
974
  class Representation < Google::Apis::Core::JsonRepresentation; end
927
975
 
@@ -970,6 +1018,21 @@ module Google
970
1018
  include Google::Apis::Core::JsonObjectSupport
971
1019
  end
972
1020
 
1021
+ class VideoInfo
1022
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1023
+
1024
+ include Google::Apis::Core::JsonObjectSupport
1025
+ end
1026
+
1027
+ class AclInfo
1028
+ # @private
1029
+ class Representation < Google::Apis::Core::JsonRepresentation
1030
+ property :groups_count, as: 'groupsCount'
1031
+ property :scope, as: 'scope'
1032
+ property :users_count, as: 'usersCount'
1033
+ end
1034
+ end
1035
+
973
1036
  class AuditLoggingSettings
974
1037
  # @private
975
1038
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1039,6 +1102,15 @@ module Google
1039
1102
  end
1040
1103
  end
1041
1104
 
1105
+ class CustomerSearchApplicationStats
1106
+ # @private
1107
+ class Representation < Google::Apis::Core::JsonRepresentation
1108
+ property :count, :numeric_string => true, as: 'count'
1109
+ property :date, as: 'date', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation
1110
+
1111
+ end
1112
+ end
1113
+
1042
1114
  class CustomerSessionStats
1043
1115
  # @private
1044
1116
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1080,6 +1152,7 @@ module Google
1080
1152
 
1081
1153
  property :name, as: 'name'
1082
1154
  collection :operation_ids, as: 'operationIds'
1155
+ property :return_thumbnail_urls, as: 'returnThumbnailUrls'
1083
1156
  property :short_name, as: 'shortName'
1084
1157
  end
1085
1158
  end
@@ -1347,6 +1420,7 @@ module Google
1347
1420
  class GetCustomerIndexStatsResponse
1348
1421
  # @private
1349
1422
  class Representation < Google::Apis::Core::JsonRepresentation
1423
+ property :average_indexed_item_count, :numeric_string => true, as: 'averageIndexedItemCount'
1350
1424
  collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerIndexStats, decorator: Google::Apis::CloudsearchV1::CustomerIndexStats::Representation
1351
1425
 
1352
1426
  end
@@ -1357,6 +1431,16 @@ module Google
1357
1431
  class Representation < Google::Apis::Core::JsonRepresentation
1358
1432
  collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerQueryStats, decorator: Google::Apis::CloudsearchV1::CustomerQueryStats::Representation
1359
1433
 
1434
+ property :total_query_count, :numeric_string => true, as: 'totalQueryCount'
1435
+ end
1436
+ end
1437
+
1438
+ class GetCustomerSearchApplicationStatsResponse
1439
+ # @private
1440
+ class Representation < Google::Apis::Core::JsonRepresentation
1441
+ property :average_search_application_count, :numeric_string => true, as: 'averageSearchApplicationCount'
1442
+ collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerSearchApplicationStats, decorator: Google::Apis::CloudsearchV1::CustomerSearchApplicationStats::Representation
1443
+
1360
1444
  end
1361
1445
  end
1362
1446
 
@@ -1379,6 +1463,7 @@ module Google
1379
1463
  class GetDataSourceIndexStatsResponse
1380
1464
  # @private
1381
1465
  class Representation < Google::Apis::Core::JsonRepresentation
1466
+ property :average_indexed_item_count, :numeric_string => true, as: 'averageIndexedItemCount'
1382
1467
  collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::DataSourceIndexStats, decorator: Google::Apis::CloudsearchV1::DataSourceIndexStats::Representation
1383
1468
 
1384
1469
  end
@@ -1389,6 +1474,7 @@ module Google
1389
1474
  class Representation < Google::Apis::Core::JsonRepresentation
1390
1475
  collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::SearchApplicationQueryStats, decorator: Google::Apis::CloudsearchV1::SearchApplicationQueryStats::Representation
1391
1476
 
1477
+ property :total_query_count, :numeric_string => true, as: 'totalQueryCount'
1392
1478
  end
1393
1479
  end
1394
1480
 
@@ -1408,6 +1494,35 @@ module Google
1408
1494
  end
1409
1495
  end
1410
1496
 
1497
+ class GoogleDocsMetadata
1498
+ # @private
1499
+ class Representation < Google::Apis::Core::JsonRepresentation
1500
+ property :acl_info, as: 'aclInfo', class: Google::Apis::CloudsearchV1::AclInfo, decorator: Google::Apis::CloudsearchV1::AclInfo::Representation
1501
+
1502
+ property :document_type, as: 'documentType'
1503
+ property :file_extension, as: 'fileExtension'
1504
+ property :last_content_modified_timestamp, :numeric_string => true, as: 'lastContentModifiedTimestamp'
1505
+ property :result_info, as: 'resultInfo', class: Google::Apis::CloudsearchV1::GoogleDocsResultInfo, decorator: Google::Apis::CloudsearchV1::GoogleDocsResultInfo::Representation
1506
+
1507
+ property :type_info, as: 'typeInfo', class: Google::Apis::CloudsearchV1::TypeInfo, decorator: Google::Apis::CloudsearchV1::TypeInfo::Representation
1508
+
1509
+ end
1510
+ end
1511
+
1512
+ class GoogleDocsResultInfo
1513
+ # @private
1514
+ class Representation < Google::Apis::Core::JsonRepresentation
1515
+ property :attachment_sha1, as: 'attachmentSha1'
1516
+ property :cosmo_id, as: 'cosmoId', class: Google::Apis::CloudsearchV1::Id, decorator: Google::Apis::CloudsearchV1::Id::Representation
1517
+
1518
+ property :cosmo_name_space, as: 'cosmoNameSpace'
1519
+ property :encrypted_id, as: 'encryptedId'
1520
+ property :mime_type, as: 'mimeType'
1521
+ property :share_scope, as: 'shareScope', class: Google::Apis::CloudsearchV1::ShareScope, decorator: Google::Apis::CloudsearchV1::ShareScope::Representation
1522
+
1523
+ end
1524
+ end
1525
+
1411
1526
  class HtmlOperatorOptions
1412
1527
  # @private
1413
1528
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1432,6 +1547,15 @@ module Google
1432
1547
  end
1433
1548
  end
1434
1549
 
1550
+ class Id
1551
+ # @private
1552
+ class Representation < Google::Apis::Core::JsonRepresentation
1553
+ property :creator_user_id, :numeric_string => true, as: 'creatorUserId'
1554
+ property :local_id, as: 'localId'
1555
+ property :name_space, as: 'nameSpace'
1556
+ end
1557
+ end
1558
+
1435
1559
  class IndexItemOptions
1436
1560
  # @private
1437
1561
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1546,6 +1670,7 @@ module Google
1546
1670
  # @private
1547
1671
  class Representation < Google::Apis::Core::JsonRepresentation
1548
1672
  property :count, :numeric_string => true, as: 'count'
1673
+ property :indexed_items_count, :numeric_string => true, as: 'indexedItemsCount'
1549
1674
  property :status_code, as: 'statusCode'
1550
1675
  end
1551
1676
  end
@@ -1683,6 +1808,7 @@ module Google
1683
1808
 
1684
1809
  property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation
1685
1810
 
1811
+ property :thumbnail_url, as: 'thumbnailUrl'
1686
1812
  property :update_time, as: 'updateTime'
1687
1813
  end
1688
1814
  end
@@ -2126,6 +2252,7 @@ module Google
2126
2252
  collection :operation_ids, as: 'operationIds'
2127
2253
  property :query_interpretation_config, as: 'queryInterpretationConfig', class: Google::Apis::CloudsearchV1::QueryInterpretationConfig, decorator: Google::Apis::CloudsearchV1::QueryInterpretationConfig::Representation
2128
2254
 
2255
+ property :return_result_thumbnail_urls, as: 'returnResultThumbnailUrls'
2129
2256
  property :scoring_config, as: 'scoringConfig', class: Google::Apis::CloudsearchV1::ScoringConfig, decorator: Google::Apis::CloudsearchV1::ScoringConfig::Representation
2130
2257
 
2131
2258
  collection :source_config, as: 'sourceConfig', class: Google::Apis::CloudsearchV1::SourceConfig, decorator: Google::Apis::CloudsearchV1::SourceConfig::Representation
@@ -2251,6 +2378,14 @@ module Google
2251
2378
  end
2252
2379
  end
2253
2380
 
2381
+ class ShareScope
2382
+ # @private
2383
+ class Representation < Google::Apis::Core::JsonRepresentation
2384
+ property :domain, as: 'domain'
2385
+ property :scope, as: 'scope'
2386
+ end
2387
+ end
2388
+
2254
2389
  class Snippet
2255
2390
  # @private
2256
2391
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2436,6 +2571,14 @@ module Google
2436
2571
  end
2437
2572
  end
2438
2573
 
2574
+ class TypeInfo
2575
+ # @private
2576
+ class Representation < Google::Apis::Core::JsonRepresentation
2577
+ property :video_info, as: 'videoInfo', class: Google::Apis::CloudsearchV1::VideoInfo, decorator: Google::Apis::CloudsearchV1::VideoInfo::Representation
2578
+
2579
+ end
2580
+ end
2581
+
2439
2582
  class UnmappedIdentity
2440
2583
  # @private
2441
2584
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2511,6 +2654,13 @@ module Google
2511
2654
 
2512
2655
  end
2513
2656
  end
2657
+
2658
+ class VideoInfo
2659
+ # @private
2660
+ class Representation < Google::Apis::Core::JsonRepresentation
2661
+ property :duration, as: 'duration'
2662
+ end
2663
+ end
2514
2664
  end
2515
2665
  end
2516
2666
  end
@@ -382,7 +382,10 @@ module Google
382
382
  # compares the Item version in the index to the version of the queued Item using
383
383
  # lexical ordering. Cloud Search Indexing won't delete any queued item with a
384
384
  # version value that is less than or equal to the version of the currently
385
- # indexed item. The maximum length for this field is 1024 bytes.
385
+ # indexed item. The maximum length for this field is 1024 bytes. For information
386
+ # on how item version affects the deletion process, refer to [Handle revisions
387
+ # after manual deletes](https://developers.google.com/cloud-search/docs/guides/
388
+ # operations).
386
389
  # @param [String] fields
387
390
  # Selector specifying which fields to include in a partial response.
388
391
  # @param [String] quota_user
@@ -1537,6 +1540,52 @@ module Google
1537
1540
  execute_or_queue_command(command, &block)
1538
1541
  end
1539
1542
 
1543
+ # Get search application stats for customer. **Note:** This API requires a
1544
+ # standard end user account to execute.
1545
+ # @param [Fixnum] end_date_day
1546
+ # Day of month. Must be from 1 to 31 and valid for the year and month.
1547
+ # @param [Fixnum] end_date_month
1548
+ # Month of date. Must be from 1 to 12.
1549
+ # @param [Fixnum] end_date_year
1550
+ # Year of date. Must be from 1 to 9999.
1551
+ # @param [Fixnum] start_date_day
1552
+ # Day of month. Must be from 1 to 31 and valid for the year and month.
1553
+ # @param [Fixnum] start_date_month
1554
+ # Month of date. Must be from 1 to 12.
1555
+ # @param [Fixnum] start_date_year
1556
+ # Year of date. Must be from 1 to 9999.
1557
+ # @param [String] fields
1558
+ # Selector specifying which fields to include in a partial response.
1559
+ # @param [String] quota_user
1560
+ # Available to use for quota purposes for server-side applications. Can be any
1561
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1562
+ # @param [Google::Apis::RequestOptions] options
1563
+ # Request-specific options
1564
+ #
1565
+ # @yield [result, err] Result & error if block supplied
1566
+ # @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse] parsed result object
1567
+ # @yieldparam err [StandardError] error object if request failed
1568
+ #
1569
+ # @return [Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse]
1570
+ #
1571
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1572
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1573
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1574
+ def get_stat_searchapplication(end_date_day: nil, end_date_month: nil, end_date_year: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
1575
+ command = make_simple_command(:get, 'v1/stats/searchapplication', options)
1576
+ command.response_representation = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse::Representation
1577
+ command.response_class = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse
1578
+ command.query['endDate.day'] = end_date_day unless end_date_day.nil?
1579
+ command.query['endDate.month'] = end_date_month unless end_date_month.nil?
1580
+ command.query['endDate.year'] = end_date_year unless end_date_year.nil?
1581
+ command.query['startDate.day'] = start_date_day unless start_date_day.nil?
1582
+ command.query['startDate.month'] = start_date_month unless start_date_month.nil?
1583
+ command.query['startDate.year'] = start_date_year unless start_date_year.nil?
1584
+ command.query['fields'] = fields unless fields.nil?
1585
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1586
+ execute_or_queue_command(command, &block)
1587
+ end
1588
+
1540
1589
  # Get the # of search sessions, % of successful sessions with a click query
1541
1590
  # statistics for customer. **Note:** This API requires a standard end user
1542
1591
  # account to execute.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudsearch_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.15.0
4
+ version: 0.19.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-12-06 00:00:00.000000000 Z
11
+ date: 2022-02-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsearch_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsearch_v1/v0.15.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsearch_v1/v0.19.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsearch_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.2.17
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Search API V1