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

Class SearchAnalyticsQueryResponse

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.SearchAnalyticsQueryResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.

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
SearchAnalyticsQueryResponse()

Method Summary

Modifier and Type	Method and Description
SearchAnalyticsQueryResponse	clone()
Metadata	getMetadata() An object that may be returned with your query results, providing context about the state of the data.
String	getResponseAggregationType() How the results were aggregated.
List<ApiDataRow>	getRows() A list of rows grouped by the key values in the order given in the query.
SearchAnalyticsQueryResponse	set(String fieldName, Object value)
SearchAnalyticsQueryResponse	setMetadata(Metadata metadata) An object that may be returned with your query results, providing context about the state of the data.
SearchAnalyticsQueryResponse	setResponseAggregationType(String responseAggregationType) How the results were aggregated.
SearchAnalyticsQueryResponse	setRows(List<ApiDataRow> rows) A list of rows grouped by the key values in the order given in the query.

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

SearchAnalyticsQueryResponse

public SearchAnalyticsQueryResponse()

Method Detail

getMetadata

public Metadata getMetadata()

An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation.

Returns:

value or null for none

setMetadata

public SearchAnalyticsQueryResponse setMetadata(Metadata metadata)

An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation.

Parameters:

metadata - metadata or null for none

getResponseAggregationType

public String getResponseAggregationType()

How the results were aggregated.

Returns:

value or null for none

setResponseAggregationType

public SearchAnalyticsQueryResponse setResponseAggregationType(String responseAggregationType)

How the results were aggregated.

Parameters:

responseAggregationType - responseAggregationType or null for none

getRows

public List<ApiDataRow> getRows()

A list of rows grouped by the key values in the order given in the query.

Returns:

value or null for none

setRows

public SearchAnalyticsQueryResponse setRows(List<ApiDataRow> rows)

A list of rows grouped by the key values in the order given in the query.

Parameters:

rows - rows or null for none

set

public SearchAnalyticsQueryResponse set(String fieldName,
                                        Object value)

Overrides:

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

clone

public SearchAnalyticsQueryResponse clone()

Overrides:

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