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

Class IndexStatusInspectionResult

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the [Index coverage report documentation](https://support.google.com/webmasters/answer/7440203).

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

Method Summary

Modifier and Type	Method and Description
IndexStatusInspectionResult	clone()
String	getCoverageState() Could Google find and index the page.
String	getCrawledAs() Primary crawler that was used by Google to crawl your site.
String	getGoogleCanonical() The URL of the page that Google selected as canonical.
String	getIndexingState() Whether or not the page blocks indexing through a noindex rule.
String	getLastCrawlTime() Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler).
String	getPageFetchState() Whether or not Google could retrieve the page from your server.
List<String>	getReferringUrls() URLs that link to the inspected URL, directly and indirectly.
String	getRobotsTxtState() Whether or not the page is blocked to Google by a robots.txt rule.
List<String>	getSitemap() Any sitemaps that this URL was listed in, as known by Google.
String	getUserCanonical() The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate- urls?#define-canonical).
String	getVerdict() High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).
IndexStatusInspectionResult	set(String fieldName, Object value)
IndexStatusInspectionResult	setCoverageState(String coverageState) Could Google find and index the page.
IndexStatusInspectionResult	setCrawledAs(String crawledAs) Primary crawler that was used by Google to crawl your site.
IndexStatusInspectionResult	setGoogleCanonical(String googleCanonical) The URL of the page that Google selected as canonical.
IndexStatusInspectionResult	setIndexingState(String indexingState) Whether or not the page blocks indexing through a noindex rule.
IndexStatusInspectionResult	setLastCrawlTime(String lastCrawlTime) Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler).
IndexStatusInspectionResult	setPageFetchState(String pageFetchState) Whether or not Google could retrieve the page from your server.
IndexStatusInspectionResult	setReferringUrls(List<String> referringUrls) URLs that link to the inspected URL, directly and indirectly.
IndexStatusInspectionResult	setRobotsTxtState(String robotsTxtState) Whether or not the page is blocked to Google by a robots.txt rule.
IndexStatusInspectionResult	setSitemap(List<String> sitemap) Any sitemaps that this URL was listed in, as known by Google.
IndexStatusInspectionResult	setUserCanonical(String userCanonical) The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate- urls?#define-canonical).
IndexStatusInspectionResult	setVerdict(String verdict) High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).

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

IndexStatusInspectionResult

public IndexStatusInspectionResult()

Method Detail

getCoverageState

public String getCoverageState()

Could Google find and index the page. More details about page indexing appear in 'indexing_state'.

Returns:

value or null for none

setCoverageState

public IndexStatusInspectionResult setCoverageState(String coverageState)

Could Google find and index the page. More details about page indexing appear in 'indexing_state'.

Parameters:

coverageState - coverageState or null for none

getCrawledAs

public String getCrawledAs()

Primary crawler that was used by Google to crawl your site.

Returns:

value or null for none

setCrawledAs

public IndexStatusInspectionResult setCrawledAs(String crawledAs)

Primary crawler that was used by Google to crawl your site.

Parameters:

crawledAs - crawledAs or null for none

getGoogleCanonical

public String getGoogleCanonical()

The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.

Returns:

value or null for none

setGoogleCanonical

public IndexStatusInspectionResult setGoogleCanonical(String googleCanonical)

The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.

Parameters:

googleCanonical - googleCanonical or null for none

getIndexingState

public String getIndexingState()

Whether or not the page blocks indexing through a noindex rule.

Returns:

value or null for none

setIndexingState

public IndexStatusInspectionResult setIndexingState(String indexingState)

Whether or not the page blocks indexing through a noindex rule.

Parameters:

indexingState - indexingState or null for none

getLastCrawlTime

public String getLastCrawlTime()

Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.

Returns:

value or null for none

setLastCrawlTime

public IndexStatusInspectionResult setLastCrawlTime(String lastCrawlTime)

Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.

Parameters:

lastCrawlTime - lastCrawlTime or null for none

getPageFetchState

public String getPageFetchState()

Whether or not Google could retrieve the page from your server. Equivalent to ["page fetch"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.

Returns:

value or null for none

setPageFetchState

public IndexStatusInspectionResult setPageFetchState(String pageFetchState)

Whether or not Google could retrieve the page from your server. Equivalent to ["page fetch"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.

Parameters:

pageFetchState - pageFetchState or null for none

getReferringUrls

public List<String> getReferringUrls()

URLs that link to the inspected URL, directly and indirectly.

Returns:

value or null for none

setReferringUrls

public IndexStatusInspectionResult setReferringUrls(List<String> referringUrls)

URLs that link to the inspected URL, directly and indirectly.

Parameters:

referringUrls - referringUrls or null for none

getRobotsTxtState

public String getRobotsTxtState()

Whether or not the page is blocked to Google by a robots.txt rule.

Returns:

value or null for none

setRobotsTxtState

public IndexStatusInspectionResult setRobotsTxtState(String robotsTxtState)

Whether or not the page is blocked to Google by a robots.txt rule.

Parameters:

robotsTxtState - robotsTxtState or null for none

getSitemap

public List<String> getSitemap()

Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.

Returns:

value or null for none

setSitemap

public IndexStatusInspectionResult setSitemap(List<String> sitemap)

Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.

Parameters:

sitemap - sitemap or null for none

getUserCanonical

public String getUserCanonical()

The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate- urls?#define-canonical). If you did not declare a canonical URL, this field is absent.

Returns:

value or null for none

setUserCanonical

public IndexStatusInspectionResult setUserCanonical(String userCanonical)

The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate- urls?#define-canonical). If you did not declare a canonical URL, this field is absent.

Parameters:

userCanonical - userCanonical or null for none

getVerdict

public String getVerdict()

High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).

Returns:

value or null for none

setVerdict

public IndexStatusInspectionResult setVerdict(String verdict)

High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).

Parameters:

verdict - verdict or null for none

set

public IndexStatusInspectionResult set(String fieldName,
                                       Object value)

Overrides:

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

clone

public IndexStatusInspectionResult clone()

Overrides:

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