public abstract static class AbstractGoogleClient.Builder
Constructors
Builder(HttpTransport transport, String rootUrl, String servicePath, ObjectParser objectParser, HttpRequestInitializer httpRequestInitializer)
protected Builder(HttpTransport transport, String rootUrl, String servicePath, ObjectParser objectParser, HttpRequestInitializer httpRequestInitializer)
Returns an instance of a new builder.
Name | Description |
transport | com.google.api.client.http.HttpTransport The transport to use for requests |
rootUrl | String root URL of the service. Must end with a "/" |
servicePath | String service path |
objectParser | com.google.api.client.util.ObjectParser object parser or |
httpRequestInitializer | com.google.api.client.http.HttpRequestInitializer HTTP request initializer or |
Methods
build()
public abstract AbstractGoogleClient build()
Builds a new instance of AbstractGoogleClient.
Type | Description |
AbstractGoogleClient |
getApplicationName()
public final String getApplicationName()
Returns the application name to be used in the UserAgent header of each request or
null
for none.
Type | Description |
String |
getGoogleClientRequestInitializer()
public final GoogleClientRequestInitializer getGoogleClientRequestInitializer()
Returns the Google client request initializer or null
for none.
Type | Description |
GoogleClientRequestInitializer |
getHttpRequestInitializer()
public final HttpRequestInitializer getHttpRequestInitializer()
Returns the HTTP request initializer or null
for none.
Type | Description |
com.google.api.client.http.HttpRequestInitializer |
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.
Type | Description |
com.google.api.client.util.ObjectParser |
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 "/".
Type | Description |
String |
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 ""
.
Type | Description |
String |
getSuppressPatternChecks()
public final boolean getSuppressPatternChecks()
Returns whether discovery pattern checks should be suppressed on required parameters.
Type | Description |
boolean |
getSuppressRequiredParameterChecks()
public final boolean getSuppressRequiredParameterChecks()
Returns whether discovery required parameter checks should be suppressed.
Type | Description |
boolean |
getTransport()
public final HttpTransport getTransport()
Returns the HTTP transport.
Type | Description |
com.google.api.client.http.HttpTransport |
setApplicationName(String applicationName)
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.
Name | Description |
applicationName | String |
Type | Description |
AbstractGoogleClient.Builder |
setBatchPath(String batchPath)
public AbstractGoogleClient.Builder setBatchPath(String batchPath)
Sets the URL-encoded batch path of the service, for example "batch/tasks"
.
Name | Description |
batchPath | String |
Type | Description |
AbstractGoogleClient.Builder |
setGoogleClientRequestInitializer(GoogleClientRequestInitializer googleClientRequestInitializer)
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.
Name | Description |
googleClientRequestInitializer | GoogleClientRequestInitializer |
Type | Description |
AbstractGoogleClient.Builder |
setHttpRequestInitializer(HttpRequestInitializer httpRequestInitializer)
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.
Name | Description |
httpRequestInitializer | com.google.api.client.http.HttpRequestInitializer |
Type | Description |
AbstractGoogleClient.Builder |
setRootUrl(String rootUrl)
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.
Name | Description |
rootUrl | String |
Type | Description |
AbstractGoogleClient.Builder |
setServicePath(String servicePath)
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.
Name | Description |
servicePath | String |
Type | Description |
AbstractGoogleClient.Builder |
setSuppressAllChecks(boolean suppressAllChecks)
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.
Name | Description |
suppressAllChecks | boolean |
Type | Description |
AbstractGoogleClient.Builder |
setSuppressPatternChecks(boolean suppressPatternChecks)
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.
Name | Description |
suppressPatternChecks | boolean |
Type | Description |
AbstractGoogleClient.Builder |
setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks)
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.
Name | Description |
suppressRequiredParameterChecks | boolean |
Type | Description |
AbstractGoogleClient.Builder |