google-apis-vault_v1 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5d8b107f8a9d22c0628711f123382143445f630d8b7ca849807539e776ac229f
4
- data.tar.gz: 7436247180dc999fed4846fbeeb7d6a83b11ed7a4a054981567be85ded56fe64
3
+ metadata.gz: 0b6c1f44933600aea8cda9d84c41ec9a913fc2e95751822b22ca7bface184013
4
+ data.tar.gz: 565ac1c6352b0addafb7e2d043d879bd4beb83a7ede93421cf60c2fc4efac0a5
5
5
  SHA512:
6
- metadata.gz: d0955ced4848982edfc977b2e36bb1d2a69e6b83bfa7af93236d123208e045b79721afc129e493d1b35707ec3c50858a5450f48a8477d71c1f147afdaca118e5
7
- data.tar.gz: 31f17006bc2d5a15e5b3636271da6afefc8b522e4f557d2c21fc4f39fd340ed5bd7442720d633cd600e27af7819ae32517b1c1eef857c56f969bba7bf67595d1
6
+ metadata.gz: 245ae0866abd694beacddf35198043a533aa03224689cf0bbed36714b5f93dd600324128b9dbeebdbb9099b22959f35ffad5f04641491381fb49434329c8ffcc
7
+ data.tar.gz: 67cb0856ea9109bfc4fc94902cb71f3a2e1112766f854d861992f5e86a45f2466600529b207bcf9bb41e4ef35cfc75977a6fe30268efc0fc239624cb3e69e28a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-vault_v1
2
2
 
3
+ ### v0.5.0 (2021-06-25)
4
+
5
+ * Regenerated from discovery document revision 20210621
6
+ * Regenerated using generator version 0.3.0
7
+
3
8
  ### v0.4.0 (2021-05-20)
4
9
 
5
10
  * Unspecified changes
@@ -22,7 +22,7 @@ module Google
22
22
  # G Suite Vault API
23
23
  #
24
24
  # Retention and eDiscovery for Google Workspace. To work with Vault resources,
25
- # the account must have the [required Vault privileges] (https://support.google.
25
+ # the account must have the [required Vault privileges](https://support.google.
26
26
  # com/vault/answer/2799699) and access to the matter. To access a matter, the
27
27
  # account must have created the matter, have the matter shared with them, or
28
28
  # have the **View All Matters** privilege. For example, to download an export,
@@ -22,7 +22,7 @@ module Google
22
22
  module Apis
23
23
  module VaultV1
24
24
 
25
- # Count number for each account.
25
+ # The results count for each account.
26
26
  class AccountCount
27
27
  include Google::Apis::Core::Hashable
28
28
 
@@ -31,7 +31,7 @@ module Google
31
31
  # @return [Google::Apis::VaultV1::UserInfo]
32
32
  attr_accessor :account
33
33
 
34
- # The number of artifacts found for this account.
34
+ # The number of results (messages or files) found for this account.
35
35
  # Corresponds to the JSON property `count`
36
36
  # @return [Fixnum]
37
37
  attr_accessor :count
@@ -72,7 +72,7 @@ module Google
72
72
  end
73
73
  end
74
74
 
75
- # Accounts to search
75
+ # The accounts to search
76
76
  class AccountInfo
77
77
  include Google::Apis::Core::Hashable
78
78
 
@@ -91,17 +91,16 @@ module Google
91
91
  end
92
92
  end
93
93
 
94
- # A status detailing the status of each account creation, and the HeldAccount,
95
- # if successful.
94
+ # The status of each account creation, and the **HeldAccount**, if successful.
96
95
  class AddHeldAccountResult
97
96
  include Google::Apis::Core::Hashable
98
97
 
99
- # An account being held in a particular hold. This structure is immutable. This
100
- # can be either a single user or a google group, depending on the corpus. To
101
- # work with Vault resources, the account must have the [required Vault
102
- # privileges] (https://support.google.com/vault/answer/2799699) and access to
103
- # the matter. To access a matter, the account must have created the matter, have
104
- # the matter shared with them, or have the **View All Matters** privilege.
98
+ # An account covered by a hold. This structure is immutable. It can be an
99
+ # individual account or a Google Group, depending on the service. To work with
100
+ # Vault resources, the account must have the [required Vault privileges] (https:/
101
+ # /support.google.com/vault/answer/2799699) and access to the matter. To access
102
+ # a matter, the account must have created the matter, have the matter shared
103
+ # with them, or have the **View All Matters** privilege.
105
104
  # Corresponds to the JSON property `account`
106
105
  # @return [Google::Apis::VaultV1::HeldAccount]
107
106
  attr_accessor :account
@@ -131,14 +130,14 @@ module Google
131
130
  class AddHeldAccountsRequest
132
131
  include Google::Apis::Core::Hashable
133
132
 
134
- # Account IDs to identify which accounts to add. Only account_ids or only emails
135
- # should be specified, but not both.
133
+ # A comma-separated list of the account IDs of the accounts to add to the hold.
134
+ # Specify either **emails** or **account_ids**, but not both.
136
135
  # Corresponds to the JSON property `accountIds`
137
136
  # @return [Array<String>]
138
137
  attr_accessor :account_ids
139
138
 
140
- # Emails to identify which accounts to add. Only emails or only account_ids
141
- # should be specified, but not both.
139
+ # A comma-separated list of the emails of the accounts to add to the hold.
140
+ # Specify either **emails** or **account_ids**, but not both.
142
141
  # Corresponds to the JSON property `emails`
143
142
  # @return [Array<String>]
144
143
  attr_accessor :emails
@@ -174,26 +173,26 @@ module Google
174
173
  end
175
174
 
176
175
  # Add an account with the permission specified. The role cannot be owner. If an
177
- # account already has a role in the matter, it will be overwritten.
176
+ # account already has a role in the matter, the existing role is overwritten.
178
177
  class AddMatterPermissionsRequest
179
178
  include Google::Apis::Core::Hashable
180
179
 
181
- # Only relevant if send_emails is true. True to CC requestor in the email
182
- # message. False to not CC requestor.
180
+ # Only relevant if **sendEmails** is **true**. To CC the requestor in the email
181
+ # message, set to **true**. To not CC requestor, set to **false**.
183
182
  # Corresponds to the JSON property `ccMe`
184
183
  # @return [Boolean]
185
184
  attr_accessor :cc_me
186
185
  alias_method :cc_me?, :cc_me
187
186
 
188
- # Currently each matter only has one owner, and all others are collaborators.
189
- # When an account is purged, its corresponding MatterPermission resources cease
190
- # to exist.
187
+ # Users can be matter owners or collaborators. Each matter has only one owner.
188
+ # All others users who can access the matter are collaborators. When an account
189
+ # is purged, its corresponding MatterPermission resources cease to exist.
191
190
  # Corresponds to the JSON property `matterPermission`
192
191
  # @return [Google::Apis::VaultV1::MatterPermission]
193
192
  attr_accessor :matter_permission
194
193
 
195
- # True to send notification email to the added account. False to not send
196
- # notification email.
194
+ # To send a notification email to the added account, set to **true**. To not
195
+ # send a notification email, set to **false**.
197
196
  # Corresponds to the JSON property `sendEmails`
198
197
  # @return [Boolean]
199
198
  attr_accessor :send_emails
@@ -260,13 +259,15 @@ module Google
260
259
  end
261
260
  end
262
261
 
263
- # An export file on cloud storage
262
+ # The export file in Cloud Storage
264
263
  class CloudStorageFile
265
264
  include Google::Apis::Core::Hashable
266
265
 
267
- # The cloud storage bucket name of this export file. Can be used in cloud
268
- # storage JSON/XML API, but not to list the bucket contents. Instead, you can
269
- # get individual export files by object name.
266
+ # The name of the Cloud Storage bucket for the export file. You can use this
267
+ # value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/
268
+ # docs/apis), but not to list the bucket contents. Instead, you can [get
269
+ # individual export files](https://cloud.google.com/storage/docs/json_api/v1/
270
+ # objects/get) by object name.
270
271
  # Corresponds to the JSON property `bucketName`
271
272
  # @return [String]
272
273
  attr_accessor :bucket_name
@@ -276,13 +277,14 @@ module Google
276
277
  # @return [String]
277
278
  attr_accessor :md5_hash
278
279
 
279
- # The cloud storage object name of this export file. Can be used in cloud
280
- # storage JSON/XML API.
280
+ # The name of the Cloud Storage object for the export file. You can use this
281
+ # value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/
282
+ # docs/apis).
281
283
  # Corresponds to the JSON property `objectName`
282
284
  # @return [String]
283
285
  attr_accessor :object_name
284
286
 
285
- # The size of the export file.
287
+ # The export file size.
286
288
  # Corresponds to the JSON property `size`
287
289
  # @return [Fixnum]
288
290
  attr_accessor :size
@@ -300,11 +302,11 @@ module Google
300
302
  end
301
303
  end
302
304
 
303
- # Export sink for cloud storage files.
305
+ # Export sink for Cloud Storage files.
304
306
  class CloudStorageSink
305
307
  include Google::Apis::Core::Hashable
306
308
 
307
- # Output only. The exported files on cloud storage.
309
+ # Output only. The exported files in Cloud Storage.
308
310
  # Corresponds to the JSON property `files`
309
311
  # @return [Array<Google::Apis::VaultV1::CloudStorageFile>]
310
312
  attr_accessor :files
@@ -319,11 +321,11 @@ module Google
319
321
  end
320
322
  end
321
323
 
322
- # Corpus specific queries.
324
+ # Service-specific options for holds.
323
325
  class CorpusQuery
324
326
  include Google::Apis::Core::Hashable
325
327
 
326
- # Query options for Drive holds.
328
+ # Options for Drive holds.
327
329
  # Corresponds to the JSON property `driveQuery`
328
330
  # @return [Google::Apis::VaultV1::HeldDriveQuery]
329
331
  attr_accessor :drive_query
@@ -333,17 +335,17 @@ module Google
333
335
  # @return [Google::Apis::VaultV1::HeldGroupsQuery]
334
336
  attr_accessor :groups_query
335
337
 
336
- # Query options for hangouts chat holds.
338
+ # Options for Chat holds.
337
339
  # Corresponds to the JSON property `hangoutsChatQuery`
338
340
  # @return [Google::Apis::VaultV1::HeldHangoutsChatQuery]
339
341
  attr_accessor :hangouts_chat_query
340
342
 
341
- # Query options for mail holds.
343
+ # Query options for Gmail holds.
342
344
  # Corresponds to the JSON property `mailQuery`
343
345
  # @return [Google::Apis::VaultV1::HeldMailQuery]
344
346
  attr_accessor :mail_query
345
347
 
346
- # Query options for Voice holds.
348
+ # Options for Voice holds.
347
349
  # Corresponds to the JSON property `voiceQuery`
348
350
  # @return [Google::Apis::VaultV1::HeldVoiceQuery]
349
351
  attr_accessor :voice_query
@@ -376,7 +378,7 @@ module Google
376
378
  # @return [String]
377
379
  attr_accessor :matter_id
378
380
 
379
- # A query definition relevant for search & export.
381
+ # The query definition used for search and export.
380
382
  # Corresponds to the JSON property `query`
381
383
  # @return [Google::Apis::VaultV1::Query]
382
384
  attr_accessor :query
@@ -403,12 +405,12 @@ module Google
403
405
  class CountArtifactsRequest
404
406
  include Google::Apis::Core::Hashable
405
407
 
406
- # A query definition relevant for search & export.
408
+ # The query definition used for search and export.
407
409
  # Corresponds to the JSON property `query`
408
410
  # @return [Google::Apis::VaultV1::Query]
409
411
  attr_accessor :query
410
412
 
411
- # Specifies the granularity of the count result returned in response.
413
+ # Sets the granularity of the count results.
412
414
  # Corresponds to the JSON property `view`
413
415
  # @return [String]
414
416
  attr_accessor :view
@@ -433,12 +435,12 @@ module Google
433
435
  # @return [Google::Apis::VaultV1::GroupsCountResult]
434
436
  attr_accessor :groups_count_result
435
437
 
436
- # Mail specific count metrics.
438
+ # Gmail and classic Hangouts-specific count metrics.
437
439
  # Corresponds to the JSON property `mailCountResult`
438
440
  # @return [Google::Apis::VaultV1::MailCountResult]
439
441
  attr_accessor :mail_count_result
440
442
 
441
- # Total count of artifacts. For mail and groups, artifacts refers to messages.
443
+ # Total count of messages.
442
444
  # Corresponds to the JSON property `totalCount`
443
445
  # @return [Fixnum]
444
446
  attr_accessor :total_count
@@ -455,12 +457,12 @@ module Google
455
457
  end
456
458
  end
457
459
 
458
- # The options for Drive export.
460
+ # Options for Drive exports.
459
461
  class DriveExportOptions
460
462
  include Google::Apis::Core::Hashable
461
463
 
462
- # Set to true to include access level information for users with indirect access
463
- # to files.
464
+ # To include access level information for users with [indirect access](https://
465
+ # support.google.com/vault/answer/6099459#metadata) to files, set to **true**.
464
466
  # Corresponds to the JSON property `includeAccessInfo`
465
467
  # @return [Boolean]
466
468
  attr_accessor :include_access_info
@@ -476,11 +478,11 @@ module Google
476
478
  end
477
479
  end
478
480
 
479
- # Drive search advanced options
481
+ # Additional options for Drive search
480
482
  class DriveOptions
481
483
  include Google::Apis::Core::Hashable
482
484
 
483
- # Set to true to include shared drive.
485
+ # Set to **true** to include shared drives.
484
486
  # Corresponds to the JSON property `includeSharedDrives`
485
487
  # @return [Boolean]
486
488
  attr_accessor :include_shared_drives
@@ -492,8 +494,9 @@ module Google
492
494
  attr_accessor :include_team_drives
493
495
  alias_method :include_team_drives?, :include_team_drives
494
496
 
495
- # Search the versions of the Drive file as of the reference date. These
496
- # timestamps are in GMT and rounded down to the given date.
497
+ # Search the current version of the Drive file, but export the contents of the
498
+ # last version saved before 12:00 AM UTC on the specified date. Enter the date
499
+ # in UTC.
497
500
  # Corresponds to the JSON property `versionDate`
498
501
  # @return [String]
499
502
  attr_accessor :version_date
@@ -527,14 +530,14 @@ module Google
527
530
  end
528
531
  end
529
532
 
530
- # An export To work with Vault resources, the account must have the [required
531
- # Vault privileges] (https://support.google.com/vault/answer/2799699) and access
533
+ # An export. To work with Vault resources, the account must have the [required
534
+ # Vault privileges](https://support.google.com/vault/answer/2799699) and access
532
535
  # to the matter. To access a matter, the account must have created the matter,
533
536
  # have the matter shared with them, or have the **View All Matters** privilege.
534
537
  class Export
535
538
  include Google::Apis::Core::Hashable
536
539
 
537
- # Export sink for cloud storage files.
540
+ # Export sink for Cloud Storage files.
538
541
  # Corresponds to the JSON property `cloudStorageSink`
539
542
  # @return [Google::Apis::VaultV1::CloudStorageSink]
540
543
  attr_accessor :cloud_storage_sink
@@ -544,7 +547,7 @@ module Google
544
547
  # @return [String]
545
548
  attr_accessor :create_time
546
549
 
547
- # Export advanced options
550
+ # Additional options for exports
548
551
  # Corresponds to the JSON property `exportOptions`
549
552
  # @return [Google::Apis::VaultV1::ExportOptions]
550
553
  attr_accessor :export_options
@@ -564,7 +567,7 @@ module Google
564
567
  # @return [String]
565
568
  attr_accessor :name
566
569
 
567
- # A query definition relevant for search & export.
570
+ # The query definition used for search and export.
568
571
  # Corresponds to the JSON property `query`
569
572
  # @return [Google::Apis::VaultV1::Query]
570
573
  attr_accessor :query
@@ -574,12 +577,12 @@ module Google
574
577
  # @return [Google::Apis::VaultV1::UserInfo]
575
578
  attr_accessor :requester
576
579
 
577
- # Stats of an export.
580
+ # Progress information for an export.
578
581
  # Corresponds to the JSON property `stats`
579
582
  # @return [Google::Apis::VaultV1::ExportStats]
580
583
  attr_accessor :stats
581
584
 
582
- # Output only. The export status.
585
+ # Output only. The status of the export.
583
586
  # Corresponds to the JSON property `status`
584
587
  # @return [String]
585
588
  attr_accessor :status
@@ -603,36 +606,36 @@ module Google
603
606
  end
604
607
  end
605
608
 
606
- # Export advanced options
609
+ # Additional options for exports
607
610
  class ExportOptions
608
611
  include Google::Apis::Core::Hashable
609
612
 
610
- # The options for Drive export.
613
+ # Options for Drive exports.
611
614
  # Corresponds to the JSON property `driveOptions`
612
615
  # @return [Google::Apis::VaultV1::DriveExportOptions]
613
616
  attr_accessor :drive_options
614
617
 
615
- # The options for groups export.
618
+ # Options for Groups exports.
616
619
  # Corresponds to the JSON property `groupsOptions`
617
620
  # @return [Google::Apis::VaultV1::GroupsExportOptions]
618
621
  attr_accessor :groups_options
619
622
 
620
- # The options for hangouts chat export.
623
+ # Options for Chat exports.
621
624
  # Corresponds to the JSON property `hangoutsChatOptions`
622
625
  # @return [Google::Apis::VaultV1::HangoutsChatExportOptions]
623
626
  attr_accessor :hangouts_chat_options
624
627
 
625
- # The options for mail export.
628
+ # Options for Gmail exports.
626
629
  # Corresponds to the JSON property `mailOptions`
627
630
  # @return [Google::Apis::VaultV1::MailExportOptions]
628
631
  attr_accessor :mail_options
629
632
 
630
- # The requested export location.
633
+ # The requested data region for the export.
631
634
  # Corresponds to the JSON property `region`
632
635
  # @return [String]
633
636
  attr_accessor :region
634
637
 
635
- # The options for voice export.
638
+ # The options for Voice exports.
636
639
  # Corresponds to the JSON property `voiceOptions`
637
640
  # @return [Google::Apis::VaultV1::VoiceExportOptions]
638
641
  attr_accessor :voice_options
@@ -652,11 +655,11 @@ module Google
652
655
  end
653
656
  end
654
657
 
655
- # Stats of an export.
658
+ # Progress information for an export.
656
659
  class ExportStats
657
660
  include Google::Apis::Core::Hashable
658
661
 
659
- # The number of documents already processed by the export.
662
+ # The number of messages or files already processed for export.
660
663
  # Corresponds to the JSON property `exportedArtifactCount`
661
664
  # @return [Fixnum]
662
665
  attr_accessor :exported_artifact_count
@@ -666,7 +669,7 @@ module Google
666
669
  # @return [Fixnum]
667
670
  attr_accessor :size_in_bytes
668
671
 
669
- # The number of documents to be exported.
672
+ # The number of messages or files to be exported.
670
673
  # Corresponds to the JSON property `totalArtifactCount`
671
674
  # @return [Fixnum]
672
675
  attr_accessor :total_artifact_count
@@ -702,9 +705,9 @@ module Google
702
705
  # @return [Fixnum]
703
706
  attr_accessor :matching_accounts_count
704
707
 
705
- # When data scope is HELD_DATA in the request Query, these accounts in the
706
- # request are not queried because they are not on hold. For other data scope,
707
- # this field is not set.
708
+ # When **DataScope** is **HELD_DATA**, these accounts in the request are not
709
+ # queried because they are not on hold. For other data scope, this field is not
710
+ # set.
708
711
  # Corresponds to the JSON property `nonQueryableAccounts`
709
712
  # @return [Array<String>]
710
713
  attr_accessor :non_queryable_accounts
@@ -728,11 +731,11 @@ module Google
728
731
  end
729
732
  end
730
733
 
731
- # The options for groups export.
734
+ # Options for Groups exports.
732
735
  class GroupsExportOptions
733
736
  include Google::Apis::Core::Hashable
734
737
 
735
- # The export format for groups export.
738
+ # The file format for exported messages.
736
739
  # Corresponds to the JSON property `exportFormat`
737
740
  # @return [String]
738
741
  attr_accessor :export_format
@@ -747,11 +750,11 @@ module Google
747
750
  end
748
751
  end
749
752
 
750
- # The options for hangouts chat export.
753
+ # Options for Chat exports.
751
754
  class HangoutsChatExportOptions
752
755
  include Google::Apis::Core::Hashable
753
756
 
754
- # The export format for hangouts chat export.
757
+ # The file format for exported messages.
755
758
  # Corresponds to the JSON property `exportFormat`
756
759
  # @return [String]
757
760
  attr_accessor :export_format
@@ -766,11 +769,12 @@ module Google
766
769
  end
767
770
  end
768
771
 
769
- # Accounts to search
772
+ # The Chat spaces to search
770
773
  class HangoutsChatInfo
771
774
  include Google::Apis::Core::Hashable
772
775
 
773
- # A set of rooms to search.
776
+ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.
777
+ # google.com/hangouts/chat).
774
778
  # Corresponds to the JSON property `roomId`
775
779
  # @return [Array<String>]
776
780
  attr_accessor :room_id
@@ -785,11 +789,12 @@ module Google
785
789
  end
786
790
  end
787
791
 
788
- # Hangouts chat search advanced options
792
+ # Additional options for Google Chat search
789
793
  class HangoutsChatOptions
790
794
  include Google::Apis::Core::Hashable
791
795
 
792
- # Set to true to include rooms.
796
+ # For searches by account or organizational unit, set to **true** to include
797
+ # rooms.
793
798
  # Corresponds to the JSON property `includeRooms`
794
799
  # @return [Boolean]
795
800
  attr_accessor :include_rooms
@@ -805,22 +810,23 @@ module Google
805
810
  end
806
811
  end
807
812
 
808
- # An account being held in a particular hold. This structure is immutable. This
809
- # can be either a single user or a google group, depending on the corpus. To
810
- # work with Vault resources, the account must have the [required Vault
811
- # privileges] (https://support.google.com/vault/answer/2799699) and access to
812
- # the matter. To access a matter, the account must have created the matter, have
813
- # the matter shared with them, or have the **View All Matters** privilege.
813
+ # An account covered by a hold. This structure is immutable. It can be an
814
+ # individual account or a Google Group, depending on the service. To work with
815
+ # Vault resources, the account must have the [required Vault privileges] (https:/
816
+ # /support.google.com/vault/answer/2799699) and access to the matter. To access
817
+ # a matter, the account must have created the matter, have the matter shared
818
+ # with them, or have the **View All Matters** privilege.
814
819
  class HeldAccount
815
820
  include Google::Apis::Core::Hashable
816
821
 
817
- # The account's ID as provided by the Admin SDK.
822
+ # The account ID, as provided by the [Admin SDK](https://developers.google.com/
823
+ # admin-sdk/).
818
824
  # Corresponds to the JSON property `accountId`
819
825
  # @return [String]
820
826
  attr_accessor :account_id
821
827
 
822
828
  # The primary email address of the account. If used as an input, this takes
823
- # precedence over account ID.
829
+ # precedence over **accountId**.
824
830
  # Corresponds to the JSON property `email`
825
831
  # @return [String]
826
832
  attr_accessor :email
@@ -854,17 +860,17 @@ module Google
854
860
  end
855
861
  end
856
862
 
857
- # Query options for Drive holds.
863
+ # Options for Drive holds.
858
864
  class HeldDriveQuery
859
865
  include Google::Apis::Core::Hashable
860
866
 
861
- # If true, include files in shared drives in the hold.
867
+ # To include files in shared drives in the hold, set to **true**.
862
868
  # Corresponds to the JSON property `includeSharedDriveFiles`
863
869
  # @return [Boolean]
864
870
  attr_accessor :include_shared_drive_files
865
871
  alias_method :include_shared_drive_files?, :include_shared_drive_files
866
872
 
867
- # If true, include files in Team Drives in the hold.
873
+ # To include files in Team Drives in the hold, set to **true**.
868
874
  # Corresponds to the JSON property `includeTeamDriveFiles`
869
875
  # @return [Boolean]
870
876
  attr_accessor :include_team_drive_files
@@ -885,19 +891,20 @@ module Google
885
891
  class HeldGroupsQuery
886
892
  include Google::Apis::Core::Hashable
887
893
 
888
- # The end time range for the search query. These timestamps are in GMT and
889
- # rounded down to the start of the given date.
894
+ # The end time for the query. Specify in GMT. The value is rounded to 12 AM on
895
+ # the specified date.
890
896
  # Corresponds to the JSON property `endTime`
891
897
  # @return [String]
892
898
  attr_accessor :end_time
893
899
 
894
- # The start time range for the search query. These timestamps are in GMT and
895
- # rounded down to the start of the given date.
900
+ # The start time for the query. Specify in GMT. The value is rounded to 12 AM on
901
+ # the specified date.
896
902
  # Corresponds to the JSON property `startTime`
897
903
  # @return [String]
898
904
  attr_accessor :start_time
899
905
 
900
- # The search terms for the hold.
906
+ # The [search operators](https://support.google.com/vault/answer/2474474) used
907
+ # to refine the messages covered by the hold.
901
908
  # Corresponds to the JSON property `terms`
902
909
  # @return [String]
903
910
  attr_accessor :terms
@@ -914,11 +921,11 @@ module Google
914
921
  end
915
922
  end
916
923
 
917
- # Query options for hangouts chat holds.
924
+ # Options for Chat holds.
918
925
  class HeldHangoutsChatQuery
919
926
  include Google::Apis::Core::Hashable
920
927
 
921
- # If true, include rooms the user has participated in.
928
+ # To include messages in Chat spaces the user was a member of, set to **true**.
922
929
  # Corresponds to the JSON property `includeRooms`
923
930
  # @return [Boolean]
924
931
  attr_accessor :include_rooms
@@ -934,23 +941,24 @@ module Google
934
941
  end
935
942
  end
936
943
 
937
- # Query options for mail holds.
944
+ # Query options for Gmail holds.
938
945
  class HeldMailQuery
939
946
  include Google::Apis::Core::Hashable
940
947
 
941
- # The end time range for the search query. These timestamps are in GMT and
942
- # rounded down to the start of the given date.
948
+ # The end time for the query. Specify in GMT. The value is rounded to 12 AM on
949
+ # the specified date.
943
950
  # Corresponds to the JSON property `endTime`
944
951
  # @return [String]
945
952
  attr_accessor :end_time
946
953
 
947
- # The start time range for the search query. These timestamps are in GMT and
948
- # rounded down to the start of the given date.
954
+ # The start time for the query. Specify in GMT. The value is rounded to 12 AM on
955
+ # the specified date.
949
956
  # Corresponds to the JSON property `startTime`
950
957
  # @return [String]
951
958
  attr_accessor :start_time
952
959
 
953
- # The search terms for the hold.
960
+ # The [search operators](https://support.google.com/vault/answer/2474474) used
961
+ # to refine the messages covered by the hold.
954
962
  # Corresponds to the JSON property `terms`
955
963
  # @return [String]
956
964
  attr_accessor :terms
@@ -967,17 +975,17 @@ module Google
967
975
  end
968
976
  end
969
977
 
970
- # A organizational unit being held in a particular hold. This structure is
971
- # immutable.
978
+ # The organizational unit covered by a hold. This structure is immutable.
972
979
  class HeldOrgUnit
973
980
  include Google::Apis::Core::Hashable
974
981
 
975
- # When the org unit was put on hold. This property is immutable.
982
+ # When the organizational unit was put on hold. This property is immutable.
976
983
  # Corresponds to the JSON property `holdTime`
977
984
  # @return [String]
978
985
  attr_accessor :hold_time
979
986
 
980
- # The org unit's immutable ID as provided by the Admin SDK.
987
+ # The organizational unit's immutable ID as provided by the [Admin SDK](https://
988
+ # developers.google.com/admin-sdk/).
981
989
  # Corresponds to the JSON property `orgUnitId`
982
990
  # @return [String]
983
991
  attr_accessor :org_unit_id
@@ -993,12 +1001,12 @@ module Google
993
1001
  end
994
1002
  end
995
1003
 
996
- # Query options for Voice holds.
1004
+ # Options for Voice holds.
997
1005
  class HeldVoiceQuery
998
1006
  include Google::Apis::Core::Hashable
999
1007
 
1000
- # Data covered by this rule. Should be non-empty. Order does not matter and
1001
- # duplicates will be ignored.
1008
+ # A list of data types covered by the hold. Should be non-empty. Order does not
1009
+ # matter and duplicates are ignored.
1002
1010
  # Corresponds to the JSON property `coveredData`
1003
1011
  # @return [Array<String>]
1004
1012
  attr_accessor :covered_data
@@ -1013,23 +1021,22 @@ module Google
1013
1021
  end
1014
1022
  end
1015
1023
 
1016
- # Represents a hold within Vault. A hold restricts purging of artifacts based on
1017
- # the combination of the query and accounts restrictions. A hold can be
1018
- # configured to either apply to an explicitly configured set of accounts, or can
1019
- # be applied to all members of an organizational unit. To work with Vault
1020
- # resources, the account must have the [required Vault privileges] (https://
1021
- # support.google.com/vault/answer/2799699) and access to the matter. To access a
1022
- # matter, the account must have created the matter, have the matter shared with
1023
- # them, or have the **View All Matters** privilege.
1024
+ # A hold. A hold prevents the specified Google Workspace service from purging
1025
+ # data for specific accounts or all members of an organizational unit. To work
1026
+ # with Vault resources, the account must have the [required Vault privileges] (
1027
+ # https://support.google.com/vault/answer/2799699) and access to the matter. To
1028
+ # access a matter, the account must have created the matter, have the matter
1029
+ # shared with them, or have the **View All Matters** privilege.
1024
1030
  class Hold
1025
1031
  include Google::Apis::Core::Hashable
1026
1032
 
1027
- # If set, the hold applies to the enumerated accounts and org_unit must be empty.
1033
+ # If set, the hold applies to the specified accounts and **orgUnit** must be
1034
+ # empty.
1028
1035
  # Corresponds to the JSON property `accounts`
1029
1036
  # @return [Array<Google::Apis::VaultV1::HeldAccount>]
1030
1037
  attr_accessor :accounts
1031
1038
 
1032
- # The corpus to be searched.
1039
+ # The service to be searched.
1033
1040
  # Corresponds to the JSON property `corpus`
1034
1041
  # @return [String]
1035
1042
  attr_accessor :corpus
@@ -1044,13 +1051,12 @@ module Google
1044
1051
  # @return [String]
1045
1052
  attr_accessor :name
1046
1053
 
1047
- # A organizational unit being held in a particular hold. This structure is
1048
- # immutable.
1054
+ # The organizational unit covered by a hold. This structure is immutable.
1049
1055
  # Corresponds to the JSON property `orgUnit`
1050
1056
  # @return [Google::Apis::VaultV1::HeldOrgUnit]
1051
1057
  attr_accessor :org_unit
1052
1058
 
1053
- # Corpus specific queries.
1059
+ # Service-specific options for holds.
1054
1060
  # Corresponds to the JSON property `query`
1055
1061
  # @return [Google::Apis::VaultV1::CorpusQuery]
1056
1062
  attr_accessor :query
@@ -1076,7 +1082,7 @@ module Google
1076
1082
  end
1077
1083
  end
1078
1084
 
1079
- # The holds for a matter.
1085
+ # The exports for a matter.
1080
1086
  class ListExportsResponse
1081
1087
  include Google::Apis::Core::Hashable
1082
1088
 
@@ -1101,7 +1107,7 @@ module Google
1101
1107
  end
1102
1108
  end
1103
1109
 
1104
- # Returns a list of held accounts for a hold.
1110
+ # Returns a list of the accounts covered by a hold.
1105
1111
  class ListHeldAccountsResponse
1106
1112
  include Google::Apis::Core::Hashable
1107
1113
 
@@ -1206,7 +1212,7 @@ module Google
1206
1212
  # @return [String]
1207
1213
  attr_accessor :next_page_token
1208
1214
 
1209
- # List of output saved queries.
1215
+ # List of saved queries.
1210
1216
  # Corresponds to the JSON property `savedQueries`
1211
1217
  # @return [Array<Google::Apis::VaultV1::SavedQuery>]
1212
1218
  attr_accessor :saved_queries
@@ -1222,11 +1228,11 @@ module Google
1222
1228
  end
1223
1229
  end
1224
1230
 
1225
- # Mail specific count metrics.
1231
+ # Gmail and classic Hangouts-specific count metrics.
1226
1232
  class MailCountResult
1227
1233
  include Google::Apis::Core::Hashable
1228
1234
 
1229
- # Error occurred when querying these accounts.
1235
+ # Errors occurred when querying these accounts.
1230
1236
  # Corresponds to the JSON property `accountCountErrors`
1231
1237
  # @return [Array<Google::Apis::VaultV1::AccountCountError>]
1232
1238
  attr_accessor :account_count_errors
@@ -1241,9 +1247,9 @@ module Google
1241
1247
  # @return [Fixnum]
1242
1248
  attr_accessor :matching_accounts_count
1243
1249
 
1244
- # When data scope is HELD_DATA in the request Query, these accounts in the
1245
- # request are not queried because they are not on hold. For other data scope,
1246
- # this field is not set.
1250
+ # When **DataScope** is **HELD_DATA**, the number of accounts in the request
1251
+ # that are not queried because they are not on hold. For other data scopes, this
1252
+ # field is not set.
1247
1253
  # Corresponds to the JSON property `nonQueryableAccounts`
1248
1254
  # @return [Array<String>]
1249
1255
  attr_accessor :non_queryable_accounts
@@ -1267,16 +1273,16 @@ module Google
1267
1273
  end
1268
1274
  end
1269
1275
 
1270
- # The options for mail export.
1276
+ # Options for Gmail exports.
1271
1277
  class MailExportOptions
1272
1278
  include Google::Apis::Core::Hashable
1273
1279
 
1274
- # The export file format.
1280
+ # The file format for exported messages.
1275
1281
  # Corresponds to the JSON property `exportFormat`
1276
1282
  # @return [String]
1277
1283
  attr_accessor :export_format
1278
1284
 
1279
- # Set to true to export confidential mode content.
1285
+ # To export confidential mode content, set to **true**.
1280
1286
  # Corresponds to the JSON property `showConfidentialModeContent`
1281
1287
  # @return [Boolean]
1282
1288
  attr_accessor :show_confidential_mode_content
@@ -1293,11 +1299,11 @@ module Google
1293
1299
  end
1294
1300
  end
1295
1301
 
1296
- # Mail search advanced options
1302
+ # Additional options for Gmail search
1297
1303
  class MailOptions
1298
1304
  include Google::Apis::Core::Hashable
1299
1305
 
1300
- # Set to true to exclude drafts.
1306
+ # Set to **true** to exclude drafts.
1301
1307
  # Corresponds to the JSON property `excludeDrafts`
1302
1308
  # @return [Boolean]
1303
1309
  attr_accessor :exclude_drafts
@@ -1321,19 +1327,19 @@ module Google
1321
1327
  class Matter
1322
1328
  include Google::Apis::Core::Hashable
1323
1329
 
1324
- # The description of the matter.
1330
+ # An optional description for the matter.
1325
1331
  # Corresponds to the JSON property `description`
1326
1332
  # @return [String]
1327
1333
  attr_accessor :description
1328
1334
 
1329
- # The matter ID which is generated by the server. Should be blank when creating
1330
- # a new matter.
1335
+ # The matter ID, which is generated by the server. Leave blank when creating a
1336
+ # matter.
1331
1337
  # Corresponds to the JSON property `matterId`
1332
1338
  # @return [String]
1333
1339
  attr_accessor :matter_id
1334
1340
 
1335
- # List of users and access to the matter. Currently there is no programmer
1336
- # defined limit on the number of permissions a matter can have.
1341
+ # Lists the users and their permission for the matter. Currently there is no
1342
+ # programmer defined limit on the number of permissions a matter can have.
1337
1343
  # Corresponds to the JSON property `matterPermissions`
1338
1344
  # @return [Array<Google::Apis::VaultV1::MatterPermission>]
1339
1345
  attr_accessor :matter_permissions
@@ -1362,18 +1368,19 @@ module Google
1362
1368
  end
1363
1369
  end
1364
1370
 
1365
- # Currently each matter only has one owner, and all others are collaborators.
1366
- # When an account is purged, its corresponding MatterPermission resources cease
1367
- # to exist.
1371
+ # Users can be matter owners or collaborators. Each matter has only one owner.
1372
+ # All others users who can access the matter are collaborators. When an account
1373
+ # is purged, its corresponding MatterPermission resources cease to exist.
1368
1374
  class MatterPermission
1369
1375
  include Google::Apis::Core::Hashable
1370
1376
 
1371
- # The account ID, as provided by Admin SDK.
1377
+ # The account ID, as provided by the [Admin SDK](https://developers.google.com/
1378
+ # admin-sdk/).
1372
1379
  # Corresponds to the JSON property `accountId`
1373
1380
  # @return [String]
1374
1381
  attr_accessor :account_id
1375
1382
 
1376
- # The user's role in this matter.
1383
+ # The user's role for the matter.
1377
1384
  # Corresponds to the JSON property `role`
1378
1385
  # @return [String]
1379
1386
  attr_accessor :role
@@ -1451,11 +1458,12 @@ module Google
1451
1458
  end
1452
1459
  end
1453
1460
 
1454
- # Org Unit to search
1461
+ # The organizational unit to search
1455
1462
  class OrgUnitInfo
1456
1463
  include Google::Apis::Core::Hashable
1457
1464
 
1458
- # Org unit to search, as provided by the Admin SDK Directory API.
1465
+ # The name of the organizational unit to search, as provided by the [Admin SDK
1466
+ # Directory API](https://developers.google.com/admin-sdk/directory/).
1459
1467
  # Corresponds to the JSON property `orgUnitId`
1460
1468
  # @return [String]
1461
1469
  attr_accessor :org_unit_id
@@ -1470,60 +1478,59 @@ module Google
1470
1478
  end
1471
1479
  end
1472
1480
 
1473
- # A query definition relevant for search & export.
1481
+ # The query definition used for search and export.
1474
1482
  class Query
1475
1483
  include Google::Apis::Core::Hashable
1476
1484
 
1477
- # Accounts to search
1485
+ # The accounts to search
1478
1486
  # Corresponds to the JSON property `accountInfo`
1479
1487
  # @return [Google::Apis::VaultV1::AccountInfo]
1480
1488
  attr_accessor :account_info
1481
1489
 
1482
- # The corpus to search.
1490
+ # The Google Workspace service to search.
1483
1491
  # Corresponds to the JSON property `corpus`
1484
1492
  # @return [String]
1485
1493
  attr_accessor :corpus
1486
1494
 
1487
- # The data source to search from.
1495
+ # The data source to search.
1488
1496
  # Corresponds to the JSON property `dataScope`
1489
1497
  # @return [String]
1490
1498
  attr_accessor :data_scope
1491
1499
 
1492
- # Drive search advanced options
1500
+ # Additional options for Drive search
1493
1501
  # Corresponds to the JSON property `driveOptions`
1494
1502
  # @return [Google::Apis::VaultV1::DriveOptions]
1495
1503
  attr_accessor :drive_options
1496
1504
 
1497
- # The end time range for the search query. These timestamps are in GMT and
1498
- # rounded down to the start of the given date.
1505
+ # The end time for the search query. Specify in GMT. The value is rounded to 12
1506
+ # AM on the specified date.
1499
1507
  # Corresponds to the JSON property `endTime`
1500
1508
  # @return [String]
1501
1509
  attr_accessor :end_time
1502
1510
 
1503
- # Accounts to search
1511
+ # The Chat spaces to search
1504
1512
  # Corresponds to the JSON property `hangoutsChatInfo`
1505
1513
  # @return [Google::Apis::VaultV1::HangoutsChatInfo]
1506
1514
  attr_accessor :hangouts_chat_info
1507
1515
 
1508
- # Hangouts chat search advanced options
1516
+ # Additional options for Google Chat search
1509
1517
  # Corresponds to the JSON property `hangoutsChatOptions`
1510
1518
  # @return [Google::Apis::VaultV1::HangoutsChatOptions]
1511
1519
  attr_accessor :hangouts_chat_options
1512
1520
 
1513
- # Mail search advanced options
1521
+ # Additional options for Gmail search
1514
1522
  # Corresponds to the JSON property `mailOptions`
1515
1523
  # @return [Google::Apis::VaultV1::MailOptions]
1516
1524
  attr_accessor :mail_options
1517
1525
 
1518
- # The search method to use. This field is similar to the search_method field but
1519
- # is introduced to support shared drives. It supports all search method types.
1520
- # In case the search_method is TEAM_DRIVE the response of this field will be
1521
- # SHARED_DRIVE only.
1526
+ # The entity to search. This field replaces **searchMethod** to support shared
1527
+ # drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is
1528
+ # **SHARED_DRIVE**.
1522
1529
  # Corresponds to the JSON property `method`
1523
1530
  # @return [String]
1524
1531
  attr_accessor :method_prop
1525
1532
 
1526
- # Org Unit to search
1533
+ # The organizational unit to search
1527
1534
  # Corresponds to the JSON property `orgUnitInfo`
1528
1535
  # @return [Google::Apis::VaultV1::OrgUnitInfo]
1529
1536
  attr_accessor :org_unit_info
@@ -1533,13 +1540,13 @@ module Google
1533
1540
  # @return [String]
1534
1541
  attr_accessor :search_method
1535
1542
 
1536
- # Shared drives to search
1543
+ # The shared drives to search
1537
1544
  # Corresponds to the JSON property `sharedDriveInfo`
1538
1545
  # @return [Google::Apis::VaultV1::SharedDriveInfo]
1539
1546
  attr_accessor :shared_drive_info
1540
1547
 
1541
- # The start time range for the search query. These timestamps are in GMT and
1542
- # rounded down to the start of the given date.
1548
+ # The start time for the search query. Specify in GMT. The value is rounded to
1549
+ # 12 AM on the specified date.
1543
1550
  # Corresponds to the JSON property `startTime`
1544
1551
  # @return [String]
1545
1552
  attr_accessor :start_time
@@ -1549,18 +1556,22 @@ module Google
1549
1556
  # @return [Google::Apis::VaultV1::TeamDriveInfo]
1550
1557
  attr_accessor :team_drive_info
1551
1558
 
1552
- # The corpus-specific search operators used to generate search results.
1559
+ # Service-specific [search operators](https://support.google.com/vault/answer/
1560
+ # 2474474) to filter search results.
1553
1561
  # Corresponds to the JSON property `terms`
1554
1562
  # @return [String]
1555
1563
  attr_accessor :terms
1556
1564
 
1557
1565
  # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles"
1558
- # . For more information, see Time Zone.
1566
+ # . For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/
1567
+ # List_of_tz_database_time_zones). For more information about how Vault uses
1568
+ # time zones, see [the Vault help center](https://support.google.com/vault/
1569
+ # answer/6092995#time).
1559
1570
  # Corresponds to the JSON property `timeZone`
1560
1571
  # @return [String]
1561
1572
  attr_accessor :time_zone
1562
1573
 
1563
- # Voice search options
1574
+ # Additional options for Voice search
1564
1575
  # Corresponds to the JSON property `voiceOptions`
1565
1576
  # @return [Google::Apis::VaultV1::VoiceOptions]
1566
1577
  attr_accessor :voice_options
@@ -1595,7 +1606,7 @@ module Google
1595
1606
  class RemoveHeldAccountsRequest
1596
1607
  include Google::Apis::Core::Hashable
1597
1608
 
1598
- # Account IDs to identify HeldAccounts to remove.
1609
+ # The account IDs of the accounts to remove from the hold.
1599
1610
  # Corresponds to the JSON property `accountIds`
1600
1611
  # @return [Array<String>]
1601
1612
  attr_accessor :account_ids
@@ -1614,8 +1625,8 @@ module Google
1614
1625
  class RemoveHeldAccountsResponse
1615
1626
  include Google::Apis::Core::Hashable
1616
1627
 
1617
- # A list of statuses for deleted accounts. Results have the same order as the
1618
- # request.
1628
+ # A list of statuses for the deleted accounts. Results have the same order as
1629
+ # the request.
1619
1630
  # Corresponds to the JSON property `statuses`
1620
1631
  # @return [Array<Google::Apis::VaultV1::Status>]
1621
1632
  attr_accessor :statuses
@@ -1685,31 +1696,32 @@ module Google
1685
1696
  end
1686
1697
  end
1687
1698
 
1688
- # Definition of the saved query. To work with Vault resources, the account must
1689
- # have the [required Vault privileges] (https://support.google.com/vault/answer/
1690
- # 2799699) and access to the matter. To access a matter, the account must have
1691
- # created the matter, have the matter shared with them, or have the **View All
1692
- # Matters** privilege.
1699
+ # The definition of a saved query. To work with Vault resources, the account
1700
+ # must have the [required Vault privileges](https://support.google.com/vault/
1701
+ # answer/2799699) and access to the matter. To access a matter, the account must
1702
+ # have created the matter, have the matter shared with them, or have the **View
1703
+ # All Matters** privilege.
1693
1704
  class SavedQuery
1694
1705
  include Google::Apis::Core::Hashable
1695
1706
 
1696
- # Output only. The server generated timestamp at which saved query was created.
1707
+ # Output only. The server-generated timestamp when the saved query was created.
1697
1708
  # Corresponds to the JSON property `createTime`
1698
1709
  # @return [String]
1699
1710
  attr_accessor :create_time
1700
1711
 
1701
- # Name of the saved query.
1712
+ # The name of the saved query.
1702
1713
  # Corresponds to the JSON property `displayName`
1703
1714
  # @return [String]
1704
1715
  attr_accessor :display_name
1705
1716
 
1706
- # Output only. The matter ID of the associated matter. The server does not look
1707
- # at this field during create and always uses matter id in the URL.
1717
+ # Output only. The matter ID of the matter the saved query is saved in. The
1718
+ # server does not use this field during create and always uses matter ID in the
1719
+ # URL.
1708
1720
  # Corresponds to the JSON property `matterId`
1709
1721
  # @return [String]
1710
1722
  attr_accessor :matter_id
1711
1723
 
1712
- # A query definition relevant for search & export.
1724
+ # The query definition used for search and export.
1713
1725
  # Corresponds to the JSON property `query`
1714
1726
  # @return [Google::Apis::VaultV1::Query]
1715
1727
  attr_accessor :query
@@ -1733,11 +1745,12 @@ module Google
1733
1745
  end
1734
1746
  end
1735
1747
 
1736
- # Shared drives to search
1748
+ # The shared drives to search
1737
1749
  class SharedDriveInfo
1738
1750
  include Google::Apis::Core::Hashable
1739
1751
 
1740
- # List of Shared drive IDs, as provided by Drive API.
1752
+ # A list of shared drive IDs, as provided by the [Drive API](https://developers.
1753
+ # google.com/drive).
1741
1754
  # Corresponds to the JSON property `sharedDriveIds`
1742
1755
  # @return [Array<String>]
1743
1756
  attr_accessor :shared_drive_ids
@@ -1795,7 +1808,8 @@ module Google
1795
1808
  class TeamDriveInfo
1796
1809
  include Google::Apis::Core::Hashable
1797
1810
 
1798
- # List of Team Drive IDs, as provided by Drive API.
1811
+ # List of Team Drive IDs, as provided by the [Drive API](https://developers.
1812
+ # google.com/drive).
1799
1813
  # Corresponds to the JSON property `teamDriveIds`
1800
1814
  # @return [Array<String>]
1801
1815
  attr_accessor :team_drive_ids
@@ -1848,11 +1862,11 @@ module Google
1848
1862
  end
1849
1863
  end
1850
1864
 
1851
- # The options for voice export.
1865
+ # The options for Voice exports.
1852
1866
  class VoiceExportOptions
1853
1867
  include Google::Apis::Core::Hashable
1854
1868
 
1855
- # The export format for voice export.
1869
+ # The file format for exported text messages.
1856
1870
  # Corresponds to the JSON property `exportFormat`
1857
1871
  # @return [String]
1858
1872
  attr_accessor :export_format
@@ -1867,7 +1881,7 @@ module Google
1867
1881
  end
1868
1882
  end
1869
1883
 
1870
- # Voice search options
1884
+ # Additional options for Voice search
1871
1885
  class VoiceOptions
1872
1886
  include Google::Apis::Core::Hashable
1873
1887