com.google.api.services.searchconsole.v1.model

Class Metadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.searchconsole.v1.model.Metadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Metadata
extends com.google.api.client.json.GenericJson

An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Search Console API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Metadata()

Method Summary

Modifier and Type	Method and Description
Metadata	clone()
String	getFirstIncompleteDate() The first date for which the data is still being collected and processed, presented in `YYYY- MM-DD` format (ISO-8601 extended local date format).
String	getFirstIncompleteHour() The first hour for which the data is still being collected and processed, presented in `YYYY- MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format).
Metadata	set(String fieldName, Object value)
Metadata	setFirstIncompleteDate(String firstIncompleteDate) The first date for which the data is still being collected and processed, presented in `YYYY- MM-DD` format (ISO-8601 extended local date format).
Metadata	setFirstIncompleteHour(String firstIncompleteHour) The first hour for which the data is still being collected and processed, presented in `YYYY- MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format).

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Metadata

public Metadata()

Method Detail

getFirstIncompleteDate

public String getFirstIncompleteDate()

The first date for which the data is still being collected and processed, presented in `YYYY- MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.

Returns:

value or null for none

setFirstIncompleteDate

public Metadata setFirstIncompleteDate(String firstIncompleteDate)

The first date for which the data is still being collected and processed, presented in `YYYY- MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.

Parameters:

firstIncompleteDate - firstIncompleteDate or null for none

getFirstIncompleteHour

public String getFirstIncompleteHour()

The first hour for which the data is still being collected and processed, presented in `YYYY- MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably.

Returns:

value or null for none

setFirstIncompleteHour

public Metadata setFirstIncompleteHour(String firstIncompleteHour)

The first hour for which the data is still being collected and processed, presented in `YYYY- MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably.

Parameters:

firstIncompleteHour - firstIncompleteHour or null for none

set

public Metadata set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Metadata clone()

Overrides:

clone in class com.google.api.client.json.GenericJson