com.google.cloud

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

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

Direct Known Subclasses:

GrpcServiceOptions, HttpServiceOptions

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.

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.
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.
String	libraryName() Returns the library's name, gcloud-java, as a string.
String	libraryVersion() Returns the library's version as a string.
String	projectId() Returns the project id.
protected boolean	projectIdRequired() Returns whether a service requires a project ID.
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.

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.

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].

libraryName

public String libraryName()

Returns the library's name, gcloud-java, as a string.

libraryVersion

public String libraryVersion()

Returns the library's version as a string.

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.