google-apis-vault_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1a5097ab627fa0b0601e417518388aa22220beb77aa2d2752cc3eb7ce3e5f1ae
4
+ data.tar.gz: cf5cf6ad0e358dbcfc7e4f018aa16158e466db615c272206cd0f7872e2ce01e5
5
+ SHA512:
6
+ metadata.gz: 4f42e6f6e09d5e87335212cb9b660c1ef0e358f99c32c50b264ff3329e10db5f8c16a5c447f21d277920b197e0d91592dd553aa8e4af925a724c567abc9e8004
7
+ data.tar.gz: 0c353bf43710449a82cd4e67dbd0f68ae2690fc3d2c4eb8ba4af81c344c3142f369591167784b838bcd42e6a34ea0fbf1b7412cedfea1a841101fdc6462c7fdd
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-vault_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/vault_v1/*.rb
9
+ lib/google/apis/vault_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-vault_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201117
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the G Suite Vault API
2
+
3
+ This is a simple client library for version V1 of the G Suite Vault API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/vault.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-vault_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-vault_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/vault_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::VaultV1::VaultService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Vault service in particular.)
67
+
68
+ For reference information on specific calls in the G Suite Vault API, see the {Google::Apis::VaultV1::VaultService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-vault_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/vault) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/vault_v1"
@@ -0,0 +1,39 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/vault_v1/service.rb'
16
+ require 'google/apis/vault_v1/classes.rb'
17
+ require 'google/apis/vault_v1/representations.rb'
18
+ require 'google/apis/vault_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # G Suite Vault API
23
+ #
24
+ # Archiving and eDiscovery for G Suite.
25
+ #
26
+ # @see https://developers.google.com/vault
27
+ module VaultV1
28
+ # Version of the G Suite Vault API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # Manage your eDiscovery data
33
+ AUTH_EDISCOVERY = 'https://www.googleapis.com/auth/ediscovery'
34
+
35
+ # View your eDiscovery data
36
+ AUTH_EDISCOVERY_READONLY = 'https://www.googleapis.com/auth/ediscovery.readonly'
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,1859 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module VaultV1
24
+
25
+ # Count number for each account.
26
+ class AccountCount
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # User's information.
30
+ # Corresponds to the JSON property `account`
31
+ # @return [Google::Apis::VaultV1::UserInfo]
32
+ attr_accessor :account
33
+
34
+ # The number of artifacts found for this account.
35
+ # Corresponds to the JSON property `count`
36
+ # @return [Fixnum]
37
+ attr_accessor :count
38
+
39
+ def initialize(**args)
40
+ update!(**args)
41
+ end
42
+
43
+ # Update properties of this object
44
+ def update!(**args)
45
+ @account = args[:account] if args.key?(:account)
46
+ @count = args[:count] if args.key?(:count)
47
+ end
48
+ end
49
+
50
+ # An error that occurred when querying a specific account
51
+ class AccountCountError
52
+ include Google::Apis::Core::Hashable
53
+
54
+ # User's information.
55
+ # Corresponds to the JSON property `account`
56
+ # @return [Google::Apis::VaultV1::UserInfo]
57
+ attr_accessor :account
58
+
59
+ # Account query error.
60
+ # Corresponds to the JSON property `errorType`
61
+ # @return [String]
62
+ attr_accessor :error_type
63
+
64
+ def initialize(**args)
65
+ update!(**args)
66
+ end
67
+
68
+ # Update properties of this object
69
+ def update!(**args)
70
+ @account = args[:account] if args.key?(:account)
71
+ @error_type = args[:error_type] if args.key?(:error_type)
72
+ end
73
+ end
74
+
75
+ # Accounts to search
76
+ class AccountInfo
77
+ include Google::Apis::Core::Hashable
78
+
79
+ # A set of accounts to search.
80
+ # Corresponds to the JSON property `emails`
81
+ # @return [Array<String>]
82
+ attr_accessor :emails
83
+
84
+ def initialize(**args)
85
+ update!(**args)
86
+ end
87
+
88
+ # Update properties of this object
89
+ def update!(**args)
90
+ @emails = args[:emails] if args.key?(:emails)
91
+ end
92
+ end
93
+
94
+ # A status detailing the status of each account creation, and the HeldAccount,
95
+ # if successful.
96
+ class AddHeldAccountResult
97
+ include Google::Apis::Core::Hashable
98
+
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.
101
+ # Corresponds to the JSON property `account`
102
+ # @return [Google::Apis::VaultV1::HeldAccount]
103
+ attr_accessor :account
104
+
105
+ # The `Status` type defines a logical error model that is suitable for different
106
+ # programming environments, including REST APIs and RPC APIs. It is used by [
107
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
108
+ # data: error code, error message, and error details. You can find out more
109
+ # about this error model and how to work with it in the [API Design Guide](https:
110
+ # //cloud.google.com/apis/design/errors).
111
+ # Corresponds to the JSON property `status`
112
+ # @return [Google::Apis::VaultV1::Status]
113
+ attr_accessor :status
114
+
115
+ def initialize(**args)
116
+ update!(**args)
117
+ end
118
+
119
+ # Update properties of this object
120
+ def update!(**args)
121
+ @account = args[:account] if args.key?(:account)
122
+ @status = args[:status] if args.key?(:status)
123
+ end
124
+ end
125
+
126
+ # Add a list of accounts to a hold.
127
+ class AddHeldAccountsRequest
128
+ include Google::Apis::Core::Hashable
129
+
130
+ # Account IDs to identify which accounts to add. Only account_ids or only emails
131
+ # should be specified, but not both.
132
+ # Corresponds to the JSON property `accountIds`
133
+ # @return [Array<String>]
134
+ attr_accessor :account_ids
135
+
136
+ # Emails to identify which accounts to add. Only emails or only account_ids
137
+ # should be specified, but not both.
138
+ # Corresponds to the JSON property `emails`
139
+ # @return [Array<String>]
140
+ attr_accessor :emails
141
+
142
+ def initialize(**args)
143
+ update!(**args)
144
+ end
145
+
146
+ # Update properties of this object
147
+ def update!(**args)
148
+ @account_ids = args[:account_ids] if args.key?(:account_ids)
149
+ @emails = args[:emails] if args.key?(:emails)
150
+ end
151
+ end
152
+
153
+ # Response for batch create held accounts.
154
+ class AddHeldAccountsResponse
155
+ include Google::Apis::Core::Hashable
156
+
157
+ # The list of responses, in the same order as the batch request.
158
+ # Corresponds to the JSON property `responses`
159
+ # @return [Array<Google::Apis::VaultV1::AddHeldAccountResult>]
160
+ attr_accessor :responses
161
+
162
+ def initialize(**args)
163
+ update!(**args)
164
+ end
165
+
166
+ # Update properties of this object
167
+ def update!(**args)
168
+ @responses = args[:responses] if args.key?(:responses)
169
+ end
170
+ end
171
+
172
+ # Add an account with the permission specified. The role cannot be owner. If an
173
+ # account already has a role in the matter, it will be overwritten.
174
+ class AddMatterPermissionsRequest
175
+ include Google::Apis::Core::Hashable
176
+
177
+ # Only relevant if send_emails is true. True to CC requestor in the email
178
+ # message. False to not CC requestor.
179
+ # Corresponds to the JSON property `ccMe`
180
+ # @return [Boolean]
181
+ attr_accessor :cc_me
182
+ alias_method :cc_me?, :cc_me
183
+
184
+ # Currently each matter only has one owner, and all others are collaborators.
185
+ # When an account is purged, its corresponding MatterPermission resources cease
186
+ # to exist.
187
+ # Corresponds to the JSON property `matterPermission`
188
+ # @return [Google::Apis::VaultV1::MatterPermission]
189
+ attr_accessor :matter_permission
190
+
191
+ # True to send notification email to the added account. False to not send
192
+ # notification email.
193
+ # Corresponds to the JSON property `sendEmails`
194
+ # @return [Boolean]
195
+ attr_accessor :send_emails
196
+ alias_method :send_emails?, :send_emails
197
+
198
+ def initialize(**args)
199
+ update!(**args)
200
+ end
201
+
202
+ # Update properties of this object
203
+ def update!(**args)
204
+ @cc_me = args[:cc_me] if args.key?(:cc_me)
205
+ @matter_permission = args[:matter_permission] if args.key?(:matter_permission)
206
+ @send_emails = args[:send_emails] if args.key?(:send_emails)
207
+ end
208
+ end
209
+
210
+ # The request message for Operations.CancelOperation.
211
+ class CancelOperationRequest
212
+ include Google::Apis::Core::Hashable
213
+
214
+ def initialize(**args)
215
+ update!(**args)
216
+ end
217
+
218
+ # Update properties of this object
219
+ def update!(**args)
220
+ end
221
+ end
222
+
223
+ # Close a matter by ID.
224
+ class CloseMatterRequest
225
+ include Google::Apis::Core::Hashable
226
+
227
+ def initialize(**args)
228
+ update!(**args)
229
+ end
230
+
231
+ # Update properties of this object
232
+ def update!(**args)
233
+ end
234
+ end
235
+
236
+ # Response to a CloseMatterRequest.
237
+ class CloseMatterResponse
238
+ include Google::Apis::Core::Hashable
239
+
240
+ # Represents a matter.
241
+ # Corresponds to the JSON property `matter`
242
+ # @return [Google::Apis::VaultV1::Matter]
243
+ attr_accessor :matter
244
+
245
+ def initialize(**args)
246
+ update!(**args)
247
+ end
248
+
249
+ # Update properties of this object
250
+ def update!(**args)
251
+ @matter = args[:matter] if args.key?(:matter)
252
+ end
253
+ end
254
+
255
+ # An export file on cloud storage
256
+ class CloudStorageFile
257
+ include Google::Apis::Core::Hashable
258
+
259
+ # The cloud storage bucket name of this export file. Can be used in cloud
260
+ # storage JSON/XML API, but not to list the bucket contents. Instead, you can
261
+ # get individual export files by object name.
262
+ # Corresponds to the JSON property `bucketName`
263
+ # @return [String]
264
+ attr_accessor :bucket_name
265
+
266
+ # The md5 hash of the file.
267
+ # Corresponds to the JSON property `md5Hash`
268
+ # @return [String]
269
+ attr_accessor :md5_hash
270
+
271
+ # The cloud storage object name of this export file. Can be used in cloud
272
+ # storage JSON/XML API.
273
+ # Corresponds to the JSON property `objectName`
274
+ # @return [String]
275
+ attr_accessor :object_name
276
+
277
+ # The size of the export file.
278
+ # Corresponds to the JSON property `size`
279
+ # @return [Fixnum]
280
+ attr_accessor :size
281
+
282
+ def initialize(**args)
283
+ update!(**args)
284
+ end
285
+
286
+ # Update properties of this object
287
+ def update!(**args)
288
+ @bucket_name = args[:bucket_name] if args.key?(:bucket_name)
289
+ @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
290
+ @object_name = args[:object_name] if args.key?(:object_name)
291
+ @size = args[:size] if args.key?(:size)
292
+ end
293
+ end
294
+
295
+ # Export sink for cloud storage files.
296
+ class CloudStorageSink
297
+ include Google::Apis::Core::Hashable
298
+
299
+ # Output only. The exported files on cloud storage.
300
+ # Corresponds to the JSON property `files`
301
+ # @return [Array<Google::Apis::VaultV1::CloudStorageFile>]
302
+ attr_accessor :files
303
+
304
+ def initialize(**args)
305
+ update!(**args)
306
+ end
307
+
308
+ # Update properties of this object
309
+ def update!(**args)
310
+ @files = args[:files] if args.key?(:files)
311
+ end
312
+ end
313
+
314
+ # Corpus specific queries.
315
+ class CorpusQuery
316
+ include Google::Apis::Core::Hashable
317
+
318
+ # Query options for Drive holds.
319
+ # Corresponds to the JSON property `driveQuery`
320
+ # @return [Google::Apis::VaultV1::HeldDriveQuery]
321
+ attr_accessor :drive_query
322
+
323
+ # Query options for group holds.
324
+ # Corresponds to the JSON property `groupsQuery`
325
+ # @return [Google::Apis::VaultV1::HeldGroupsQuery]
326
+ attr_accessor :groups_query
327
+
328
+ # Query options for hangouts chat holds.
329
+ # Corresponds to the JSON property `hangoutsChatQuery`
330
+ # @return [Google::Apis::VaultV1::HeldHangoutsChatQuery]
331
+ attr_accessor :hangouts_chat_query
332
+
333
+ # Query options for mail holds.
334
+ # Corresponds to the JSON property `mailQuery`
335
+ # @return [Google::Apis::VaultV1::HeldMailQuery]
336
+ attr_accessor :mail_query
337
+
338
+ # Query options for Voice holds.
339
+ # Corresponds to the JSON property `voiceQuery`
340
+ # @return [Google::Apis::VaultV1::HeldVoiceQuery]
341
+ attr_accessor :voice_query
342
+
343
+ def initialize(**args)
344
+ update!(**args)
345
+ end
346
+
347
+ # Update properties of this object
348
+ def update!(**args)
349
+ @drive_query = args[:drive_query] if args.key?(:drive_query)
350
+ @groups_query = args[:groups_query] if args.key?(:groups_query)
351
+ @hangouts_chat_query = args[:hangouts_chat_query] if args.key?(:hangouts_chat_query)
352
+ @mail_query = args[:mail_query] if args.key?(:mail_query)
353
+ @voice_query = args[:voice_query] if args.key?(:voice_query)
354
+ end
355
+ end
356
+
357
+ # Long running operation metadata for CountArtifacts.
358
+ class CountArtifactsMetadata
359
+ include Google::Apis::Core::Hashable
360
+
361
+ # End time of count operation. Available when operation is done.
362
+ # Corresponds to the JSON property `endTime`
363
+ # @return [String]
364
+ attr_accessor :end_time
365
+
366
+ # The matter ID of the associated matter.
367
+ # Corresponds to the JSON property `matterId`
368
+ # @return [String]
369
+ attr_accessor :matter_id
370
+
371
+ # A query definition relevant for search & export.
372
+ # Corresponds to the JSON property `query`
373
+ # @return [Google::Apis::VaultV1::Query]
374
+ attr_accessor :query
375
+
376
+ # Creation time of count operation.
377
+ # Corresponds to the JSON property `startTime`
378
+ # @return [String]
379
+ attr_accessor :start_time
380
+
381
+ def initialize(**args)
382
+ update!(**args)
383
+ end
384
+
385
+ # Update properties of this object
386
+ def update!(**args)
387
+ @end_time = args[:end_time] if args.key?(:end_time)
388
+ @matter_id = args[:matter_id] if args.key?(:matter_id)
389
+ @query = args[:query] if args.key?(:query)
390
+ @start_time = args[:start_time] if args.key?(:start_time)
391
+ end
392
+ end
393
+
394
+ # Count artifacts request.
395
+ class CountArtifactsRequest
396
+ include Google::Apis::Core::Hashable
397
+
398
+ # A query definition relevant for search & export.
399
+ # Corresponds to the JSON property `query`
400
+ # @return [Google::Apis::VaultV1::Query]
401
+ attr_accessor :query
402
+
403
+ # Specifies the granularity of the count result returned in response.
404
+ # Corresponds to the JSON property `view`
405
+ # @return [String]
406
+ attr_accessor :view
407
+
408
+ def initialize(**args)
409
+ update!(**args)
410
+ end
411
+
412
+ # Update properties of this object
413
+ def update!(**args)
414
+ @query = args[:query] if args.key?(:query)
415
+ @view = args[:view] if args.key?(:view)
416
+ end
417
+ end
418
+
419
+ # Definition of the response for method CountArtifacts.
420
+ class CountArtifactsResponse
421
+ include Google::Apis::Core::Hashable
422
+
423
+ # Groups specific count metrics.
424
+ # Corresponds to the JSON property `groupsCountResult`
425
+ # @return [Google::Apis::VaultV1::GroupsCountResult]
426
+ attr_accessor :groups_count_result
427
+
428
+ # Mail specific count metrics.
429
+ # Corresponds to the JSON property `mailCountResult`
430
+ # @return [Google::Apis::VaultV1::MailCountResult]
431
+ attr_accessor :mail_count_result
432
+
433
+ # Total count of artifacts. For mail and groups, artifacts refers to messages.
434
+ # Corresponds to the JSON property `totalCount`
435
+ # @return [Fixnum]
436
+ attr_accessor :total_count
437
+
438
+ def initialize(**args)
439
+ update!(**args)
440
+ end
441
+
442
+ # Update properties of this object
443
+ def update!(**args)
444
+ @groups_count_result = args[:groups_count_result] if args.key?(:groups_count_result)
445
+ @mail_count_result = args[:mail_count_result] if args.key?(:mail_count_result)
446
+ @total_count = args[:total_count] if args.key?(:total_count)
447
+ end
448
+ end
449
+
450
+ # The options for Drive export.
451
+ class DriveExportOptions
452
+ include Google::Apis::Core::Hashable
453
+
454
+ # Set to true to include access level information for users with indirect access
455
+ # to files.
456
+ # Corresponds to the JSON property `includeAccessInfo`
457
+ # @return [Boolean]
458
+ attr_accessor :include_access_info
459
+ alias_method :include_access_info?, :include_access_info
460
+
461
+ def initialize(**args)
462
+ update!(**args)
463
+ end
464
+
465
+ # Update properties of this object
466
+ def update!(**args)
467
+ @include_access_info = args[:include_access_info] if args.key?(:include_access_info)
468
+ end
469
+ end
470
+
471
+ # Drive search advanced options
472
+ class DriveOptions
473
+ include Google::Apis::Core::Hashable
474
+
475
+ # Set to true to include shared drive.
476
+ # Corresponds to the JSON property `includeSharedDrives`
477
+ # @return [Boolean]
478
+ attr_accessor :include_shared_drives
479
+ alias_method :include_shared_drives?, :include_shared_drives
480
+
481
+ # Set to true to include Team Drive.
482
+ # Corresponds to the JSON property `includeTeamDrives`
483
+ # @return [Boolean]
484
+ attr_accessor :include_team_drives
485
+ alias_method :include_team_drives?, :include_team_drives
486
+
487
+ # Search the versions of the Drive file as of the reference date. These
488
+ # timestamps are in GMT and rounded down to the given date.
489
+ # Corresponds to the JSON property `versionDate`
490
+ # @return [String]
491
+ attr_accessor :version_date
492
+
493
+ def initialize(**args)
494
+ update!(**args)
495
+ end
496
+
497
+ # Update properties of this object
498
+ def update!(**args)
499
+ @include_shared_drives = args[:include_shared_drives] if args.key?(:include_shared_drives)
500
+ @include_team_drives = args[:include_team_drives] if args.key?(:include_team_drives)
501
+ @version_date = args[:version_date] if args.key?(:version_date)
502
+ end
503
+ end
504
+
505
+ # A generic empty message that you can re-use to avoid defining duplicated empty
506
+ # messages in your APIs. A typical example is to use it as the request or the
507
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
508
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
509
+ # `Empty` is empty JSON object ````.
510
+ class Empty
511
+ include Google::Apis::Core::Hashable
512
+
513
+ def initialize(**args)
514
+ update!(**args)
515
+ end
516
+
517
+ # Update properties of this object
518
+ def update!(**args)
519
+ end
520
+ end
521
+
522
+ # An export
523
+ class Export
524
+ include Google::Apis::Core::Hashable
525
+
526
+ # Export sink for cloud storage files.
527
+ # Corresponds to the JSON property `cloudStorageSink`
528
+ # @return [Google::Apis::VaultV1::CloudStorageSink]
529
+ attr_accessor :cloud_storage_sink
530
+
531
+ # Output only. The time when the export was created.
532
+ # Corresponds to the JSON property `createTime`
533
+ # @return [String]
534
+ attr_accessor :create_time
535
+
536
+ # Export advanced options
537
+ # Corresponds to the JSON property `exportOptions`
538
+ # @return [Google::Apis::VaultV1::ExportOptions]
539
+ attr_accessor :export_options
540
+
541
+ # Output only. The generated export ID.
542
+ # Corresponds to the JSON property `id`
543
+ # @return [String]
544
+ attr_accessor :id
545
+
546
+ # Output only. The matter ID.
547
+ # Corresponds to the JSON property `matterId`
548
+ # @return [String]
549
+ attr_accessor :matter_id
550
+
551
+ # The export name.
552
+ # Corresponds to the JSON property `name`
553
+ # @return [String]
554
+ attr_accessor :name
555
+
556
+ # A query definition relevant for search & export.
557
+ # Corresponds to the JSON property `query`
558
+ # @return [Google::Apis::VaultV1::Query]
559
+ attr_accessor :query
560
+
561
+ # User's information.
562
+ # Corresponds to the JSON property `requester`
563
+ # @return [Google::Apis::VaultV1::UserInfo]
564
+ attr_accessor :requester
565
+
566
+ # Stats of an export.
567
+ # Corresponds to the JSON property `stats`
568
+ # @return [Google::Apis::VaultV1::ExportStats]
569
+ attr_accessor :stats
570
+
571
+ # Output only. The export status.
572
+ # Corresponds to the JSON property `status`
573
+ # @return [String]
574
+ attr_accessor :status
575
+
576
+ def initialize(**args)
577
+ update!(**args)
578
+ end
579
+
580
+ # Update properties of this object
581
+ def update!(**args)
582
+ @cloud_storage_sink = args[:cloud_storage_sink] if args.key?(:cloud_storage_sink)
583
+ @create_time = args[:create_time] if args.key?(:create_time)
584
+ @export_options = args[:export_options] if args.key?(:export_options)
585
+ @id = args[:id] if args.key?(:id)
586
+ @matter_id = args[:matter_id] if args.key?(:matter_id)
587
+ @name = args[:name] if args.key?(:name)
588
+ @query = args[:query] if args.key?(:query)
589
+ @requester = args[:requester] if args.key?(:requester)
590
+ @stats = args[:stats] if args.key?(:stats)
591
+ @status = args[:status] if args.key?(:status)
592
+ end
593
+ end
594
+
595
+ # Export advanced options
596
+ class ExportOptions
597
+ include Google::Apis::Core::Hashable
598
+
599
+ # The options for Drive export.
600
+ # Corresponds to the JSON property `driveOptions`
601
+ # @return [Google::Apis::VaultV1::DriveExportOptions]
602
+ attr_accessor :drive_options
603
+
604
+ # The options for groups export.
605
+ # Corresponds to the JSON property `groupsOptions`
606
+ # @return [Google::Apis::VaultV1::GroupsExportOptions]
607
+ attr_accessor :groups_options
608
+
609
+ # The options for hangouts chat export.
610
+ # Corresponds to the JSON property `hangoutsChatOptions`
611
+ # @return [Google::Apis::VaultV1::HangoutsChatExportOptions]
612
+ attr_accessor :hangouts_chat_options
613
+
614
+ # The options for mail export.
615
+ # Corresponds to the JSON property `mailOptions`
616
+ # @return [Google::Apis::VaultV1::MailExportOptions]
617
+ attr_accessor :mail_options
618
+
619
+ # The requested export location.
620
+ # Corresponds to the JSON property `region`
621
+ # @return [String]
622
+ attr_accessor :region
623
+
624
+ # The options for voice export.
625
+ # Corresponds to the JSON property `voiceOptions`
626
+ # @return [Google::Apis::VaultV1::VoiceExportOptions]
627
+ attr_accessor :voice_options
628
+
629
+ def initialize(**args)
630
+ update!(**args)
631
+ end
632
+
633
+ # Update properties of this object
634
+ def update!(**args)
635
+ @drive_options = args[:drive_options] if args.key?(:drive_options)
636
+ @groups_options = args[:groups_options] if args.key?(:groups_options)
637
+ @hangouts_chat_options = args[:hangouts_chat_options] if args.key?(:hangouts_chat_options)
638
+ @mail_options = args[:mail_options] if args.key?(:mail_options)
639
+ @region = args[:region] if args.key?(:region)
640
+ @voice_options = args[:voice_options] if args.key?(:voice_options)
641
+ end
642
+ end
643
+
644
+ # Stats of an export.
645
+ class ExportStats
646
+ include Google::Apis::Core::Hashable
647
+
648
+ # The number of documents already processed by the export.
649
+ # Corresponds to the JSON property `exportedArtifactCount`
650
+ # @return [Fixnum]
651
+ attr_accessor :exported_artifact_count
652
+
653
+ # The size of export in bytes.
654
+ # Corresponds to the JSON property `sizeInBytes`
655
+ # @return [Fixnum]
656
+ attr_accessor :size_in_bytes
657
+
658
+ # The number of documents to be exported.
659
+ # Corresponds to the JSON property `totalArtifactCount`
660
+ # @return [Fixnum]
661
+ attr_accessor :total_artifact_count
662
+
663
+ def initialize(**args)
664
+ update!(**args)
665
+ end
666
+
667
+ # Update properties of this object
668
+ def update!(**args)
669
+ @exported_artifact_count = args[:exported_artifact_count] if args.key?(:exported_artifact_count)
670
+ @size_in_bytes = args[:size_in_bytes] if args.key?(:size_in_bytes)
671
+ @total_artifact_count = args[:total_artifact_count] if args.key?(:total_artifact_count)
672
+ end
673
+ end
674
+
675
+ # Groups specific count metrics.
676
+ class GroupsCountResult
677
+ include Google::Apis::Core::Hashable
678
+
679
+ # Error occurred when querying these accounts.
680
+ # Corresponds to the JSON property `accountCountErrors`
681
+ # @return [Array<Google::Apis::VaultV1::AccountCountError>]
682
+ attr_accessor :account_count_errors
683
+
684
+ # Subtotal count per matching account that have more than zero messages.
685
+ # Corresponds to the JSON property `accountCounts`
686
+ # @return [Array<Google::Apis::VaultV1::AccountCount>]
687
+ attr_accessor :account_counts
688
+
689
+ # Total number of accounts that can be queried and have more than zero messages.
690
+ # Corresponds to the JSON property `matchingAccountsCount`
691
+ # @return [Fixnum]
692
+ attr_accessor :matching_accounts_count
693
+
694
+ # When data scope is HELD_DATA in the request Query, these accounts in the
695
+ # request are not queried because they are not on hold. For other data scope,
696
+ # this field is not set.
697
+ # Corresponds to the JSON property `nonQueryableAccounts`
698
+ # @return [Array<String>]
699
+ attr_accessor :non_queryable_accounts
700
+
701
+ # Total number of accounts involved in this count operation.
702
+ # Corresponds to the JSON property `queriedAccountsCount`
703
+ # @return [Fixnum]
704
+ attr_accessor :queried_accounts_count
705
+
706
+ def initialize(**args)
707
+ update!(**args)
708
+ end
709
+
710
+ # Update properties of this object
711
+ def update!(**args)
712
+ @account_count_errors = args[:account_count_errors] if args.key?(:account_count_errors)
713
+ @account_counts = args[:account_counts] if args.key?(:account_counts)
714
+ @matching_accounts_count = args[:matching_accounts_count] if args.key?(:matching_accounts_count)
715
+ @non_queryable_accounts = args[:non_queryable_accounts] if args.key?(:non_queryable_accounts)
716
+ @queried_accounts_count = args[:queried_accounts_count] if args.key?(:queried_accounts_count)
717
+ end
718
+ end
719
+
720
+ # The options for groups export.
721
+ class GroupsExportOptions
722
+ include Google::Apis::Core::Hashable
723
+
724
+ # The export format for groups export.
725
+ # Corresponds to the JSON property `exportFormat`
726
+ # @return [String]
727
+ attr_accessor :export_format
728
+
729
+ def initialize(**args)
730
+ update!(**args)
731
+ end
732
+
733
+ # Update properties of this object
734
+ def update!(**args)
735
+ @export_format = args[:export_format] if args.key?(:export_format)
736
+ end
737
+ end
738
+
739
+ # The options for hangouts chat export.
740
+ class HangoutsChatExportOptions
741
+ include Google::Apis::Core::Hashable
742
+
743
+ # The export format for hangouts chat export.
744
+ # Corresponds to the JSON property `exportFormat`
745
+ # @return [String]
746
+ attr_accessor :export_format
747
+
748
+ def initialize(**args)
749
+ update!(**args)
750
+ end
751
+
752
+ # Update properties of this object
753
+ def update!(**args)
754
+ @export_format = args[:export_format] if args.key?(:export_format)
755
+ end
756
+ end
757
+
758
+ # Accounts to search
759
+ class HangoutsChatInfo
760
+ include Google::Apis::Core::Hashable
761
+
762
+ # A set of rooms to search.
763
+ # Corresponds to the JSON property `roomId`
764
+ # @return [Array<String>]
765
+ attr_accessor :room_id
766
+
767
+ def initialize(**args)
768
+ update!(**args)
769
+ end
770
+
771
+ # Update properties of this object
772
+ def update!(**args)
773
+ @room_id = args[:room_id] if args.key?(:room_id)
774
+ end
775
+ end
776
+
777
+ # Hangouts chat search advanced options
778
+ class HangoutsChatOptions
779
+ include Google::Apis::Core::Hashable
780
+
781
+ # Set to true to include rooms.
782
+ # Corresponds to the JSON property `includeRooms`
783
+ # @return [Boolean]
784
+ attr_accessor :include_rooms
785
+ alias_method :include_rooms?, :include_rooms
786
+
787
+ def initialize(**args)
788
+ update!(**args)
789
+ end
790
+
791
+ # Update properties of this object
792
+ def update!(**args)
793
+ @include_rooms = args[:include_rooms] if args.key?(:include_rooms)
794
+ end
795
+ end
796
+
797
+ # An account being held in a particular hold. This structure is immutable. This
798
+ # can be either a single user or a google group, depending on the corpus.
799
+ class HeldAccount
800
+ include Google::Apis::Core::Hashable
801
+
802
+ # The account's ID as provided by the Admin SDK.
803
+ # Corresponds to the JSON property `accountId`
804
+ # @return [String]
805
+ attr_accessor :account_id
806
+
807
+ # The primary email address of the account. If used as an input, this takes
808
+ # precedence over account ID.
809
+ # Corresponds to the JSON property `email`
810
+ # @return [String]
811
+ attr_accessor :email
812
+
813
+ # Output only. The first name of the account holder.
814
+ # Corresponds to the JSON property `firstName`
815
+ # @return [String]
816
+ attr_accessor :first_name
817
+
818
+ # Output only. When the account was put on hold.
819
+ # Corresponds to the JSON property `holdTime`
820
+ # @return [String]
821
+ attr_accessor :hold_time
822
+
823
+ # Output only. The last name of the account holder.
824
+ # Corresponds to the JSON property `lastName`
825
+ # @return [String]
826
+ attr_accessor :last_name
827
+
828
+ def initialize(**args)
829
+ update!(**args)
830
+ end
831
+
832
+ # Update properties of this object
833
+ def update!(**args)
834
+ @account_id = args[:account_id] if args.key?(:account_id)
835
+ @email = args[:email] if args.key?(:email)
836
+ @first_name = args[:first_name] if args.key?(:first_name)
837
+ @hold_time = args[:hold_time] if args.key?(:hold_time)
838
+ @last_name = args[:last_name] if args.key?(:last_name)
839
+ end
840
+ end
841
+
842
+ # Query options for Drive holds.
843
+ class HeldDriveQuery
844
+ include Google::Apis::Core::Hashable
845
+
846
+ # If true, include files in shared drives in the hold.
847
+ # Corresponds to the JSON property `includeSharedDriveFiles`
848
+ # @return [Boolean]
849
+ attr_accessor :include_shared_drive_files
850
+ alias_method :include_shared_drive_files?, :include_shared_drive_files
851
+
852
+ # If true, include files in Team Drives in the hold.
853
+ # Corresponds to the JSON property `includeTeamDriveFiles`
854
+ # @return [Boolean]
855
+ attr_accessor :include_team_drive_files
856
+ alias_method :include_team_drive_files?, :include_team_drive_files
857
+
858
+ def initialize(**args)
859
+ update!(**args)
860
+ end
861
+
862
+ # Update properties of this object
863
+ def update!(**args)
864
+ @include_shared_drive_files = args[:include_shared_drive_files] if args.key?(:include_shared_drive_files)
865
+ @include_team_drive_files = args[:include_team_drive_files] if args.key?(:include_team_drive_files)
866
+ end
867
+ end
868
+
869
+ # Query options for group holds.
870
+ class HeldGroupsQuery
871
+ include Google::Apis::Core::Hashable
872
+
873
+ # The end time range for the search query. These timestamps are in GMT and
874
+ # rounded down to the start of the given date.
875
+ # Corresponds to the JSON property `endTime`
876
+ # @return [String]
877
+ attr_accessor :end_time
878
+
879
+ # The start time range for the search query. These timestamps are in GMT and
880
+ # rounded down to the start of the given date.
881
+ # Corresponds to the JSON property `startTime`
882
+ # @return [String]
883
+ attr_accessor :start_time
884
+
885
+ # The search terms for the hold.
886
+ # Corresponds to the JSON property `terms`
887
+ # @return [String]
888
+ attr_accessor :terms
889
+
890
+ def initialize(**args)
891
+ update!(**args)
892
+ end
893
+
894
+ # Update properties of this object
895
+ def update!(**args)
896
+ @end_time = args[:end_time] if args.key?(:end_time)
897
+ @start_time = args[:start_time] if args.key?(:start_time)
898
+ @terms = args[:terms] if args.key?(:terms)
899
+ end
900
+ end
901
+
902
+ # Query options for hangouts chat holds.
903
+ class HeldHangoutsChatQuery
904
+ include Google::Apis::Core::Hashable
905
+
906
+ # If true, include rooms the user has participated in.
907
+ # Corresponds to the JSON property `includeRooms`
908
+ # @return [Boolean]
909
+ attr_accessor :include_rooms
910
+ alias_method :include_rooms?, :include_rooms
911
+
912
+ def initialize(**args)
913
+ update!(**args)
914
+ end
915
+
916
+ # Update properties of this object
917
+ def update!(**args)
918
+ @include_rooms = args[:include_rooms] if args.key?(:include_rooms)
919
+ end
920
+ end
921
+
922
+ # Query options for mail holds.
923
+ class HeldMailQuery
924
+ include Google::Apis::Core::Hashable
925
+
926
+ # The end time range for the search query. These timestamps are in GMT and
927
+ # rounded down to the start of the given date.
928
+ # Corresponds to the JSON property `endTime`
929
+ # @return [String]
930
+ attr_accessor :end_time
931
+
932
+ # The start time range for the search query. These timestamps are in GMT and
933
+ # rounded down to the start of the given date.
934
+ # Corresponds to the JSON property `startTime`
935
+ # @return [String]
936
+ attr_accessor :start_time
937
+
938
+ # The search terms for the hold.
939
+ # Corresponds to the JSON property `terms`
940
+ # @return [String]
941
+ attr_accessor :terms
942
+
943
+ def initialize(**args)
944
+ update!(**args)
945
+ end
946
+
947
+ # Update properties of this object
948
+ def update!(**args)
949
+ @end_time = args[:end_time] if args.key?(:end_time)
950
+ @start_time = args[:start_time] if args.key?(:start_time)
951
+ @terms = args[:terms] if args.key?(:terms)
952
+ end
953
+ end
954
+
955
+ # A organizational unit being held in a particular hold. This structure is
956
+ # immutable.
957
+ class HeldOrgUnit
958
+ include Google::Apis::Core::Hashable
959
+
960
+ # When the org unit was put on hold. This property is immutable.
961
+ # Corresponds to the JSON property `holdTime`
962
+ # @return [String]
963
+ attr_accessor :hold_time
964
+
965
+ # The org unit's immutable ID as provided by the Admin SDK.
966
+ # Corresponds to the JSON property `orgUnitId`
967
+ # @return [String]
968
+ attr_accessor :org_unit_id
969
+
970
+ def initialize(**args)
971
+ update!(**args)
972
+ end
973
+
974
+ # Update properties of this object
975
+ def update!(**args)
976
+ @hold_time = args[:hold_time] if args.key?(:hold_time)
977
+ @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
978
+ end
979
+ end
980
+
981
+ # Query options for Voice holds.
982
+ class HeldVoiceQuery
983
+ include Google::Apis::Core::Hashable
984
+
985
+ # Data covered by this rule. Should be non-empty. Order does not matter and
986
+ # duplicates will be ignored.
987
+ # Corresponds to the JSON property `coveredData`
988
+ # @return [Array<String>]
989
+ attr_accessor :covered_data
990
+
991
+ def initialize(**args)
992
+ update!(**args)
993
+ end
994
+
995
+ # Update properties of this object
996
+ def update!(**args)
997
+ @covered_data = args[:covered_data] if args.key?(:covered_data)
998
+ end
999
+ end
1000
+
1001
+ # Represents a hold within Vault. A hold restricts purging of artifacts based on
1002
+ # the combination of the query and accounts restrictions. A hold can be
1003
+ # configured to either apply to an explicitly configured set of accounts, or can
1004
+ # be applied to all members of an organizational unit.
1005
+ class Hold
1006
+ include Google::Apis::Core::Hashable
1007
+
1008
+ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
1009
+ # Corresponds to the JSON property `accounts`
1010
+ # @return [Array<Google::Apis::VaultV1::HeldAccount>]
1011
+ attr_accessor :accounts
1012
+
1013
+ # The corpus to be searched.
1014
+ # Corresponds to the JSON property `corpus`
1015
+ # @return [String]
1016
+ attr_accessor :corpus
1017
+
1018
+ # The unique immutable ID of the hold. Assigned during creation.
1019
+ # Corresponds to the JSON property `holdId`
1020
+ # @return [String]
1021
+ attr_accessor :hold_id
1022
+
1023
+ # The name of the hold.
1024
+ # Corresponds to the JSON property `name`
1025
+ # @return [String]
1026
+ attr_accessor :name
1027
+
1028
+ # A organizational unit being held in a particular hold. This structure is
1029
+ # immutable.
1030
+ # Corresponds to the JSON property `orgUnit`
1031
+ # @return [Google::Apis::VaultV1::HeldOrgUnit]
1032
+ attr_accessor :org_unit
1033
+
1034
+ # Corpus specific queries.
1035
+ # Corresponds to the JSON property `query`
1036
+ # @return [Google::Apis::VaultV1::CorpusQuery]
1037
+ attr_accessor :query
1038
+
1039
+ # The last time this hold was modified.
1040
+ # Corresponds to the JSON property `updateTime`
1041
+ # @return [String]
1042
+ attr_accessor :update_time
1043
+
1044
+ def initialize(**args)
1045
+ update!(**args)
1046
+ end
1047
+
1048
+ # Update properties of this object
1049
+ def update!(**args)
1050
+ @accounts = args[:accounts] if args.key?(:accounts)
1051
+ @corpus = args[:corpus] if args.key?(:corpus)
1052
+ @hold_id = args[:hold_id] if args.key?(:hold_id)
1053
+ @name = args[:name] if args.key?(:name)
1054
+ @org_unit = args[:org_unit] if args.key?(:org_unit)
1055
+ @query = args[:query] if args.key?(:query)
1056
+ @update_time = args[:update_time] if args.key?(:update_time)
1057
+ end
1058
+ end
1059
+
1060
+ # The holds for a matter.
1061
+ class ListExportsResponse
1062
+ include Google::Apis::Core::Hashable
1063
+
1064
+ # The list of exports.
1065
+ # Corresponds to the JSON property `exports`
1066
+ # @return [Array<Google::Apis::VaultV1::Export>]
1067
+ attr_accessor :exports
1068
+
1069
+ # Page token to retrieve the next page of results in the list.
1070
+ # Corresponds to the JSON property `nextPageToken`
1071
+ # @return [String]
1072
+ attr_accessor :next_page_token
1073
+
1074
+ def initialize(**args)
1075
+ update!(**args)
1076
+ end
1077
+
1078
+ # Update properties of this object
1079
+ def update!(**args)
1080
+ @exports = args[:exports] if args.key?(:exports)
1081
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1082
+ end
1083
+ end
1084
+
1085
+ # Returns a list of held accounts for a hold.
1086
+ class ListHeldAccountsResponse
1087
+ include Google::Apis::Core::Hashable
1088
+
1089
+ # The held accounts on a hold.
1090
+ # Corresponds to the JSON property `accounts`
1091
+ # @return [Array<Google::Apis::VaultV1::HeldAccount>]
1092
+ attr_accessor :accounts
1093
+
1094
+ def initialize(**args)
1095
+ update!(**args)
1096
+ end
1097
+
1098
+ # Update properties of this object
1099
+ def update!(**args)
1100
+ @accounts = args[:accounts] if args.key?(:accounts)
1101
+ end
1102
+ end
1103
+
1104
+ # The holds for a matter.
1105
+ class ListHoldsResponse
1106
+ include Google::Apis::Core::Hashable
1107
+
1108
+ # The list of holds.
1109
+ # Corresponds to the JSON property `holds`
1110
+ # @return [Array<Google::Apis::VaultV1::Hold>]
1111
+ attr_accessor :holds
1112
+
1113
+ # Page token to retrieve the next page of results in the list. If this is empty,
1114
+ # then there are no more holds to list.
1115
+ # Corresponds to the JSON property `nextPageToken`
1116
+ # @return [String]
1117
+ attr_accessor :next_page_token
1118
+
1119
+ def initialize(**args)
1120
+ update!(**args)
1121
+ end
1122
+
1123
+ # Update properties of this object
1124
+ def update!(**args)
1125
+ @holds = args[:holds] if args.key?(:holds)
1126
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1127
+ end
1128
+ end
1129
+
1130
+ # Provides the list of matters.
1131
+ class ListMattersResponse
1132
+ include Google::Apis::Core::Hashable
1133
+
1134
+ # List of matters.
1135
+ # Corresponds to the JSON property `matters`
1136
+ # @return [Array<Google::Apis::VaultV1::Matter>]
1137
+ attr_accessor :matters
1138
+
1139
+ # Page token to retrieve the next page of results in the list.
1140
+ # Corresponds to the JSON property `nextPageToken`
1141
+ # @return [String]
1142
+ attr_accessor :next_page_token
1143
+
1144
+ def initialize(**args)
1145
+ update!(**args)
1146
+ end
1147
+
1148
+ # Update properties of this object
1149
+ def update!(**args)
1150
+ @matters = args[:matters] if args.key?(:matters)
1151
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1152
+ end
1153
+ end
1154
+
1155
+ # The response message for Operations.ListOperations.
1156
+ class ListOperationsResponse
1157
+ include Google::Apis::Core::Hashable
1158
+
1159
+ # The standard List next-page token.
1160
+ # Corresponds to the JSON property `nextPageToken`
1161
+ # @return [String]
1162
+ attr_accessor :next_page_token
1163
+
1164
+ # A list of operations that matches the specified filter in the request.
1165
+ # Corresponds to the JSON property `operations`
1166
+ # @return [Array<Google::Apis::VaultV1::Operation>]
1167
+ attr_accessor :operations
1168
+
1169
+ def initialize(**args)
1170
+ update!(**args)
1171
+ end
1172
+
1173
+ # Update properties of this object
1174
+ def update!(**args)
1175
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1176
+ @operations = args[:operations] if args.key?(:operations)
1177
+ end
1178
+ end
1179
+
1180
+ # Definition of the response for method ListSaveQuery.
1181
+ class ListSavedQueriesResponse
1182
+ include Google::Apis::Core::Hashable
1183
+
1184
+ # Page token to retrieve the next page of results in the list. If this is empty,
1185
+ # then there are no more saved queries to list.
1186
+ # Corresponds to the JSON property `nextPageToken`
1187
+ # @return [String]
1188
+ attr_accessor :next_page_token
1189
+
1190
+ # List of output saved queries.
1191
+ # Corresponds to the JSON property `savedQueries`
1192
+ # @return [Array<Google::Apis::VaultV1::SavedQuery>]
1193
+ attr_accessor :saved_queries
1194
+
1195
+ def initialize(**args)
1196
+ update!(**args)
1197
+ end
1198
+
1199
+ # Update properties of this object
1200
+ def update!(**args)
1201
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1202
+ @saved_queries = args[:saved_queries] if args.key?(:saved_queries)
1203
+ end
1204
+ end
1205
+
1206
+ # Mail specific count metrics.
1207
+ class MailCountResult
1208
+ include Google::Apis::Core::Hashable
1209
+
1210
+ # Error occurred when querying these accounts.
1211
+ # Corresponds to the JSON property `accountCountErrors`
1212
+ # @return [Array<Google::Apis::VaultV1::AccountCountError>]
1213
+ attr_accessor :account_count_errors
1214
+
1215
+ # Subtotal count per matching account that have more than zero messages.
1216
+ # Corresponds to the JSON property `accountCounts`
1217
+ # @return [Array<Google::Apis::VaultV1::AccountCount>]
1218
+ attr_accessor :account_counts
1219
+
1220
+ # Total number of accounts that can be queried and have more than zero messages.
1221
+ # Corresponds to the JSON property `matchingAccountsCount`
1222
+ # @return [Fixnum]
1223
+ attr_accessor :matching_accounts_count
1224
+
1225
+ # When data scope is HELD_DATA in the request Query, these accounts in the
1226
+ # request are not queried because they are not on hold. For other data scope,
1227
+ # this field is not set.
1228
+ # Corresponds to the JSON property `nonQueryableAccounts`
1229
+ # @return [Array<String>]
1230
+ attr_accessor :non_queryable_accounts
1231
+
1232
+ # Total number of accounts involved in this count operation.
1233
+ # Corresponds to the JSON property `queriedAccountsCount`
1234
+ # @return [Fixnum]
1235
+ attr_accessor :queried_accounts_count
1236
+
1237
+ def initialize(**args)
1238
+ update!(**args)
1239
+ end
1240
+
1241
+ # Update properties of this object
1242
+ def update!(**args)
1243
+ @account_count_errors = args[:account_count_errors] if args.key?(:account_count_errors)
1244
+ @account_counts = args[:account_counts] if args.key?(:account_counts)
1245
+ @matching_accounts_count = args[:matching_accounts_count] if args.key?(:matching_accounts_count)
1246
+ @non_queryable_accounts = args[:non_queryable_accounts] if args.key?(:non_queryable_accounts)
1247
+ @queried_accounts_count = args[:queried_accounts_count] if args.key?(:queried_accounts_count)
1248
+ end
1249
+ end
1250
+
1251
+ # The options for mail export.
1252
+ class MailExportOptions
1253
+ include Google::Apis::Core::Hashable
1254
+
1255
+ # The export file format.
1256
+ # Corresponds to the JSON property `exportFormat`
1257
+ # @return [String]
1258
+ attr_accessor :export_format
1259
+
1260
+ # Set to true to export confidential mode content.
1261
+ # Corresponds to the JSON property `showConfidentialModeContent`
1262
+ # @return [Boolean]
1263
+ attr_accessor :show_confidential_mode_content
1264
+ alias_method :show_confidential_mode_content?, :show_confidential_mode_content
1265
+
1266
+ def initialize(**args)
1267
+ update!(**args)
1268
+ end
1269
+
1270
+ # Update properties of this object
1271
+ def update!(**args)
1272
+ @export_format = args[:export_format] if args.key?(:export_format)
1273
+ @show_confidential_mode_content = args[:show_confidential_mode_content] if args.key?(:show_confidential_mode_content)
1274
+ end
1275
+ end
1276
+
1277
+ # Mail search advanced options
1278
+ class MailOptions
1279
+ include Google::Apis::Core::Hashable
1280
+
1281
+ # Set to true to exclude drafts.
1282
+ # Corresponds to the JSON property `excludeDrafts`
1283
+ # @return [Boolean]
1284
+ attr_accessor :exclude_drafts
1285
+ alias_method :exclude_drafts?, :exclude_drafts
1286
+
1287
+ def initialize(**args)
1288
+ update!(**args)
1289
+ end
1290
+
1291
+ # Update properties of this object
1292
+ def update!(**args)
1293
+ @exclude_drafts = args[:exclude_drafts] if args.key?(:exclude_drafts)
1294
+ end
1295
+ end
1296
+
1297
+ # Represents a matter.
1298
+ class Matter
1299
+ include Google::Apis::Core::Hashable
1300
+
1301
+ # The description of the matter.
1302
+ # Corresponds to the JSON property `description`
1303
+ # @return [String]
1304
+ attr_accessor :description
1305
+
1306
+ # The matter ID which is generated by the server. Should be blank when creating
1307
+ # a new matter.
1308
+ # Corresponds to the JSON property `matterId`
1309
+ # @return [String]
1310
+ attr_accessor :matter_id
1311
+
1312
+ # List of users and access to the matter. Currently there is no programmer
1313
+ # defined limit on the number of permissions a matter can have.
1314
+ # Corresponds to the JSON property `matterPermissions`
1315
+ # @return [Array<Google::Apis::VaultV1::MatterPermission>]
1316
+ attr_accessor :matter_permissions
1317
+
1318
+ # The name of the matter.
1319
+ # Corresponds to the JSON property `name`
1320
+ # @return [String]
1321
+ attr_accessor :name
1322
+
1323
+ # The state of the matter.
1324
+ # Corresponds to the JSON property `state`
1325
+ # @return [String]
1326
+ attr_accessor :state
1327
+
1328
+ def initialize(**args)
1329
+ update!(**args)
1330
+ end
1331
+
1332
+ # Update properties of this object
1333
+ def update!(**args)
1334
+ @description = args[:description] if args.key?(:description)
1335
+ @matter_id = args[:matter_id] if args.key?(:matter_id)
1336
+ @matter_permissions = args[:matter_permissions] if args.key?(:matter_permissions)
1337
+ @name = args[:name] if args.key?(:name)
1338
+ @state = args[:state] if args.key?(:state)
1339
+ end
1340
+ end
1341
+
1342
+ # Currently each matter only has one owner, and all others are collaborators.
1343
+ # When an account is purged, its corresponding MatterPermission resources cease
1344
+ # to exist.
1345
+ class MatterPermission
1346
+ include Google::Apis::Core::Hashable
1347
+
1348
+ # The account ID, as provided by Admin SDK.
1349
+ # Corresponds to the JSON property `accountId`
1350
+ # @return [String]
1351
+ attr_accessor :account_id
1352
+
1353
+ # The user's role in this matter.
1354
+ # Corresponds to the JSON property `role`
1355
+ # @return [String]
1356
+ attr_accessor :role
1357
+
1358
+ def initialize(**args)
1359
+ update!(**args)
1360
+ end
1361
+
1362
+ # Update properties of this object
1363
+ def update!(**args)
1364
+ @account_id = args[:account_id] if args.key?(:account_id)
1365
+ @role = args[:role] if args.key?(:role)
1366
+ end
1367
+ end
1368
+
1369
+ # This resource represents a long-running operation that is the result of a
1370
+ # network API call.
1371
+ class Operation
1372
+ include Google::Apis::Core::Hashable
1373
+
1374
+ # If the value is `false`, it means the operation is still in progress. If `true`
1375
+ # , the operation is completed, and either `error` or `response` is available.
1376
+ # Corresponds to the JSON property `done`
1377
+ # @return [Boolean]
1378
+ attr_accessor :done
1379
+ alias_method :done?, :done
1380
+
1381
+ # The `Status` type defines a logical error model that is suitable for different
1382
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1383
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1384
+ # data: error code, error message, and error details. You can find out more
1385
+ # about this error model and how to work with it in the [API Design Guide](https:
1386
+ # //cloud.google.com/apis/design/errors).
1387
+ # Corresponds to the JSON property `error`
1388
+ # @return [Google::Apis::VaultV1::Status]
1389
+ attr_accessor :error
1390
+
1391
+ # Service-specific metadata associated with the operation. It typically contains
1392
+ # progress information and common metadata such as create time. Some services
1393
+ # might not provide such metadata. Any method that returns a long-running
1394
+ # operation should document the metadata type, if any.
1395
+ # Corresponds to the JSON property `metadata`
1396
+ # @return [Hash<String,Object>]
1397
+ attr_accessor :metadata
1398
+
1399
+ # The server-assigned name, which is only unique within the same service that
1400
+ # originally returns it. If you use the default HTTP mapping, the `name` should
1401
+ # be a resource name ending with `operations/`unique_id``.
1402
+ # Corresponds to the JSON property `name`
1403
+ # @return [String]
1404
+ attr_accessor :name
1405
+
1406
+ # The normal response of the operation in case of success. If the original
1407
+ # method returns no data on success, such as `Delete`, the response is `google.
1408
+ # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
1409
+ # the response should be the resource. For other methods, the response should
1410
+ # have the type `XxxResponse`, where `Xxx` is the original method name. For
1411
+ # example, if the original method name is `TakeSnapshot()`, the inferred
1412
+ # response type is `TakeSnapshotResponse`.
1413
+ # Corresponds to the JSON property `response`
1414
+ # @return [Hash<String,Object>]
1415
+ attr_accessor :response
1416
+
1417
+ def initialize(**args)
1418
+ update!(**args)
1419
+ end
1420
+
1421
+ # Update properties of this object
1422
+ def update!(**args)
1423
+ @done = args[:done] if args.key?(:done)
1424
+ @error = args[:error] if args.key?(:error)
1425
+ @metadata = args[:metadata] if args.key?(:metadata)
1426
+ @name = args[:name] if args.key?(:name)
1427
+ @response = args[:response] if args.key?(:response)
1428
+ end
1429
+ end
1430
+
1431
+ # Org Unit to search
1432
+ class OrgUnitInfo
1433
+ include Google::Apis::Core::Hashable
1434
+
1435
+ # Org unit to search, as provided by the Admin SDK Directory API.
1436
+ # Corresponds to the JSON property `orgUnitId`
1437
+ # @return [String]
1438
+ attr_accessor :org_unit_id
1439
+
1440
+ def initialize(**args)
1441
+ update!(**args)
1442
+ end
1443
+
1444
+ # Update properties of this object
1445
+ def update!(**args)
1446
+ @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
1447
+ end
1448
+ end
1449
+
1450
+ # A query definition relevant for search & export.
1451
+ class Query
1452
+ include Google::Apis::Core::Hashable
1453
+
1454
+ # Accounts to search
1455
+ # Corresponds to the JSON property `accountInfo`
1456
+ # @return [Google::Apis::VaultV1::AccountInfo]
1457
+ attr_accessor :account_info
1458
+
1459
+ # The corpus to search.
1460
+ # Corresponds to the JSON property `corpus`
1461
+ # @return [String]
1462
+ attr_accessor :corpus
1463
+
1464
+ # The data source to search from.
1465
+ # Corresponds to the JSON property `dataScope`
1466
+ # @return [String]
1467
+ attr_accessor :data_scope
1468
+
1469
+ # Drive search advanced options
1470
+ # Corresponds to the JSON property `driveOptions`
1471
+ # @return [Google::Apis::VaultV1::DriveOptions]
1472
+ attr_accessor :drive_options
1473
+
1474
+ # The end time range for the search query. These timestamps are in GMT and
1475
+ # rounded down to the start of the given date.
1476
+ # Corresponds to the JSON property `endTime`
1477
+ # @return [String]
1478
+ attr_accessor :end_time
1479
+
1480
+ # Accounts to search
1481
+ # Corresponds to the JSON property `hangoutsChatInfo`
1482
+ # @return [Google::Apis::VaultV1::HangoutsChatInfo]
1483
+ attr_accessor :hangouts_chat_info
1484
+
1485
+ # Hangouts chat search advanced options
1486
+ # Corresponds to the JSON property `hangoutsChatOptions`
1487
+ # @return [Google::Apis::VaultV1::HangoutsChatOptions]
1488
+ attr_accessor :hangouts_chat_options
1489
+
1490
+ # Mail search advanced options
1491
+ # Corresponds to the JSON property `mailOptions`
1492
+ # @return [Google::Apis::VaultV1::MailOptions]
1493
+ attr_accessor :mail_options
1494
+
1495
+ # The search method to use. This field is similar to the search_method field but
1496
+ # is introduced to support shared drives. It supports all search method types.
1497
+ # In case the search_method is TEAM_DRIVE the response of this field will be
1498
+ # SHARED_DRIVE only.
1499
+ # Corresponds to the JSON property `method`
1500
+ # @return [String]
1501
+ attr_accessor :method_prop
1502
+
1503
+ # Org Unit to search
1504
+ # Corresponds to the JSON property `orgUnitInfo`
1505
+ # @return [Google::Apis::VaultV1::OrgUnitInfo]
1506
+ attr_accessor :org_unit_info
1507
+
1508
+ # The search method to use.
1509
+ # Corresponds to the JSON property `searchMethod`
1510
+ # @return [String]
1511
+ attr_accessor :search_method
1512
+
1513
+ # Shared drives to search
1514
+ # Corresponds to the JSON property `sharedDriveInfo`
1515
+ # @return [Google::Apis::VaultV1::SharedDriveInfo]
1516
+ attr_accessor :shared_drive_info
1517
+
1518
+ # The start time range for the search query. These timestamps are in GMT and
1519
+ # rounded down to the start of the given date.
1520
+ # Corresponds to the JSON property `startTime`
1521
+ # @return [String]
1522
+ attr_accessor :start_time
1523
+
1524
+ # Team Drives to search
1525
+ # Corresponds to the JSON property `teamDriveInfo`
1526
+ # @return [Google::Apis::VaultV1::TeamDriveInfo]
1527
+ attr_accessor :team_drive_info
1528
+
1529
+ # The corpus-specific search operators used to generate search results.
1530
+ # Corresponds to the JSON property `terms`
1531
+ # @return [String]
1532
+ attr_accessor :terms
1533
+
1534
+ # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles"
1535
+ # . For more information, see Time Zone.
1536
+ # Corresponds to the JSON property `timeZone`
1537
+ # @return [String]
1538
+ attr_accessor :time_zone
1539
+
1540
+ # Voice search options
1541
+ # Corresponds to the JSON property `voiceOptions`
1542
+ # @return [Google::Apis::VaultV1::VoiceOptions]
1543
+ attr_accessor :voice_options
1544
+
1545
+ def initialize(**args)
1546
+ update!(**args)
1547
+ end
1548
+
1549
+ # Update properties of this object
1550
+ def update!(**args)
1551
+ @account_info = args[:account_info] if args.key?(:account_info)
1552
+ @corpus = args[:corpus] if args.key?(:corpus)
1553
+ @data_scope = args[:data_scope] if args.key?(:data_scope)
1554
+ @drive_options = args[:drive_options] if args.key?(:drive_options)
1555
+ @end_time = args[:end_time] if args.key?(:end_time)
1556
+ @hangouts_chat_info = args[:hangouts_chat_info] if args.key?(:hangouts_chat_info)
1557
+ @hangouts_chat_options = args[:hangouts_chat_options] if args.key?(:hangouts_chat_options)
1558
+ @mail_options = args[:mail_options] if args.key?(:mail_options)
1559
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
1560
+ @org_unit_info = args[:org_unit_info] if args.key?(:org_unit_info)
1561
+ @search_method = args[:search_method] if args.key?(:search_method)
1562
+ @shared_drive_info = args[:shared_drive_info] if args.key?(:shared_drive_info)
1563
+ @start_time = args[:start_time] if args.key?(:start_time)
1564
+ @team_drive_info = args[:team_drive_info] if args.key?(:team_drive_info)
1565
+ @terms = args[:terms] if args.key?(:terms)
1566
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
1567
+ @voice_options = args[:voice_options] if args.key?(:voice_options)
1568
+ end
1569
+ end
1570
+
1571
+ # Remove a list of accounts from a hold.
1572
+ class RemoveHeldAccountsRequest
1573
+ include Google::Apis::Core::Hashable
1574
+
1575
+ # Account IDs to identify HeldAccounts to remove.
1576
+ # Corresponds to the JSON property `accountIds`
1577
+ # @return [Array<String>]
1578
+ attr_accessor :account_ids
1579
+
1580
+ def initialize(**args)
1581
+ update!(**args)
1582
+ end
1583
+
1584
+ # Update properties of this object
1585
+ def update!(**args)
1586
+ @account_ids = args[:account_ids] if args.key?(:account_ids)
1587
+ end
1588
+ end
1589
+
1590
+ # Response for batch delete held accounts.
1591
+ class RemoveHeldAccountsResponse
1592
+ include Google::Apis::Core::Hashable
1593
+
1594
+ # A list of statuses for deleted accounts. Results have the same order as the
1595
+ # request.
1596
+ # Corresponds to the JSON property `statuses`
1597
+ # @return [Array<Google::Apis::VaultV1::Status>]
1598
+ attr_accessor :statuses
1599
+
1600
+ def initialize(**args)
1601
+ update!(**args)
1602
+ end
1603
+
1604
+ # Update properties of this object
1605
+ def update!(**args)
1606
+ @statuses = args[:statuses] if args.key?(:statuses)
1607
+ end
1608
+ end
1609
+
1610
+ # Remove an account as a matter collaborator.
1611
+ class RemoveMatterPermissionsRequest
1612
+ include Google::Apis::Core::Hashable
1613
+
1614
+ # The account ID.
1615
+ # Corresponds to the JSON property `accountId`
1616
+ # @return [String]
1617
+ attr_accessor :account_id
1618
+
1619
+ def initialize(**args)
1620
+ update!(**args)
1621
+ end
1622
+
1623
+ # Update properties of this object
1624
+ def update!(**args)
1625
+ @account_id = args[:account_id] if args.key?(:account_id)
1626
+ end
1627
+ end
1628
+
1629
+ # Reopen a matter by ID.
1630
+ class ReopenMatterRequest
1631
+ include Google::Apis::Core::Hashable
1632
+
1633
+ def initialize(**args)
1634
+ update!(**args)
1635
+ end
1636
+
1637
+ # Update properties of this object
1638
+ def update!(**args)
1639
+ end
1640
+ end
1641
+
1642
+ # Response to a ReopenMatterRequest.
1643
+ class ReopenMatterResponse
1644
+ include Google::Apis::Core::Hashable
1645
+
1646
+ # Represents a matter.
1647
+ # Corresponds to the JSON property `matter`
1648
+ # @return [Google::Apis::VaultV1::Matter]
1649
+ attr_accessor :matter
1650
+
1651
+ def initialize(**args)
1652
+ update!(**args)
1653
+ end
1654
+
1655
+ # Update properties of this object
1656
+ def update!(**args)
1657
+ @matter = args[:matter] if args.key?(:matter)
1658
+ end
1659
+ end
1660
+
1661
+ # Definition of the saved query.
1662
+ class SavedQuery
1663
+ include Google::Apis::Core::Hashable
1664
+
1665
+ # Output only. The server generated timestamp at which saved query was created.
1666
+ # Corresponds to the JSON property `createTime`
1667
+ # @return [String]
1668
+ attr_accessor :create_time
1669
+
1670
+ # Name of the saved query.
1671
+ # Corresponds to the JSON property `displayName`
1672
+ # @return [String]
1673
+ attr_accessor :display_name
1674
+
1675
+ # Output only. The matter ID of the associated matter. The server does not look
1676
+ # at this field during create and always uses matter id in the URL.
1677
+ # Corresponds to the JSON property `matterId`
1678
+ # @return [String]
1679
+ attr_accessor :matter_id
1680
+
1681
+ # A query definition relevant for search & export.
1682
+ # Corresponds to the JSON property `query`
1683
+ # @return [Google::Apis::VaultV1::Query]
1684
+ attr_accessor :query
1685
+
1686
+ # A unique identifier for the saved query.
1687
+ # Corresponds to the JSON property `savedQueryId`
1688
+ # @return [String]
1689
+ attr_accessor :saved_query_id
1690
+
1691
+ def initialize(**args)
1692
+ update!(**args)
1693
+ end
1694
+
1695
+ # Update properties of this object
1696
+ def update!(**args)
1697
+ @create_time = args[:create_time] if args.key?(:create_time)
1698
+ @display_name = args[:display_name] if args.key?(:display_name)
1699
+ @matter_id = args[:matter_id] if args.key?(:matter_id)
1700
+ @query = args[:query] if args.key?(:query)
1701
+ @saved_query_id = args[:saved_query_id] if args.key?(:saved_query_id)
1702
+ end
1703
+ end
1704
+
1705
+ # Shared drives to search
1706
+ class SharedDriveInfo
1707
+ include Google::Apis::Core::Hashable
1708
+
1709
+ # List of Shared drive IDs, as provided by Drive API.
1710
+ # Corresponds to the JSON property `sharedDriveIds`
1711
+ # @return [Array<String>]
1712
+ attr_accessor :shared_drive_ids
1713
+
1714
+ def initialize(**args)
1715
+ update!(**args)
1716
+ end
1717
+
1718
+ # Update properties of this object
1719
+ def update!(**args)
1720
+ @shared_drive_ids = args[:shared_drive_ids] if args.key?(:shared_drive_ids)
1721
+ end
1722
+ end
1723
+
1724
+ # The `Status` type defines a logical error model that is suitable for different
1725
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1726
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1727
+ # data: error code, error message, and error details. You can find out more
1728
+ # about this error model and how to work with it in the [API Design Guide](https:
1729
+ # //cloud.google.com/apis/design/errors).
1730
+ class Status
1731
+ include Google::Apis::Core::Hashable
1732
+
1733
+ # The status code, which should be an enum value of google.rpc.Code.
1734
+ # Corresponds to the JSON property `code`
1735
+ # @return [Fixnum]
1736
+ attr_accessor :code
1737
+
1738
+ # A list of messages that carry the error details. There is a common set of
1739
+ # message types for APIs to use.
1740
+ # Corresponds to the JSON property `details`
1741
+ # @return [Array<Hash<String,Object>>]
1742
+ attr_accessor :details
1743
+
1744
+ # A developer-facing error message, which should be in English. Any user-facing
1745
+ # error message should be localized and sent in the google.rpc.Status.details
1746
+ # field, or localized by the client.
1747
+ # Corresponds to the JSON property `message`
1748
+ # @return [String]
1749
+ attr_accessor :message
1750
+
1751
+ def initialize(**args)
1752
+ update!(**args)
1753
+ end
1754
+
1755
+ # Update properties of this object
1756
+ def update!(**args)
1757
+ @code = args[:code] if args.key?(:code)
1758
+ @details = args[:details] if args.key?(:details)
1759
+ @message = args[:message] if args.key?(:message)
1760
+ end
1761
+ end
1762
+
1763
+ # Team Drives to search
1764
+ class TeamDriveInfo
1765
+ include Google::Apis::Core::Hashable
1766
+
1767
+ # List of Team Drive IDs, as provided by Drive API.
1768
+ # Corresponds to the JSON property `teamDriveIds`
1769
+ # @return [Array<String>]
1770
+ attr_accessor :team_drive_ids
1771
+
1772
+ def initialize(**args)
1773
+ update!(**args)
1774
+ end
1775
+
1776
+ # Update properties of this object
1777
+ def update!(**args)
1778
+ @team_drive_ids = args[:team_drive_ids] if args.key?(:team_drive_ids)
1779
+ end
1780
+ end
1781
+
1782
+ # Undelete a matter by ID.
1783
+ class UndeleteMatterRequest
1784
+ include Google::Apis::Core::Hashable
1785
+
1786
+ def initialize(**args)
1787
+ update!(**args)
1788
+ end
1789
+
1790
+ # Update properties of this object
1791
+ def update!(**args)
1792
+ end
1793
+ end
1794
+
1795
+ # User's information.
1796
+ class UserInfo
1797
+ include Google::Apis::Core::Hashable
1798
+
1799
+ # The displayed name of the user.
1800
+ # Corresponds to the JSON property `displayName`
1801
+ # @return [String]
1802
+ attr_accessor :display_name
1803
+
1804
+ # The email address of the user.
1805
+ # Corresponds to the JSON property `email`
1806
+ # @return [String]
1807
+ attr_accessor :email
1808
+
1809
+ def initialize(**args)
1810
+ update!(**args)
1811
+ end
1812
+
1813
+ # Update properties of this object
1814
+ def update!(**args)
1815
+ @display_name = args[:display_name] if args.key?(:display_name)
1816
+ @email = args[:email] if args.key?(:email)
1817
+ end
1818
+ end
1819
+
1820
+ # The options for voice export.
1821
+ class VoiceExportOptions
1822
+ include Google::Apis::Core::Hashable
1823
+
1824
+ # The export format for voice export.
1825
+ # Corresponds to the JSON property `exportFormat`
1826
+ # @return [String]
1827
+ attr_accessor :export_format
1828
+
1829
+ def initialize(**args)
1830
+ update!(**args)
1831
+ end
1832
+
1833
+ # Update properties of this object
1834
+ def update!(**args)
1835
+ @export_format = args[:export_format] if args.key?(:export_format)
1836
+ end
1837
+ end
1838
+
1839
+ # Voice search options
1840
+ class VoiceOptions
1841
+ include Google::Apis::Core::Hashable
1842
+
1843
+ # Datatypes to search
1844
+ # Corresponds to the JSON property `coveredData`
1845
+ # @return [Array<String>]
1846
+ attr_accessor :covered_data
1847
+
1848
+ def initialize(**args)
1849
+ update!(**args)
1850
+ end
1851
+
1852
+ # Update properties of this object
1853
+ def update!(**args)
1854
+ @covered_data = args[:covered_data] if args.key?(:covered_data)
1855
+ end
1856
+ end
1857
+ end
1858
+ end
1859
+ end