target.apidocs.com.google.api.services.webmasters.Webmasters.Sitemaps.Get.html Maven / Gradle / Ivy
Webmasters.Sitemaps.Get (Search Console API v3-rev20190428-1.30.1)
com.google.api.services.webmasters
Class Webmasters.Sitemaps.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<WmxSitemap>
-
- com.google.api.services.webmasters.Webmasters.Sitemaps.Get
-
- Enclosing class:
- Webmasters.Sitemaps
public class Webmasters.Sitemaps.Get
extends WebmastersRequest<WmxSitemap>
-
-
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>
-
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,
String feedpath)
Retrieves information about a specific sitemap.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
HttpRequest
buildHttpRequestUsingHead()
HttpResponse
executeUsingHead()
String
getFeedpath()
The URL of the actual sitemap.
String
getSiteUrl()
The site's URL, including protocol.
Webmasters.Sitemaps.Get
set(String parameterName,
Object value)
Webmasters.Sitemaps.Get
setAlt(String alt)
Data format for the response.
Webmasters.Sitemaps.Get
setFeedpath(String feedpath)
The URL of the actual sitemap.
Webmasters.Sitemaps.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
Webmasters.Sitemaps.Get
setKey(String key)
API key.
Webmasters.Sitemaps.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Webmasters.Sitemaps.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Webmasters.Sitemaps.Get
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Webmasters.Sitemaps.Get
setSiteUrl(String siteUrl)
The site's URL, including protocol.
Webmasters.Sitemaps.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,
String feedpath)
Retrieves information about a specific sitemap.
Create a request for the method "sitemaps.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 site's URL, including protocol. For example: http://www.example.com/
feedpath
- The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class AbstractGoogleClientRequest<WmxSitemap>
- Throws:
IOException
-
buildHttpRequestUsingHead
public HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class AbstractGoogleClientRequest<WmxSitemap>
- Throws:
IOException
-
setAlt
public Webmasters.Sitemaps.Get setAlt(String alt)
Description copied from class: WebmastersRequest
Data format for the response.
- Overrides:
setAlt
in class WebmastersRequest<WmxSitemap>
-
setFields
public Webmasters.Sitemaps.Get setFields(String fields)
Description copied from class: WebmastersRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class WebmastersRequest<WmxSitemap>
-
setKey
public Webmasters.Sitemaps.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<WmxSitemap>
-
setOauthToken
public Webmasters.Sitemaps.Get setOauthToken(String oauthToken)
Description copied from class: WebmastersRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class WebmastersRequest<WmxSitemap>
-
setPrettyPrint
public Webmasters.Sitemaps.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: WebmastersRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class WebmastersRequest<WmxSitemap>
-
setQuotaUser
public Webmasters.Sitemaps.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<WmxSitemap>
-
setUserIp
public Webmasters.Sitemaps.Get setUserIp(String userIp)
Description copied from class: WebmastersRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class WebmastersRequest<WmxSitemap>
-
getSiteUrl
public String getSiteUrl()
The site's URL, including protocol. For example: http://www.example.com/
-
setSiteUrl
public Webmasters.Sitemaps.Get setSiteUrl(String siteUrl)
The site's URL, including protocol. For example: http://www.example.com/
-
getFeedpath
public String getFeedpath()
The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
-
setFeedpath
public Webmasters.Sitemaps.Get setFeedpath(String feedpath)
The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
-
set
public Webmasters.Sitemaps.Get set(String parameterName,
Object value)
- Overrides:
set
in class WebmastersRequest<WmxSitemap>
Copyright © 2011–2019 Google. All rights reserved.