17
17
package com .google .api .services .searchconsole .v1 .model ;
18
18
19
19
/**
20
- * Model definition for Metadata.
20
+ * An object that may be returned with your query results, providing context about the state of the
21
+ * data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the
22
+ * rows returned may represent data that is incomplete, which means that the data is still being
23
+ * collected and processed. This metadata object helps you identify exactly when this starts and
24
+ * ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The
25
+ * specific field returned within this object depends on how you've grouped your data in the
26
+ * request. See details in inner fields.
21
27
*
22
28
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
23
29
* transmitted over HTTP when working with the Google Search Console API. For a detailed explanation
31
37
public final class Metadata extends com .google .api .client .json .GenericJson {
32
38
33
39
/**
40
+ * The first date for which the data is still being collected and processed, presented in `YYYY-
41
+ * MM-DD` format (ISO-8601 extended local date format). This field is populated only when the
42
+ * request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range
43
+ * contains incomplete data points. All values after the `first_incomplete_date` may still change
44
+ * noticeably.
34
45
* The value may be {@code null}.
35
46
*/
36
47
@ com .google .api .client .util .Key
37
48
private java .lang .String firstIncompleteDate ;
38
49
39
50
/**
51
+ * The first hour for which the data is still being collected and processed, presented in `YYYY-
52
+ * MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is
53
+ * populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`"
54
+ * and the requested date range contains incomplete data points. All values after the
55
+ * `first_incomplete_hour` may still change noticeably.
40
56
* The value may be {@code null}.
41
57
*/
42
58
@ com .google .api .client .util .Key
43
59
private java .lang .String firstIncompleteHour ;
44
60
45
61
/**
62
+ * The first date for which the data is still being collected and processed, presented in `YYYY-
63
+ * MM-DD` format (ISO-8601 extended local date format). This field is populated only when the
64
+ * request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range
65
+ * contains incomplete data points. All values after the `first_incomplete_date` may still change
66
+ * noticeably.
46
67
* @return value or {@code null} for none
47
68
*/
48
69
public java .lang .String getFirstIncompleteDate () {
49
70
return firstIncompleteDate ;
50
71
}
51
72
52
73
/**
74
+ * The first date for which the data is still being collected and processed, presented in `YYYY-
75
+ * MM-DD` format (ISO-8601 extended local date format). This field is populated only when the
76
+ * request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range
77
+ * contains incomplete data points. All values after the `first_incomplete_date` may still change
78
+ * noticeably.
53
79
* @param firstIncompleteDate firstIncompleteDate or {@code null} for none
54
80
*/
55
81
public Metadata setFirstIncompleteDate (java .lang .String firstIncompleteDate ) {
@@ -58,13 +84,23 @@ public Metadata setFirstIncompleteDate(java.lang.String firstIncompleteDate) {
58
84
}
59
85
60
86
/**
87
+ * The first hour for which the data is still being collected and processed, presented in `YYYY-
88
+ * MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is
89
+ * populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`"
90
+ * and the requested date range contains incomplete data points. All values after the
91
+ * `first_incomplete_hour` may still change noticeably.
61
92
* @return value or {@code null} for none
62
93
*/
63
94
public java .lang .String getFirstIncompleteHour () {
64
95
return firstIncompleteHour ;
65
96
}
66
97
67
98
/**
99
+ * The first hour for which the data is still being collected and processed, presented in `YYYY-
100
+ * MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is
101
+ * populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`"
102
+ * and the requested date range contains incomplete data points. All values after the
103
+ * `first_incomplete_hour` may still change noticeably.
68
104
* @param firstIncompleteHour firstIncompleteHour or {@code null} for none
69
105
*/
70
106
public Metadata setFirstIncompleteHour (java .lang .String firstIncompleteHour ) {
0 commit comments