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

Class AbstractGoogleJsonClient.Builder

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient.Builder

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

Direct Known Subclasses:

MockGoogleJsonClient.Builder

Enclosing class:

AbstractGoogleJsonClient

public abstract static class AbstractGoogleJsonClient.Builder
extends AbstractGoogleClient.Builder

Builder for AbstractGoogleJsonClient.

Implementation is not thread-safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGoogleJsonClient.Builder(HttpTransport transport, JsonFactory jsonFactory, String rootUrl, String servicePath, HttpRequestInitializer httpRequestInitializer, boolean legacyDataWrapper)

Method Summary

Methods

Modifier and Type	Method and Description
abstract AbstractGoogleJsonClient	build() Builds a new instance of AbstractGoogleClient.
JsonFactory	getJsonFactory() Returns the JSON Factory.
JsonObjectParser	getObjectParser() Returns the object parser or null for none.
AbstractGoogleJsonClient.Builder	setApplicationName(String applicationName) Sets the application name to be used in the UserAgent header of each request or null for none.
AbstractGoogleJsonClient.Builder	setGoogleClientRequestInitializer(GoogleClientRequestInitializer googleClientRequestInitializer) Sets the Google client request initializer or null for none.
AbstractGoogleJsonClient.Builder	setHttpRequestInitializer(HttpRequestInitializer httpRequestInitializer) Sets the HTTP request initializer or null for none.
AbstractGoogleJsonClient.Builder	setRootUrl(String rootUrl) Sets the URL-encoded root URL of the service, for example https://www.googleapis.com/ .
AbstractGoogleJsonClient.Builder	setServicePath(String servicePath) Sets the URL-encoded service path of the service, for example "tasks/v1/".
AbstractGoogleJsonClient.Builder	setSuppressAllChecks(boolean suppressAllChecks) Suppresses all discovery pattern and required parameter checks.
AbstractGoogleJsonClient.Builder	setSuppressPatternChecks(boolean suppressPatternChecks) Sets whether discovery pattern checks should be suppressed on required parameters.
AbstractGoogleJsonClient.Builder	setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks) Sets whether discovery required parameter checks should be suppressed.

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient.Builder

getApplicationName, getGoogleClientRequestInitializer, getHttpRequestInitializer, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks, getTransport

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGoogleJsonClient.Builder

protected AbstractGoogleJsonClient.Builder(HttpTransport transport,
                                JsonFactory jsonFactory,
                                String rootUrl,
                                String servicePath,
                                HttpRequestInitializer httpRequestInitializer,
                                boolean legacyDataWrapper)

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

rootUrl - root URL of the service

servicePath - service path

httpRequestInitializer - HTTP request initializer or null for none

legacyDataWrapper - whether using the legacy data wrapper in responses

Method Detail

getObjectParser

public final JsonObjectParser getObjectParser()

Description copied from class: AbstractGoogleClient.Builder

Returns the object parser or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

getObjectParser in class AbstractGoogleClient.Builder

getJsonFactory

public final JsonFactory getJsonFactory()

Returns the JSON Factory.

build

public abstract AbstractGoogleJsonClient build()

Description copied from class: AbstractGoogleClient.Builder

Builds a new instance of AbstractGoogleClient.

Specified by:

build in class AbstractGoogleClient.Builder

setRootUrl

public AbstractGoogleJsonClient.Builder setRootUrl(String rootUrl)

Description copied from class: AbstractGoogleClient.Builder

Sets the URL-encoded root URL of the service, for example https://www.googleapis.com/ .

If the specified root URL does not end with a "/" then a "/" is added to the end.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setRootUrl in class AbstractGoogleClient.Builder

setServicePath

public AbstractGoogleJsonClient.Builder setServicePath(String servicePath)

Description copied from class: AbstractGoogleClient.Builder

Sets the URL-encoded service path of the service, for example "tasks/v1/".

It is allowed to be an empty string "" or a forward slash "/", if it is a forward slash then it is treated as an empty string. This is determined when the library is generated and normally should not be changed.

If the specified service path does not end with a "/" then a "/" is added to the end. If the specified service path begins with a "/" then the "/" is removed.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setServicePath in class AbstractGoogleClient.Builder

setGoogleClientRequestInitializer

public AbstractGoogleJsonClient.Builder setGoogleClientRequestInitializer(GoogleClientRequestInitializer googleClientRequestInitializer)

Description copied from class: AbstractGoogleClient.Builder

Sets the Google client request initializer or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setGoogleClientRequestInitializer in class AbstractGoogleClient.Builder

setHttpRequestInitializer

public AbstractGoogleJsonClient.Builder setHttpRequestInitializer(HttpRequestInitializer httpRequestInitializer)

Description copied from class: AbstractGoogleClient.Builder

Sets the HTTP request initializer or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setHttpRequestInitializer in class AbstractGoogleClient.Builder

setApplicationName

public AbstractGoogleJsonClient.Builder setApplicationName(String applicationName)

Description copied from class: AbstractGoogleClient.Builder

Sets the application name to be used in the UserAgent header of each request or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setApplicationName in class AbstractGoogleClient.Builder

setSuppressPatternChecks

public AbstractGoogleJsonClient.Builder setSuppressPatternChecks(boolean suppressPatternChecks)

Description copied from class: AbstractGoogleClient.Builder

Sets whether discovery pattern checks should be suppressed on required parameters.

Default value is false.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setSuppressPatternChecks in class AbstractGoogleClient.Builder

setSuppressRequiredParameterChecks

public AbstractGoogleJsonClient.Builder setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks)

Description copied from class: AbstractGoogleClient.Builder

Sets whether discovery required parameter checks should be suppressed.

Default value is false.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setSuppressRequiredParameterChecks in class AbstractGoogleClient.Builder

setSuppressAllChecks

public AbstractGoogleJsonClient.Builder setSuppressAllChecks(boolean suppressAllChecks)

Description copied from class: AbstractGoogleClient.Builder

Suppresses all discovery pattern and required parameter checks.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setSuppressAllChecks in class AbstractGoogleClient.Builder