target.apidocs.com.google.api.services.webmasters.WebmastersRequestInitializer.html Maven / Gradle / Ivy
WebmastersRequestInitializer (Search Console API v3-rev20190428-1.30.1)
com.google.api.services.webmasters
Class WebmastersRequestInitializer
- java.lang.Object
-
- com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
-
- com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
-
- com.google.api.services.webmasters.WebmastersRequestInitializer
-
- All Implemented Interfaces:
- GoogleClientRequestInitializer
public class WebmastersRequestInitializer
extends CommonGoogleJsonClientRequestInitializer
Webmasters request initializer for setting properties like key and userIp.
The simplest usage is to use it to set the key parameter:
public static final GoogleClientRequestInitializer KEY_INITIALIZER =
new WebmastersRequestInitializer(KEY);
There is also a constructor to set both the key and userIp parameters:
public static final GoogleClientRequestInitializer INITIALIZER =
new WebmastersRequestInitializer(KEY, USER_IP);
If you want to implement custom logic, extend it like this:
public static class MyRequestInitializer extends WebmastersRequestInitializer {
@Override
public void initializeWebmastersRequest(WebmastersRequest <? > request)
throws IOException {
// custom logic
}
}
Finally, to set the key and userIp parameters and insert custom logic, extend it like this:
public static class MyRequestInitializer2 extends WebmastersRequestInitializer {
public MyKeyRequestInitializer() {
super(KEY, USER_IP);
}
@Override
public void initializeWebmastersRequest(WebmastersRequest <? > request)
throws IOException {
// custom logic
}
}
Subclasses should be thread-safe.
- Since:
- 1.12
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
CommonGoogleJsonClientRequestInitializer.Builder
-
Constructor Summary
Constructors
Constructor and Description
WebmastersRequestInitializer()
WebmastersRequestInitializer(String key)
WebmastersRequestInitializer(String key,
String userIp)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
voidinitializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
protected voidinitializeWebmastersRequest(WebmastersRequest<?> request)
Initializes Webmasters request.
-
Methods inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
initialize
-
Methods inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
getKey, getRequestReason, getUserAgent, getUserIp, getUserProject, newBuilder
-
-
Constructor Detail
-
WebmastersRequestInitializer
public WebmastersRequestInitializer()
-
WebmastersRequestInitializer
public WebmastersRequestInitializer(String key)
- Parameters:
key - API key or null to leave it unchanged
-
Method Detail
-
initializeJsonRequest
public final void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
throws IOException
- Overrides:
initializeJsonRequest in class CommonGoogleJsonClientRequestInitializer- Throws:
IOException
-
initializeWebmastersRequest
protected void initializeWebmastersRequest(WebmastersRequest<?> request)
throws IOException
Initializes Webmasters request.
Default implementation does nothing. Called from
initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest).
- Throws:
IOException - I/O exception
Copyright © 2011–2019 Google. All rights reserved.