target.apidocs.com.google.api.services.sheets.v4.SheetsRequestInitializer.html Maven / Gradle / Ivy
SheetsRequestInitializer (Google Sheets API v4-rev20240312-2.0.0)
com.google.api.services.sheets.v4
Class SheetsRequestInitializer
- java.lang.Object
-
- com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer
-
- com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
-
- com.google.api.services.sheets.v4.SheetsRequestInitializer
-
- All Implemented Interfaces:
- com.google.api.client.googleapis.services.GoogleClientRequestInitializer
public class SheetsRequestInitializer
extends com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
Sheets 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 SheetsRequestInitializer(KEY);
There is also a constructor to set both the key and userIp parameters:
public static final GoogleClientRequestInitializer INITIALIZER =
new SheetsRequestInitializer(KEY, USER_IP);
If you want to implement custom logic, extend it like this:
public static class MyRequestInitializer extends SheetsRequestInitializer {
@Override
public void initializeSheetsRequest(SheetsRequest <? > 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 SheetsRequestInitializer {
public MyKeyRequestInitializer() {
super(KEY, USER_IP);
}
@Override
public void initializeSheetsRequest(SheetsRequest <? > request)
throws IOException {
// custom logic
}
}
Subclasses should be thread-safe.
- Since:
- 1.12
-
-
Constructor Summary
Constructors
Constructor and Description
SheetsRequestInitializer()
SheetsRequestInitializer(String key)
SheetsRequestInitializer(String key,
String userIp)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
voidinitializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
protected voidinitializeSheetsRequest(SheetsRequest<?> request)
Initializes Sheets request.
-
Methods inherited from class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer
initialize
-
-
Constructor Detail
-
SheetsRequestInitializer
public SheetsRequestInitializer()
-
SheetsRequestInitializer
public SheetsRequestInitializer(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
-
initializeSheetsRequest
protected void initializeSheetsRequest(SheetsRequest<?> request)
throws IOException
Initializes Sheets 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.