ServiceOptions (Google Cloud 0.89.0-alpha API)

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

Type Parameters:

ServiceT - the service subclass

OptionsT - the ServiceOptions subclass corresponding to the service

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BigQueryOptions, ComputeOptions, DatastoreOptions, DnsOptions, FirestoreOptions, LoggingOptions, ResourceManagerOptions, SpannerOptions, StorageOptions, TranslateOptions
```
public abstract class ServiceOptions<ServiceT extends Service<OptionsT>,OptionsT extends ServiceOptions<ServiceT,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
`static class`	`ServiceOptions.Builder<ServiceT extends Service<OptionsT>,OptionsT extends ServiceOptions<ServiceT,OptionsT>,B extends ServiceOptions.Builder<ServiceT,OptionsT,B>>` Builder for `ServiceOptions`.

Field Summary

Fields
Modifier and Type Field and Description

static String CREDENTIAL_ENV_NAME

protected Credentials credentials

Fields
Modifier and Type	Field and Description
`static String`	`CREDENTIAL_ENV_NAME`
`protected Credentials`	`credentials`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`baseEquals(ServiceOptions<?,?> other)`
`protected int`	`baseHashCode()`
`protected RetrySettings`	`defaultRetrySettings()` Some services may have different backoff requirements listed in their SLAs.
`static String`	`getAppEngineAppId()`
`protected static String`	`getAppEngineProjectId()`
`protected static String`	`getAppEngineProjectIdFromAppId()`
`String`	`getApplicationName()` Returns the application's name as a string in the format `gcloud-java/[version]`, optionally prepended with externally supplied User-Agent header value (via setting custom header provider).
`ApiClock`	`getClock()` Returns the service's clock.
`Credentials`	`getCredentials()` Returns the authentication credentials.
`protected String`	`getDefaultHost()`
`protected String`	`getDefaultProject()`
`static String`	`getDefaultProjectId()` Returns the default project ID, or `null` if no default project ID could be found.
`static RetrySettings`	`getDefaultRetrySettings()`
`static <T> T`	`getFromServiceLoader(Class<? extends T> clazz, T defaultInstance)`
`static String`	`getGoogApiClientLibName()` Returns the library's name used by x-goog-api-client header as a string.
`protected static String`	`getGoogleCloudProjectId()`
`String`	`getHost()` Returns the service host.
`static String`	`getLibraryName()` Returns the library's name, `gcloud-java`, as a string.
`String`	`getLibraryVersion()` Returns the library's version as a string.
`HeaderProvider`	`getMergedHeaderProvider(HeaderProvider internalHeaderProvider)`
`static RetrySettings`	`getNoRetrySettings()`
`String`	`getProjectId()` Returns the project ID.
`RetrySettings`	`getRetrySettings()` Returns configuration parameters for request retries.
`ServiceRpc`	`getRpc()` Returns a Service RPC object for the current service.
`Credentials`	`getScopedCredentials()` Returns the authentication credentials.
`protected abstract Set<String>`	`getScopes()`
`ServiceT`	`getService()` Returns a Service object for the current service.
`protected static String`	`getServiceAccountProjectId()`
`TransportOptions`	`getTransportOptions()` Returns the transport-specific options for this service.
`String`	`getUserAgent()`
`static <T> T`	`newInstance(String className)`
`protected boolean`	`projectIdRequired()` Returns whether a service requires a project ID.
`abstract <B extends ServiceOptions.Builder<ServiceT,OptionsT,B>> B`	`toBuilder()`

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

Field Detail

CREDENTIAL_ENV_NAME

public static final String CREDENTIAL_ENV_NAME

See Also:: Constant Field Values

credentials
```
protected Credentials credentials
```

Constructor Detail

ServiceOptions

@InternalApi(value="This class should only be extended within google-cloud-java")
protected ServiceOptions(Class<? extends ServiceFactory<ServiceT,OptionsT>> serviceFactoryClass,
                                                                                                           Class<? extends ServiceRpcFactory<OptionsT>> rpcFactoryClass,
                                                                                                           ServiceOptions.Builder<ServiceT,OptionsT,?> builder,
                                                                                                           ServiceDefaults<ServiceT,OptionsT> serviceDefaults)

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
- getDefaultHost
```
protected String getDefaultHost()
```
- getDefaultProject
```
protected String getDefaultProject()
```
- getDefaultProjectId
```
public static String getDefaultProjectId()
```
  Returns the default project ID, or null if no default project ID could be found. This method returns the first available project ID among the following sources:
  1. The project ID specified by the GOOGLE_CLOUD_PROJECT environment variable
  2. The App Engine project ID
  3. The project ID specified in the JSON credentials file pointed by the GOOGLE_APPLICATION_CREDENTIALS environment variable
  4. The Google Cloud SDK project ID
  5. The Compute Engine project ID
- getAppEngineAppId
```
public static String getAppEngineAppId()
```
- getGoogleCloudProjectId
```
protected static String getGoogleCloudProjectId()
```
- getAppEngineProjectId
```
protected static String getAppEngineProjectId()
```
- getAppEngineProjectIdFromAppId
```
protected static String getAppEngineProjectIdFromAppId()
```
- getServiceAccountProjectId
```
protected static String getServiceAccountProjectId()
```
- getService
```
public ServiceT getService()
```
  Returns a Service object for the current service. For instance, when using Google Cloud Storage, it returns a Storage object.
- getRpc
```
public ServiceRpc getRpc()
```
  Returns a Service RPC object for the current service. For instance, when using Google Cloud Storage, it returns a StorageRpc object.
- getProjectId
```
public String getProjectId()
```
  Returns the project ID. Return value can be null (for services that don't require a project ID).
- getHost
```
public String getHost()
```
  Returns the service host.
- getCredentials
```
public Credentials getCredentials()
```
  Returns the authentication credentials.
- getScopedCredentials
```
public Credentials getScopedCredentials()
```
  Returns the authentication credentials. If required, credentials are scoped.
- getRetrySettings
```
public RetrySettings getRetrySettings()
```
  Returns configuration parameters for request retries.
- getClock
```
public ApiClock getClock()
```
  Returns the service's clock. Default time source uses System.currentTimeMillis() to get current time.
- getTransportOptions
```
public TransportOptions getTransportOptions()
```
  Returns the transport-specific options for this service.
- getApplicationName
```
public String getApplicationName()
```
  Returns the application's name as a string in the format gcloud-java/[version], optionally prepended with externally supplied User-Agent header value (via setting custom header provider).
- getLibraryName
```
public static String getLibraryName()
```
  Returns the library's name, gcloud-java, as a string.
- getGoogApiClientLibName
```
public static String getGoogApiClientLibName()
```
  Returns the library's name used by x-goog-api-client header as a string.
- getLibraryVersion
```
public String getLibraryVersion()
```
  Returns the library's version as a string.
- getMergedHeaderProvider
```
@InternalApi
public final HeaderProvider getMergedHeaderProvider(HeaderProvider internalHeaderProvider)
```
- getUserAgent
```
@InternalApi
public final String getUserAgent()
```
- baseHashCode
```
protected int baseHashCode()
```
- baseEquals
```
protected boolean baseEquals(ServiceOptions<?,?> other)
```
- newInstance
```
@InternalApi
public static <T> T newInstance(String className)
                                      throws IOException,
                                             ClassNotFoundException
```
  Throws:
  
  IOException
  
  ClassNotFoundException
- getDefaultRetrySettings
```
public static RetrySettings getDefaultRetrySettings()
```
- getNoRetrySettings
```
public static RetrySettings getNoRetrySettings()
```
- getScopes
```
protected abstract Set<String> getScopes()
```
- toBuilder
```
public abstract <B extends ServiceOptions.Builder<ServiceT,OptionsT,B>> B toBuilder()
```
- defaultRetrySettings
```
protected RetrySettings defaultRetrySettings()
```
  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 RetrySettings.
- getFromServiceLoader
```
@InternalApi
public static <T> T getFromServiceLoader(Class<? extends T> clazz,
                                                      T defaultInstance)
```

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

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREDENTIAL_ENV_NAME

credentials

Constructor Detail

ServiceOptions

Method Detail

projectIdRequired

getDefaultHost

getDefaultProject

getDefaultProjectId

getAppEngineAppId

getGoogleCloudProjectId

getAppEngineProjectId

getAppEngineProjectIdFromAppId

getServiceAccountProjectId

getService

getRpc

getProjectId

getHost

getCredentials

getScopedCredentials

getRetrySettings

getClock

getTransportOptions

getApplicationName

getLibraryName

getGoogApiClientLibName

getLibraryVersion

getMergedHeaderProvider

getUserAgent

baseHashCode

baseEquals

newInstance

getDefaultRetrySettings

getNoRetrySettings

getScopes

toBuilder

defaultRetrySettings

getFromServiceLoader