Send feedback
Class ServiceOptions<ServiceT,OptionsT> (2.24.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.24.1 keyboard_arrow_down
public abstract class ServiceOptions<ServiceT , OptionsT > implements Serializable
Abstract class representing service options.
Type Parameters Name Description ServiceTOptionsT
Static Fields
CREDENTIAL_ENV_NAME
public static final String CREDENTIAL_ENV_NAME
Field Value Type Description String
Static Methods
<T>getFromServiceLoader(Class<? extends T> clazz, T defaultInstance)
public static T <T>getFromServiceLoader ( Class <? extends T > clazz , T defaultInstance )
Parameters Name Description clazzClass <? extends T >defaultInstanceT
<T>newInstance(String className)
public static T <T>newInstance ( String className )
Parameter Name Description classNameString
getAppEngineAppId()
public static String getAppEngineAppId ()
getAppEngineProjectId()
protected static String getAppEngineProjectId ()
getAppEngineProjectIdFromAppId()
protected static String getAppEngineProjectIdFromAppId ()
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:
The project ID specified by the GOOGLE_CLOUD_PROJECT environment variable
The App Engine project ID
The project ID specified in the JSON credentials file pointed by the
GOOGLE_APPLICATION_CREDENTIALS environment variable
The Google Cloud SDK project ID
The Compute Engine project ID
getDefaultRetrySettings()
public static RetrySettings getDefaultRetrySettings ()
getGoogApiClientLibName()
public static String getGoogApiClientLibName ()
Returns the library's name used by x-goog-api-client header as a string.
getGoogleCloudProjectId()
protected static String getGoogleCloudProjectId ()
getLibraryName()
public static String getLibraryName ()
Returns the library's name, gcloud-java, as a string.
getNoRetrySettings()
public static RetrySettings getNoRetrySettings ()
getServiceAccountProjectId()
protected static String getServiceAccountProjectId ()
Constructors
ServiceOptions(Class<? extends ServiceFactory<ServiceT,OptionsT>> serviceFactoryClass, Class<? extends ServiceRpcFactory<OptionsT>> rpcFactoryClass, ServiceOptions.Builder<ServiceT,OptionsT,?> builder, ServiceDefaults<ServiceT,OptionsT> serviceDefaults)
protected ServiceOptions ( Class <? extends ServiceFactory<ServiceT , OptionsT >> serviceFactoryClass , Class <? extends ServiceRpcFactory<OptionsT> > rpcFactoryClass , ServiceOptions . Builder<ServiceT , OptionsT , ? > builder , ServiceDefaults<ServiceT , OptionsT > serviceDefaults )
Parameters Name Description serviceFactoryClassClass <? extends com.google.cloud.ServiceFactory <ServiceT ,OptionsT >>rpcFactoryClassClass <? extends com.google.cloud.spi.ServiceRpcFactory <OptionsT >>builderBuilder <ServiceT ,OptionsT ,? >serviceDefaultsServiceDefaults <ServiceT ,OptionsT >
Fields
clientLibToken
protected final String clientLibToken
Field Value Type Description String
credentials
protected Credentials credentials
Field Value Type Description com.google.auth.Credentials
Methods
<B>toBuilder()
public abstract B <B>toBuilder ()
baseEquals(ServiceOptions<?,?> other)
protected boolean baseEquals ( ServiceOptions <? , ? > other )
baseHashCode()
protected int baseHashCode ()
Returns Type Description int
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 .
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).
getClientLibToken()
public String getClientLibToken ()
getClock()
public ApiClock getClock ()
Returns the service's clock. Default time source uses System#currentTimeMillis() to get
current time.
getCredentials()
public Credentials getCredentials ()
Returns the authentication credentials.
Returns Type Description com.google.auth.Credentials
getDefaultHost()
protected String getDefaultHost ()
getDefaultProject()
protected String getDefaultProject ()
getHost()
Returns the service host.
getLibraryVersion()
public String getLibraryVersion ()
Returns the library's version as a string.
public final HeaderProvider getMergedHeaderProvider ( HeaderProvider internalHeaderProvider )
getProjectId()
public String getProjectId ()
Returns the project ID. Return value can be null (for services that don't require a project
ID).
getQuotaProjectId()
public String getQuotaProjectId ()
Returns the quotaProjectId that specifies the project used for quota and billing purposes.
getRetrySettings()
public RetrySettings getRetrySettings ()
Returns configuration parameters for request retries.
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.
getScopedCredentials()
public Credentials getScopedCredentials ()
Returns the authentication credentials. If required, credentials are scoped.
Returns Type Description com.google.auth.Credentials
getScopes()
protected abstract Set<String> getScopes ()
getService()
public ServiceT getService ()
Returns a Service object for the current service. For instance, when using Google Cloud
Storage, it returns a Storage object.
Returns Type Description ServiceT
getTransportOptions()
public TransportOptions getTransportOptions ()
Returns the transport-specific options for this service.
getUserAgent()
public final String getUserAgent ()
projectIdRequired()
protected boolean projectIdRequired ()
Returns whether a service requires a project ID. This method may be overridden in
service-specific Options objects.
Returns Type Description boolean true if a project ID is required to use the service, false if not
shouldRefreshRpc(ServiceRpc cachedRpc)
protected boolean shouldRefreshRpc ( ServiceRpc cachedRpc )
Parameter Name Description cachedRpcServiceRpc The currently cached service object
Returns Type Description boolean true if the currently cached service object should be refreshed.
shouldRefreshService(ServiceT cachedService)
protected boolean shouldRefreshService ( ServiceT cachedService )
Parameter Name Description cachedServiceServiceT The currently cached service object
Returns Type Description boolean true if the currently cached service object should be refreshed.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-19 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-19 UTC."],[],[]]
