com.google.api.client.googleapis.services

Class CommonGoogleClientRequestInitializer.Builder

java.lang.Object

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

Direct Known Subclasses:

CommonGoogleJsonClientRequestInitializer.Builder

Enclosing class:

CommonGoogleClientRequestInitializer

public static class CommonGoogleClientRequestInitializer.Builder
extends Object

Builder for CommonGoogleClientRequestInitializer.

Since:

1.30

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
CommonGoogleClientRequestInitializer	build() Returns the constructed CommonGoogleClientRequestInitializer instance.
String	getKey() Returns the API key.
String	getRequestReason() Get the configured request reason.
String	getUserAgent() Returns the configured user agent.
String	getUserIp() Returns the configured userIp.
String	getUserProject() Get the configured user project.
protected CommonGoogleClientRequestInitializer.Builder	self()
CommonGoogleClientRequestInitializer.Builder	setKey(String key) Set the API Key for outgoing requests.
CommonGoogleClientRequestInitializer.Builder	setRequestReason(String requestReason) Set the reason for making the request, which is intended to be recorded in audit logging.
CommonGoogleClientRequestInitializer.Builder	setUserAgent(String userAgent) Set the user agent.
CommonGoogleClientRequestInitializer.Builder	setUserIp(String userIp) Set the IP address of the end user for whom the API call is being made.
CommonGoogleClientRequestInitializer.Builder	setUserProject(String userProject) Set the user project for the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Method Detail

setKey

public CommonGoogleClientRequestInitializer.Builder setKey(String key)

Set the API Key for outgoing requests.

Parameters:

key - the API key

Returns:

the builder

getKey

public String getKey()

Returns the API key.

Returns:

the API key

setUserIp

public CommonGoogleClientRequestInitializer.Builder setUserIp(String userIp)

Set the IP address of the end user for whom the API call is being made.

Parameters:

userIp - the user's IP address

Returns:

the builder

getUserIp

public String getUserIp()

Returns the configured userIp.

Returns:

the userIp

setUserAgent

public CommonGoogleClientRequestInitializer.Builder setUserAgent(String userAgent)

Set the user agent.

Parameters:

userAgent - the user agent

Returns:

the builder

getUserAgent

public String getUserAgent()

Returns the configured user agent.

Returns:

the user agent

setRequestReason

public CommonGoogleClientRequestInitializer.Builder setRequestReason(String requestReason)

Set the reason for making the request, which is intended to be recorded in audit logging. An example reason would be a support-case ticket number.

Parameters:

requestReason - the reason for making the request

Returns:

the builder

getRequestReason

public String getRequestReason()

Get the configured request reason.

Returns:

the request reason

setUserProject

public CommonGoogleClientRequestInitializer.Builder setUserProject(String userProject)

Set the user project for the request. This is a caller-specified project for quota and billing purposes. The caller must have serviceusage.services.use permission on the project.

Parameters:

userProject - the user project

Returns:

the builder

getUserProject

public String getUserProject()

Get the configured user project.

Returns:

the user project

build

public CommonGoogleClientRequestInitializer build()

Returns the constructed CommonGoogleClientRequestInitializer instance.

Returns:

the constructed CommonGoogleClientRequestInitializer instance

self

protected CommonGoogleClientRequestInitializer.Builder self()