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(java.lang.String key)
SheetsRequestInitializer(java.lang.String key, java.lang.String userIp)

Method Summary

Methods

Modifier and Type	Method and Description
void	initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
protected void	initializeSheetsRequest(SheetsRequest<?> request) Initializes Sheets 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, getUserIp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SheetsRequestInitializer

public SheetsRequestInitializer()

SheetsRequestInitializer

public SheetsRequestInitializer(java.lang.String key)

Parameters:

key - API key or null to leave it unchanged

SheetsRequestInitializer

public SheetsRequestInitializer(java.lang.String key,
                        java.lang.String userIp)

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

Method Detail

initializeJsonRequest

public final void initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
                                 throws java.io.IOException

Overrides:

initializeJsonRequest in class com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

Throws:

java.io.IOException

initializeSheetsRequest

protected void initializeSheetsRequest(SheetsRequest<?> request)
                                throws java.io.IOException

Initializes Sheets request.

Default implementation does nothing. Called from initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest).

Throws:

java.io.IOException - I/O exception