AbstractGoogleClient.Builder (google-api-java-client 2.1.1)

java.lang.Object
- com.google.api.client.googleapis.services.AbstractGoogleClient.Builder

Direct Known Subclasses:

AbstractGoogleJsonClient.Builder, AbstractGoogleProtoClient.Builder, MockGoogleClient.Builder

Enclosing class:

AbstractGoogleClient
```
public abstract static class AbstractGoogleClient.Builder
extends Object
```
Builder for AbstractGoogleClient.
Implementation is not thread-safe.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Builder(HttpTransport transport, String rootUrl, String servicePath, ObjectParser objectParser, HttpRequestInitializer httpRequestInitializer)` Returns an instance of a new builder.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract AbstractGoogleClient`	`build()` Builds a new instance of `AbstractGoogleClient`.
`String`	`getApplicationName()` Returns the application name to be used in the UserAgent header of each request or `null` for none.
`GoogleClientRequestInitializer`	`getGoogleClientRequestInitializer()` Returns the Google client request initializer or `null` for none.
`HttpRequestInitializer`	`getHttpRequestInitializer()` Returns the HTTP request initializer or `null` for none.
`ObjectParser`	`getObjectParser()` Returns the object parser or `null` for none.
`String`	`getRootUrl()` Returns the URL-encoded root URL of the service, for example `https://www.googleapis.com/`.
`String`	`getServicePath()` Returns the URL-encoded service path of the service, for example `"tasks/v1/"`.
`boolean`	`getSuppressPatternChecks()` Returns whether discovery pattern checks should be suppressed on required parameters.
`boolean`	`getSuppressRequiredParameterChecks()` Returns whether discovery required parameter checks should be suppressed.
`HttpTransport`	`getTransport()` Returns the HTTP transport.
`AbstractGoogleClient.Builder`	`setApplicationName(String applicationName)` Sets the application name to be used in the UserAgent header of each request or `null` for none.
`AbstractGoogleClient.Builder`	`setBatchPath(String batchPath)` Sets the URL-encoded batch path of the service, for example `"batch/tasks"`.
`AbstractGoogleClient.Builder`	`setGoogleClientRequestInitializer(GoogleClientRequestInitializer googleClientRequestInitializer)` Sets the Google client request initializer or `null` for none.
`AbstractGoogleClient.Builder`	`setHttpRequestInitializer(HttpRequestInitializer httpRequestInitializer)` Sets the HTTP request initializer or `null` for none.
`AbstractGoogleClient.Builder`	`setRootUrl(String rootUrl)` Sets the URL-encoded root URL of the service, for example `https://www.googleapis.com/` .
`AbstractGoogleClient.Builder`	`setServicePath(String servicePath)` Sets the URL-encoded service path of the service, for example `"tasks/v1/"`.
`AbstractGoogleClient.Builder`	`setSuppressAllChecks(boolean suppressAllChecks)` Suppresses all discovery pattern and required parameter checks.
`AbstractGoogleClient.Builder`	`setSuppressPatternChecks(boolean suppressPatternChecks)` Sets whether discovery pattern checks should be suppressed on required parameters.
`AbstractGoogleClient.Builder`	`setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks)` Sets whether discovery required parameter checks should be suppressed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder(HttpTransport transport,
                  String rootUrl,
                  String servicePath,
                  ObjectParser objectParser,
                  HttpRequestInitializer httpRequestInitializer)
```
    Returns an instance of a new builder.
    
    Parameters:
    
    transport - The transport to use for requests
    
    rootUrl - root URL of the service. Must end with a "/"
    
    servicePath - service path
    
    objectParser - object parser or null for none
    
    httpRequestInitializer - HTTP request initializer or null for none
- Method Detail
  - build
```
public abstract AbstractGoogleClient build()
```
    Builds a new instance of AbstractGoogleClient.
  - getTransport
```
public final HttpTransport getTransport()
```
    Returns the HTTP transport.
  - getObjectParser
```
public ObjectParser getObjectParser()
```
    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.
  - getRootUrl
```
public final String getRootUrl()
```
    Returns the URL-encoded root URL of the service, for example https://www.googleapis.com/.
    Must be URL-encoded and must end with a "/".
  - setRootUrl
```
public AbstractGoogleClient.Builder setRootUrl(String rootUrl)
```
    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.
  - getServicePath
```
public final String getServicePath()
```
    Returns the URL-encoded service path of the service, for example "tasks/v1/".
    Must be URL-encoded and must end with a "/" and not begin with a "/". It is allowed to be an empty string "".
  - setServicePath
```
public AbstractGoogleClient.Builder setServicePath(String servicePath)
```
    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.
  - setBatchPath
```
public AbstractGoogleClient.Builder setBatchPath(String batchPath)
```
    Sets the URL-encoded batch path of the service, for example "batch/tasks".
  - getGoogleClientRequestInitializer
```
public final GoogleClientRequestInitializer getGoogleClientRequestInitializer()
```
    Returns the Google client request initializer or null for none.
  - setGoogleClientRequestInitializer
```
public AbstractGoogleClient.Builder setGoogleClientRequestInitializer(GoogleClientRequestInitializer googleClientRequestInitializer)
```
    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.
  - getHttpRequestInitializer
```
public final HttpRequestInitializer getHttpRequestInitializer()
```
    Returns the HTTP request initializer or null for none.
  - setHttpRequestInitializer
```
public AbstractGoogleClient.Builder setHttpRequestInitializer(HttpRequestInitializer httpRequestInitializer)
```
    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.
  - getApplicationName
```
public final String getApplicationName()
```
    Returns the application name to be used in the UserAgent header of each request or null for none.
  - setApplicationName
```
public AbstractGoogleClient.Builder setApplicationName(String applicationName)
```
    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.
  - getSuppressPatternChecks
```
public final boolean getSuppressPatternChecks()
```
    Returns whether discovery pattern checks should be suppressed on required parameters.
  - setSuppressPatternChecks
```
public AbstractGoogleClient.Builder setSuppressPatternChecks(boolean suppressPatternChecks)
```
    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.
  - getSuppressRequiredParameterChecks
```
public final boolean getSuppressRequiredParameterChecks()
```
    Returns whether discovery required parameter checks should be suppressed.
    
    Since:
    
    1.14
  - setSuppressRequiredParameterChecks
```
public AbstractGoogleClient.Builder setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks)
```
    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.
    
    Since:
    
    1.14
  - setSuppressAllChecks
```
public AbstractGoogleClient.Builder setSuppressAllChecks(boolean suppressAllChecks)
```
    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.
    
    Since:
    
    1.14

Class AbstractGoogleClient.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

getTransport

getObjectParser

getRootUrl

setRootUrl

getServicePath

setServicePath

setBatchPath

getGoogleClientRequestInitializer

setGoogleClientRequestInitializer

getHttpRequestInitializer

setHttpRequestInitializer

getApplicationName

setApplicationName

getSuppressPatternChecks

setSuppressPatternChecks

getSuppressRequiredParameterChecks

setSuppressRequiredParameterChecks

setSuppressAllChecks