com.google.api.services.spanner.v1

Class SpannerRequestInitializer

java.lang.Object

com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

com.google.api.services.spanner.v1.SpannerRequestInitializer

All Implemented Interfaces:

com.google.api.client.googleapis.services.GoogleClientRequestInitializer

public class SpannerRequestInitializer
extends com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

Spanner 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 SpannerRequestInitializer(KEY);
 

There is also a constructor to set both the key and userIp parameters:

  public static final GoogleClientRequestInitializer INITIALIZER =
      new SpannerRequestInitializer(KEY, USER_IP);
 

If you want to implement custom logic, extend it like this:

  public static class MyRequestInitializer extends SpannerRequestInitializer {

     @Override
    public void initializeSpannerRequest(SpannerRequest <? > 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 SpannerRequestInitializer {

    public MyKeyRequestInitializer() {
      super(KEY, USER_IP);
    }

     @Override
    public void initializeSpannerRequest(SpannerRequest <? > 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

com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer.Builder

Constructor Summary

Constructors

Constructor and Description
SpannerRequestInitializer()
SpannerRequestInitializer(String key)
SpannerRequestInitializer(String key, String userIp)

Method Summary

Modifier and Type	Method and Description
void	initializeJsonRequest(com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<?> request)
protected void	initializeSpannerRequest(SpannerRequest<?> request) Initializes Spanner 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

Methods inherited from class java.lang.Object

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

Constructor Detail

SpannerRequestInitializer

public SpannerRequestInitializer()

SpannerRequestInitializer

public SpannerRequestInitializer(String key)

Parameters:

key - API key or null to leave it unchanged

SpannerRequestInitializer

public SpannerRequestInitializer(String key,
                                 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 IOException

Overrides:

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

Throws:

IOException

initializeSpannerRequest

protected void initializeSpannerRequest(SpannerRequest<?> request)
                                 throws IOException

Initializes Spanner request.

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

Throws:

IOException - I/O exception