ServiceOptions (GCloud Java core 0.2.2 API)

java.lang.Object
- com.google.cloud.ServiceOptions<ServiceT,ServiceRpcT,OptionsT>

Type Parameters:
ServiceT - the service subclass
ServiceRpcT - the spi-layer class corresponding to the service
OptionsT - the ServiceOptions subclass corresponding to the service

All Implemented Interfaces:

Serializable
```
public abstract class ServiceOptions<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>>
extends Object
implements Serializable
```
Abstract class representing service options.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`ServiceOptions.Builder<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>,B extends ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>>` Builder for `ServiceOptions`.
`static class`	`ServiceOptions.DefaultHttpTransportFactory`
`static interface`	`ServiceOptions.HttpTransportFactory` A base interface for all `HttpTransport` factories.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServiceOptions(Class<? extends ServiceFactory<ServiceT,OptionsT>> serviceFactoryClass, Class<? extends ServiceRpcFactory<ServiceRpcT,OptionsT>> rpcFactoryClass, ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,?> builder)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected static String`	`appEngineAppId()`
`protected static String`	`appEngineProjectId()`
`String`	`applicationName()` Returns the application's name as a string in the format `gcloud-java/[version]`.
`AuthCredentials`	`authCredentials()` Returns the authentication credentials.
`protected boolean`	`baseEquals(ServiceOptions<?,?,?> other)`
`protected int`	`baseHashCode()`
`Clock`	`clock()` Returns the service's clock.
`int`	`connectTimeout()` Returns the timeout in milliseconds to establish a connection.
`protected String`	`defaultHost()`
`protected String`	`defaultProject()`
`protected RetryParams`	`defaultRetryParams()` Some services may have different backoff requirements listed in their SLAs.
`protected abstract ServiceRpcFactory<ServiceRpcT,OptionsT>`	`defaultRpcFactory()`
`protected abstract ServiceFactory<ServiceT,OptionsT>`	`defaultServiceFactory()`
`protected static String`	`googleCloudProjectId()`
`String`	`host()` Returns the service host.
`com.google.api.client.http.HttpRequestInitializer`	`httpRequestInitializer()` Returns a request initializer responsible for initializing requests according to service options.
`ServiceOptions.HttpTransportFactory`	`httpTransportFactory()` Returns the transport factory.
`String`	`projectId()` Returns the project id.
`protected boolean`	`projectIdRequired()` Returns whether a service requires a project ID.
`int`	`readTimeout()` Returns the timeout in milliseconds to read from an established connection.
`RetryParams`	`retryParams()` Returns configuration parameters for request retries.
`ServiceRpcT`	`rpc()`
`protected abstract Set<String>`	`scopes()`
`ServiceT`	`service()`
`protected static String`	`serviceAccountProjectId()`
`abstract <B extends ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>> B`	`toBuilder()`

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

- Constructor Detail
  - ServiceOptions
```
protected ServiceOptions(Class<? extends ServiceFactory<ServiceT,OptionsT>> serviceFactoryClass,
              Class<? extends ServiceRpcFactory<ServiceRpcT,OptionsT>> rpcFactoryClass,
              ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,?> builder)
```
- Method Detail
  - projectIdRequired
```
protected boolean projectIdRequired()
```
    Returns whether a service requires a project ID. This method may be overridden in service-specific Options objects.
    
    Returns:
    true if a project ID is required to use the service, false if not
  - appEngineAppId
```
protected static String appEngineAppId()
```
  - defaultHost
```
protected String defaultHost()
```
  - defaultProject
```
protected String defaultProject()
```
  - googleCloudProjectId
```
protected static String googleCloudProjectId()
```
  - appEngineProjectId
```
protected static String appEngineProjectId()
```
  - serviceAccountProjectId
```
protected static String serviceAccountProjectId()
```
  - service
```
public ServiceT service()
```
  - rpc
```
public ServiceRpcT rpc()
```
  - projectId
```
public String projectId()
```
    Returns the project id. Return value can be null (for services that don't require a project id).
  - host
```
public String host()
```
    Returns the service host.
  - httpTransportFactory
```
public ServiceOptions.HttpTransportFactory httpTransportFactory()
```
    Returns the transport factory.
  - authCredentials
```
public AuthCredentials authCredentials()
```
    Returns the authentication credentials.
  - retryParams
```
public RetryParams retryParams()
```
    Returns configuration parameters for request retries. By default requests are retried: RetryParams.defaultInstance() is used.
  - httpRequestInitializer
```
public com.google.api.client.http.HttpRequestInitializer httpRequestInitializer()
```
    Returns a request initializer responsible for initializing requests according to service options.
  - connectTimeout
```
public int connectTimeout()
```
    Returns the timeout in milliseconds to establish a connection. 0 is an infinite timeout, a negative number is the default value (20000).
  - readTimeout
```
public int readTimeout()
```
    Returns the timeout in milliseconds to read from an established connection. 0 is an infinite timeout, a negative number is the default value (20000).
  - clock
```
public Clock clock()
```
    Returns the service's clock. Default time source uses System.currentTimeMillis() to get current time.
  - applicationName
```
public String applicationName()
```
    Returns the application's name as a string in the format gcloud-java/[version].
  - baseHashCode
```
protected int baseHashCode()
```
  - baseEquals
```
protected boolean baseEquals(ServiceOptions<?,?,?> other)
```
  - defaultServiceFactory
```
protected abstract ServiceFactory<ServiceT,OptionsT> defaultServiceFactory()
```
  - defaultRpcFactory
```
protected abstract ServiceRpcFactory<ServiceRpcT,OptionsT> defaultRpcFactory()
```
  - scopes
```
protected abstract Set<String> scopes()
```
  - toBuilder
```
public abstract <B extends ServiceOptions.Builder<ServiceT,ServiceRpcT,OptionsT,B>> B toBuilder()
```
  - defaultRetryParams
```
protected RetryParams defaultRetryParams()
```
    Some services may have different backoff requirements listed in their SLAs. Be sure to override this method in options subclasses when the service's backoff requirement differs from the default parameters listed in RetryParams.

Class ServiceOptions<ServiceT extends Service<OptionsT>,ServiceRpcT,OptionsT extends ServiceOptions<ServiceT,ServiceRpcT,OptionsT>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceOptions

Method Detail

projectIdRequired

appEngineAppId

defaultHost

defaultProject

googleCloudProjectId

appEngineProjectId

serviceAccountProjectId

service

rpc

projectId

host

httpTransportFactory

authCredentials

retryParams

httpRequestInitializer

connectTimeout

readTimeout

clock

applicationName

baseHashCode

baseEquals

defaultServiceFactory

defaultRpcFactory

scopes

toBuilder

defaultRetryParams