com.google.api.services.cloudbuild.v2

Class CloudBuildRequestInitializer

java.lang.Object

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

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

com.google.api.services.cloudbuild.v2.CloudBuildRequestInitializer

All Implemented Interfaces:

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

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

CloudBuild 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 CloudBuildRequestInitializer(KEY);
 

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

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

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

  public static class MyRequestInitializer extends CloudBuildRequestInitializer {

     @Override
    public void initializeCloudBuildRequest(CloudBuildRequest <? > 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 CloudBuildRequestInitializer {

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

     @Override
    public void initializeCloudBuildRequest(CloudBuildRequest <? > 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
CloudBuildRequestInitializer()
CloudBuildRequestInitializer(String key)
CloudBuildRequestInitializer(String key, String userIp)

Method Summary

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

CloudBuildRequestInitializer

public CloudBuildRequestInitializer()

CloudBuildRequestInitializer

public CloudBuildRequestInitializer(String key)

Parameters:

key - API key or null to leave it unchanged

CloudBuildRequestInitializer

public CloudBuildRequestInitializer(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

initializeCloudBuildRequest

protected void initializeCloudBuildRequest(CloudBuildRequest<?> request)
                                    throws IOException

Initializes CloudBuild request.

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

Throws:

IOException - I/O exception