Class SubscriberServiceSettings

public class SubscriberServiceSettings extends ClientSettings<SubscriberServiceSettings>

Settings class to configure an instance of SubscriberServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (pubsublite.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of subscribe to 30 seconds:


 SubscriberServiceSettings.Builder subscriberServiceSettingsBuilder =
     SubscriberServiceSettings.newBuilder();
 subscriberServiceSettingsBuilder
     .subscribeSettings()
     .setRetrySettings(
         subscriberServiceSettingsBuilder
             .subscribeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SubscriberServiceSettings subscriberServiceSettings = subscriberServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > SubscriberServiceSettings

Constructors

SubscriberServiceSettings(SubscriberServiceSettings.Builder settingsBuilder)

protected SubscriberServiceSettings(SubscriberServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSubscriberServiceSettings.Builder

Methods

create(SubscriberServiceStubSettings stub)

public static final SubscriberServiceSettings create(SubscriberServiceStubSettings stub)
Parameter
NameDescription
stubSubscriberServiceStubSettings
Returns
TypeDescription
SubscriberServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static SubscriberServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
SubscriberServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SubscriberServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
SubscriberServiceSettings.Builder

subscribeSettings()

public StreamingCallSettings<SubscribeRequest,SubscribeResponse> subscribeSettings()

Returns the object with the settings used for calls to subscribe.

Returns
TypeDescription
StreamingCallSettings<SubscribeRequest,SubscribeResponse>

toBuilder()

public SubscriberServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
SubscriberServiceSettings.Builder
Overrides