Send feedback
Class StubSettings<SettingsT> (2.47.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.47.0 keyboard_arrow_down
public abstract class StubSettings<SettingsT>
A base settings class to configure a client stub class.
This base class includes settings that are applicable to all services, which includes things
like settings for creating an executor, credentials, transport-specific settings, and identifiers
for http headers.
If no ExecutorProvider is set, then InstantiatingExecutorProvider will be used, which creates
a default executor.
Type Parameter
Name
Description
SettingsT
Constructors
StubSettings(StubSettings.Builder builder)
protected StubSettings ( StubSettings . Builder builder )
Constructs an instance of StubSettings.
Parameter
Name
Description
builder
Builder
Methods
getBackgroundExecutorProvider()
public final ExecutorProvider getBackgroundExecutorProvider ()
getClock()
public final ApiClock getClock ()
getCredentialsProvider()
public final CredentialsProvider getCredentialsProvider ()
getEndpoint()
public String getEndpoint ()
Returns
Type
Description
String
the fully resolved endpoint used by the client
getExecutorProvider() (deprecated)
public final ExecutorProvider getExecutorProvider ()
getGdchApiAudience()
public final String getGdchApiAudience ()
Gets the GDCH API audience to be used with com.google.auth.oauth2.GdchCredentials
Returns
Type
Description
String
public final HeaderProvider getHeaderProvider ()
protected final HeaderProvider getInternalHeaderProvider ()
getMtlsEndpoint()
public final String getMtlsEndpoint ()
Returns
Type
Description
String
getQuotaProjectId()
public final String getQuotaProjectId ()
Returns
Type
Description
String
getServiceName()
protected String getServiceName ()
Marked with Internal Api and meant to overriden by the generated subclasses. This getter is
used to set the serviceName to the EndpointContext. The value in generated StubSettings
subclasses comes from the proto files.
This should be effectively treated as an abstract method.
Returns
Type
Description
String
getStreamWatchdogCheckInterval()
public final Duration getStreamWatchdogCheckInterval ()
Returns
Type
Description
org.threeten.bp.Duration
getStreamWatchdogProvider()
public final WatchdogProvider getStreamWatchdogProvider ()
getTracerFactory()
public ApiTracerFactory getTracerFactory ()
Beta
The surface for tracing is not stable yet and may change in the future.
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Gets the configured ApiTracerFactory that will be used to generate traces for
operations.
getTransportChannelProvider()
public final TransportChannelProvider getTransportChannelProvider ()
getUniverseDomain()
public final String getUniverseDomain ()
Returns
Type
Description
String
the fully resolved universe domain used by the client
toBuilder()
public abstract StubSettings . Builder toBuilder ()
toString()
Returns
Type
Description
String
Overrides
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-08-19 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{
"last_modified": "Last updated 2024-08-19 UTC.",
"state": ""
}