target.apidocs.com.google.api.services.customsearch.v1.CustomSearchAPIRequestInitializer.html Maven / Gradle / Ivy
The newest version!
CustomSearchAPIRequestInitializer (Custom Search API v1-rev20240821-2.0.0)
com.google.api.services.customsearch.v1
Class CustomSearchAPIRequestInitializer
- java.lang.Object
-
- com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
-
- com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
-
- com.google.api.services.customsearch.v1.CustomSearchAPIRequestInitializer
-
- All Implemented Interfaces:
- com.google.api.client.googleapis.services.GoogleClientRequestInitializer
public class CustomSearchAPIRequestInitializer
extends com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
CustomSearchAPI 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 CustomSearchAPIRequestInitializer(KEY);
There is also a constructor to set both the key and userIp parameters:
public static final GoogleClientRequestInitializer INITIALIZER =
new CustomSearchAPIRequestInitializer(KEY, USER_IP);
If you want to implement custom logic, extend it like this:
public static class MyRequestInitializer extends CustomSearchAPIRequestInitializer {
@Override
public void initializeCustomSearchAPIRequest(CustomSearchAPIRequest <? > 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 CustomSearchAPIRequestInitializer {
public MyKeyRequestInitializer() {
super(KEY, USER_IP);
}
@Override
public void initializeCustomSearchAPIRequest(CustomSearchAPIRequest <? > request)
throws IOException {
// custom logic
}
}
Subclasses should be thread-safe.
- Since:
- 1.12
-
-
Constructor Summary
Constructors
Constructor and Description
CustomSearchAPIRequestInitializer()
CustomSearchAPIRequestInitializer(String key)
CustomSearchAPIRequestInitializer(String key,
String userIp)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
protected voidinitializeCustomSearchAPIRequest(CustomSearchAPIRequest<?> request)
Initializes CustomSearchAPI request.
voidinitializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
-
Methods inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
initialize
-
-
Constructor Detail
-
CustomSearchAPIRequestInitializer
public CustomSearchAPIRequestInitializer()
-
CustomSearchAPIRequestInitializer
public CustomSearchAPIRequestInitializer(String key)
- Parameters:
key - API key or null to leave it unchanged
-
Method Detail
-
initializeJsonRequest
public final void initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
throws IOException
- Overrides:
initializeJsonRequest in class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer- Throws:
IOException
-
initializeCustomSearchAPIRequest
protected void initializeCustomSearchAPIRequest(CustomSearchAPIRequest<?> request)
throws IOException
Initializes CustomSearchAPI request.
Default implementation does nothing. Called from
initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest).
- Throws:
IOException - I/O exception
Copyright © 2011–2024 Google. All rights reserved.