com.google.api.services.webmasters

Class Webmasters.Sitemaps.Submit

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<Void>

com.google.api.services.webmasters.Webmasters.Sitemaps.Submit

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Webmasters.Sitemaps

public class Webmasters.Sitemaps.Submit
extends WebmastersRequest<Void>

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	Submit(String siteUrl, String feedpath) Submits a sitemap for a site.

Method Summary

Modifier and Type	Method and Description
String	getFeedpath() The URL of the sitemap to add.
String	getSiteUrl() The site's URL, including protocol.
Webmasters.Sitemaps.Submit	set(String parameterName, Object value)
Webmasters.Sitemaps.Submit	setAlt(String alt) Data format for the response.
Webmasters.Sitemaps.Submit	setFeedpath(String feedpath) The URL of the sitemap to add.
Webmasters.Sitemaps.Submit	setFields(String fields) Selector specifying which fields to include in a partial response.
Webmasters.Sitemaps.Submit	setKey(String key) API key.
Webmasters.Sitemaps.Submit	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Webmasters.Sitemaps.Submit	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Webmasters.Sitemaps.Submit	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Webmasters.Sitemaps.Submit	setSiteUrl(String siteUrl) The site's URL, including protocol.
Webmasters.Sitemaps.Submit	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Submit

protected Submit(String siteUrl,
                 String feedpath)

Submits a sitemap for a site. Create a request for the method "sitemaps.submit". 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 site's URL, including protocol. For example: http://www.example.com/

feedpath - The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

Since:

1.13

Method Detail

setAlt

public Webmasters.Sitemaps.Submit setAlt(String alt)

Description copied from class: WebmastersRequest

Data format for the response.

Overrides:

setAlt in class WebmastersRequest<Void>

setFields

public Webmasters.Sitemaps.Submit setFields(String fields)

Description copied from class: WebmastersRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class WebmastersRequest<Void>

setKey

public Webmasters.Sitemaps.Submit 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<Void>

setOauthToken

public Webmasters.Sitemaps.Submit setOauthToken(String oauthToken)

Description copied from class: WebmastersRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class WebmastersRequest<Void>

setPrettyPrint

public Webmasters.Sitemaps.Submit setPrettyPrint(Boolean prettyPrint)

Description copied from class: WebmastersRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class WebmastersRequest<Void>

setQuotaUser

public Webmasters.Sitemaps.Submit 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<Void>

setUserIp

public Webmasters.Sitemaps.Submit setUserIp(String userIp)

Description copied from class: WebmastersRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class WebmastersRequest<Void>

getSiteUrl

public String getSiteUrl()

The site's URL, including protocol. For example: http://www.example.com/

setSiteUrl

public Webmasters.Sitemaps.Submit setSiteUrl(String siteUrl)

The site's URL, including protocol. For example: http://www.example.com/

getFeedpath

public String getFeedpath()

The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

setFeedpath

public Webmasters.Sitemaps.Submit setFeedpath(String feedpath)

The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

set

public Webmasters.Sitemaps.Submit set(String parameterName,
                                      Object value)

Overrides:

set in class WebmastersRequest<Void>