Class SubscriberServiceSettings (1.11.1)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(SubscriberServiceStubSettings stub)

public static final SubscriberServiceSettings create(SubscriberServiceStubSettings stub)

Parameter

Name	Description
`stub`	`SubscriberServiceStubSettings`

Returns

Type	Description
`SubscriberServiceSettings`

Exceptions

Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
`List<String>`

newBuilder()

public static SubscriberServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
`SubscriberServiceSettings.Builder`

newBuilder(ClientContext clientContext)

public static SubscriberServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`SubscriberServiceSettings.Builder`

Constructors

SubscriberServiceSettings(SubscriberServiceSettings.Builder settingsBuilder)

protected SubscriberServiceSettings(SubscriberServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`SubscriberServiceSettings.Builder`

Methods

subscribeSettings()

public StreamingCallSettings<SubscribeRequest,SubscribeResponse> subscribeSettings()

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

Returns

Type	Description
`StreamingCallSettings<SubscribeRequest,SubscribeResponse>`

toBuilder()

public SubscriberServiceSettings.Builder toBuilder()

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

Returns

Type	Description
`SubscriberServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()