Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / cloudsearch_v1.stats.index.datasources.html
blob: 844e60a152cf75eed9a7b67ae0581f0008d50c1e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.stats.html">stats</a> . <a href="cloudsearch_v1.stats.index.html">index</a> . <a href="cloudsearch_v1.stats.index.datasources.html">datasources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]78 <code><a href="#get">get(name, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, fromDate_month=None, fromDate_day=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Gets indexed item statistics for a single data source.</p>
80<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]82 <code class="details" id="get">get(name, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, fromDate_month=None, fromDate_day=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>Gets indexed item statistics for a single data source.
84
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85**Note:** This API requires a standard end user account to execute.
86
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87Args:
88 name: string, The resource id of the data source to retrieve statistics for,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]89in the following format: &quot;datasources/{source_id}&quot; (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 fromDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]91 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
92 toDate_month: integer, Month of date. Must be from 1 to 12.
93 toDate_year: integer, Year of date. Must be from 1 to 9999.
94 fromDate_month: integer, Month of date. Must be from 1 to 12.
95 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100
101Returns:
102 An object of the form:
103
104 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]105 &quot;stats&quot;: [ # Summary of indexed item counts, one for each day in the requested range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 { # Aggregation of items by status code as of the specified date.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]107 &quot;date&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which index stats were calculated. If the date of request is not
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 # the current date then stats calculated on the next day are returned. Stats
109 # are calculated close to mid night in this case. If date of request is
110 # current date, then real time stats are returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]111 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
112 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
113 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]115 &quot;itemCountByStatus&quot;: [ # Number of items aggregrated by status code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]117 &quot;count&quot;: &quot;A String&quot;, # Number of items matching the status code.
118 &quot;statusCode&quot;: &quot;A String&quot;, # Status of the items.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 },
120 ],
121 },
122 ],
123 }</pre>
124</div>
125
126</body></html>