Files
google-apis-rs/google_vault1_cli/matters_count/index.html
2024-03-05 21:06:01 +01:00

512 lines
21 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-vault1-cli/matters_count/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Count - Vault v5.0.4+20240220</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Count";
var mkdocs_page_input_path = "matters_count.md";
var mkdocs_page_url = "/google-apis-rs/google-vault1-cli/matters_count/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Vault v5.0.4+20240220
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Matters</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../matters_add-permissions/">Add Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_close/">Close</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Count</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_exports-create/">Exports Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_exports-delete/">Exports Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_exports-get/">Exports Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_exports-list/">Exports List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-accounts-create/">Holds Accounts Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-accounts-delete/">Holds Accounts Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-accounts-list/">Holds Accounts List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-add-held-accounts/">Holds Add Held Accounts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-create/">Holds Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-delete/">Holds Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-get/">Holds Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-list/">Holds List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-remove-held-accounts/">Holds Remove Held Accounts</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_holds-update/">Holds Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_remove-permissions/">Remove Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_reopen/">Reopen</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_saved-queries-create/">Saved Queries Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_saved-queries-delete/">Saved Queries Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_saved-queries-get/">Saved Queries Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_saved-queries-list/">Saved Queries List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_undelete/">Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../matters_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_list/">List</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Vault v5.0.4+20240220</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Matters &raquo;</li>
<li>Count</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/vault1-cli/edit/master/docs/matters_count.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Counts the accounts processed by the specified query.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/ediscovery</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/ediscovery</em>.
You can set the scope for this method like this: <code>vault1 --scope &lt;scope&gt; matters count ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;matter-id&gt;</strong> <em>(string)</em><ul>
<li>The matter ID.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>CountArtifactsRequest:
query:
account-info:
emails: [string]
calendar-options:
location-query: [string]
minus-words: [string]
people-query: [string]
response-statuses: [string]
version-date: string
corpus: string
data-scope: string
drive-options:
client-side-encrypted-option: string
include-shared-drives: boolean
include-team-drives: boolean
version-date: string
end-time: string
hangouts-chat-info:
room-id: [string]
hangouts-chat-options:
include-rooms: boolean
mail-options:
client-side-encrypted-option: string
exclude-drafts: boolean
method: string
org-unit-info:
org-unit-id: string
search-method: string
shared-drive-info:
shared-drive-ids: [string]
sites-url-info:
urls: [string]
start-time: string
team-drive-info:
team-drive-ids: [string]
terms: string
time-zone: string
voice-options:
covered-data: [string]
view: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li>
<p><code>-r .query.account-info emails=amet.</code></p>
<ul>
<li>A set of accounts to search.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>..calendar-options location-query=takimata</code></p>
<ul>
<li>Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in &#34;and&#34;. Word splitting example: [&#34;New Zealand&#34;] vs [&#34;New&#34;,&#34;Zealand&#34;] &#34;New Zealand&#34;: matched by both &#34;New and better Zealand&#34;: only matched by the later</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>minus-words=amet.</code><ul>
<li>Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in &#34;or&#34;.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>people-query=duo</code><ul>
<li>Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in &#34;and&#34;.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>response-statuses=ipsum</code><ul>
<li>Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>version-date=gubergren</code></p>
<ul>
<li>Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.</li>
</ul>
</li>
<li>
<p><code>.. corpus=lorem</code></p>
<ul>
<li>The Google Workspace service to search.</li>
</ul>
</li>
<li><code>data-scope=gubergren</code><ul>
<li>The data source to search.</li>
</ul>
</li>
<li><code>drive-options client-side-encrypted-option=eos</code><ul>
<li>Set whether the results include only content encrypted with <a href="https://support.google.com/a?p=cse_ov">Google Workspace Client-side encryption</a> content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.</li>
</ul>
</li>
<li><code>include-shared-drives=true</code><ul>
<li>Set to <strong>true</strong> to include shared drives.</li>
</ul>
</li>
<li><code>include-team-drives=false</code><ul>
<li>Set to true to include Team Drive.</li>
</ul>
</li>
<li>
<p><code>version-date=amet</code></p>
<ul>
<li>Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.</li>
</ul>
</li>
<li>
<p><code>.. end-time=duo</code></p>
<ul>
<li>The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.</li>
</ul>
</li>
<li>
<p><code>hangouts-chat-info room-id=ipsum</code></p>
<ul>
<li>A list of Chat spaces IDs, as provided by the <a href="https://developers.google.com/chat">Chat API</a>. There is a limit of exporting from 500 Chat spaces per request.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>..hangouts-chat-options include-rooms=false</code></p>
<ul>
<li>For searches by account or organizational unit, set to <strong>true</strong> to include rooms.</li>
</ul>
</li>
<li>
<p><code>..mail-options client-side-encrypted-option=ut</code></p>
<ul>
<li>Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.</li>
</ul>
</li>
<li>
<p><code>exclude-drafts=true</code></p>
<ul>
<li>Set to <strong>true</strong> to exclude drafts.</li>
</ul>
</li>
<li>
<p><code>.. method=ipsum</code></p>
<ul>
<li>The entity to search. This field replaces <strong>searchMethod</strong> to support shared drives. When <strong>searchMethod</strong> is <strong>TEAM_DRIVE</strong>, the response of this field is <strong>SHARED_DRIVE</strong>.</li>
</ul>
</li>
<li>
<p><code>org-unit-info org-unit-id=ipsum</code></p>
<ul>
<li>The name of the organizational unit to search, as provided by the <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK Directory API</a>.</li>
</ul>
</li>
<li>
<p><code>.. search-method=est</code></p>
<ul>
<li>The search method to use.</li>
</ul>
</li>
<li>
<p><code>shared-drive-info shared-drive-ids=gubergren</code></p>
<ul>
<li>A list of shared drive IDs, as provided by the <a href="https://developers.google.com/drive">Drive API</a>.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>..sites-url-info urls=ea</code></p>
<ul>
<li>A list of published site URLs.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>.. start-time=dolor</code></p>
<ul>
<li>The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.</li>
</ul>
</li>
<li>
<p><code>team-drive-info team-drive-ids=lorem</code></p>
<ul>
<li>List of Team Drive IDs, as provided by the <a href="https://developers.google.com/drive">Drive API</a>.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>.. terms=eos</code></p>
<ul>
<li>Service-specific <a href="https://support.google.com/vault/answer/2474474">search operators</a> to filter search results.</li>
</ul>
</li>
<li><code>time-zone=labore</code><ul>
<li>The time zone name. It should be an IANA TZ name, such as &#34;America/Los_Angeles&#34;. For a list of time zone names, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time Zone</a>. For more information about how Vault uses time zones, see <a href="https://support.google.com/vault/answer/6092995#time">the Vault help center</a>.</li>
</ul>
</li>
<li>
<p><code>voice-options covered-data=sed</code></p>
<ul>
<li>Datatypes to search</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>... view=duo</code></p>
<ul>
<li>Sets the granularity of the count results.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../matters_close/" class="btn btn-neutral float-left" title="Close"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../matters_create/" class="btn btn-neutral float-right" title="Create">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/vault1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../matters_close/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../matters_create/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>