Package com.google.api.gax.rpc

Class ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,​B extends ClientSettings.Builder<SettingsT,​B>>

    • Constructor Detail

      • Builder

        protected Builder​(ClientSettings settings)
        Create a builder from a ClientSettings object.

      • Builder

        protected Builder​(StubSettings.Builder stubSettings)
        Create a builder from a StubSettings object.

      • Builder

        protected Builder()

    • Method Detail

      • self

        protected B self()

      • setCredentialsProvider

        public B setCredentialsProvider​(CredentialsProvider credentialsProvider)
        Sets the CredentialsProvider to use for getting the credentials to make calls with.

      • setHeaderProvider

        public B setHeaderProvider​(HeaderProvider headerProvider)
        Sets the HeaderProvider for getting custom static headers for http requests. The header provider will be called during client construction only once. The headers returned by the provider will be cached and supplied as is for each request issued by the constructed client. Some reserved headers can be overridden (e.g. Content-Type) or merged with the default value (e.g. User-Agent) by the underlying transport layer.

      • setInternalHeaderProvider

        protected B setInternalHeaderProvider​(HeaderProvider internalHeaderProvider)
        Sets the HeaderProvider for getting internal (library-defined) static headers for http requests. The header provider will be called during client construction only once. The headers returned by the provider will be cached and supplied as is for each request issued by the constructed client. Some reserved headers can be overridden (e.g. Content-Type) or merged with the default value (e.g. User-Agent) by the underlying transport layer.

      • setTransportChannelProvider

        public B setTransportChannelProvider​(TransportChannelProvider transportChannelProvider)
        Sets the TransportProvider to use for getting the transport-specific context to make calls with.

      • setClock

        public B setClock​(com.google.api.core.ApiClock clock)
        Sets the clock to use for retry logic.

        This will default to a system clock if it is not set.

      • setEndpoint

        public B setEndpoint​(java.lang.String endpoint)

      • setQuotaProjectId

        public B setQuotaProjectId​(java.lang.String quotaProjectId)

      • setWatchdogProvider

        public B setWatchdogProvider​(@Nullable
                             WatchdogProvider watchdogProvider)

      • setWatchdogCheckInterval

        public B setWatchdogCheckInterval​(@Nullable
                                  org.threeten.bp.Duration checkInterval)

      • getExecutorProvider

        @Deprecated
public ExecutorProvider getExecutorProvider()
        Deprecated.
        Please use getBackgroundExecutorProvider() for getting the executor provider that's used for running scheduled API call logic.
        Gets the ExecutorProvider that was previously set on this Builder. This ExecutorProvider is to use for running asynchronous API call logic (such as retries and long-running operations), and also to pass to the transport settings if an executor is needed for the transport and it doesn't have its own executor provider.

      • getBackgroundExecutorProvider

        public ExecutorProvider getBackgroundExecutorProvider()
        Gets the ExecutorProvider that was previously set on this Builder. This ExecutorProvider is to use for running asynchronous API call logic (such as retries and long-running operations). This ExecutorProvider is not used to set the executor in TransportChannelProvider.

      • getTransportChannelProvider

        public TransportChannelProvider getTransportChannelProvider()
        Gets the TransportProvider that was previously set on this Builder.

      • getCredentialsProvider

        public CredentialsProvider getCredentialsProvider()
        Gets the CredentialsProvider that was previously set on this Builder.

      • getHeaderProvider

        public HeaderProvider getHeaderProvider()
        Gets the custom HeaderProvider that was previously set on this Builder.

      • getInternalHeaderProvider

        protected HeaderProvider getInternalHeaderProvider()
        Gets the internal HeaderProvider that was previously set on this Builder.

      • getClock

        public com.google.api.core.ApiClock getClock()
        Gets the ApiClock that was previously set on this Builder.

      • getEndpoint

        public java.lang.String getEndpoint()

      • getQuotaProjectId

        public java.lang.String getQuotaProjectId()
        Gets the QuotaProjectId that was previously set on this Builder.

      • getWatchdogCheckInterval

        @Nullable
public org.threeten.bp.Duration getWatchdogCheckInterval()

      • applyToAllUnaryMethods

        protected static void applyToAllUnaryMethods​(java.lang.Iterable<UnaryCallSettings.Builder<?,​?>> methodSettingsBuilders,
                                             com.google.api.core.ApiFunction<UnaryCallSettings.Builder<?,​?>,​java.lang.Void> settingsUpdater)
        Applies the given settings updater function to the given method settings builders.

      • build

        public abstract SettingsT build()
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object