com.google.api.services.webmasters

Class Webmasters.Sites.Get

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.webmasters.WebmastersRequest<WmxSite>

com.google.api.services.webmasters.Webmasters.Sites.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Webmasters.Sites

public class Webmasters.Sites.Get
extends WebmastersRequest<WmxSite>

Nested Class Summary

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

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String siteUrl) Retrieves information about specific site.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getSiteUrl() The URI of the property as defined in Search Console.
Webmasters.Sites.Get	set(String parameterName, Object value)
Webmasters.Sites.Get	setAlt(String alt) Data format for the response.
Webmasters.Sites.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Webmasters.Sites.Get	setKey(String key) API key.
Webmasters.Sites.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Webmasters.Sites.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Webmasters.Sites.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Webmasters.Sites.Get	setSiteUrl(String siteUrl) The URI of the property as defined in Search Console.
Webmasters.Sites.Get	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.webmasters.WebmastersRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

Get

protected Get(String siteUrl)

Retrieves information about specific site. Create a request for the method "sites.get". This request holds the parameters needed by the the webmasters server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Webmasters.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

siteUrl - The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android- app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<WmxSite>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<WmxSite>

Throws:

IOException

setAlt

public Webmasters.Sites.Get setAlt(String alt)

Description copied from class: WebmastersRequest

Data format for the response.

Overrides:

setAlt in class WebmastersRequest<WmxSite>

setFields

public Webmasters.Sites.Get setFields(String fields)

Description copied from class: WebmastersRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class WebmastersRequest<WmxSite>

setKey

public Webmasters.Sites.Get setKey(String key)

Description copied from class: WebmastersRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class WebmastersRequest<WmxSite>

setOauthToken

public Webmasters.Sites.Get setOauthToken(String oauthToken)

Description copied from class: WebmastersRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class WebmastersRequest<WmxSite>

setPrettyPrint

public Webmasters.Sites.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: WebmastersRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class WebmastersRequest<WmxSite>

setQuotaUser

public Webmasters.Sites.Get setQuotaUser(String quotaUser)

Description copied from class: WebmastersRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class WebmastersRequest<WmxSite>

setUserIp

public Webmasters.Sites.Get setUserIp(String userIp)

Description copied from class: WebmastersRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class WebmastersRequest<WmxSite>

getSiteUrl

public String getSiteUrl()

The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android- app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

setSiteUrl

public Webmasters.Sites.Get setSiteUrl(String siteUrl)

The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

set

public Webmasters.Sites.Get set(String parameterName,
                                Object value)

Overrides:

set in class WebmastersRequest<WmxSite>