Class SubscriberServiceStubSettings (1.11.2)

public class SubscriberServiceStubSettings extends StubSettings<SubscriberServiceStubSettings>

Settings class to configure an instance of SubscriberServiceStub.

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
 SubscriberServiceStubSettings.Builder subscriberServiceSettingsBuilder =
     SubscriberServiceStubSettings.newBuilder();
 subscriberServiceSettingsBuilder
     .subscribeSettings()
     .setRetrySettings(
         subscriberServiceSettingsBuilder
             .subscribeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SubscriberServiceStubSettings subscriberServiceSettings =
     subscriberServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > SubscriberServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.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

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`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 SubscriberServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
`SubscriberServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static SubscriberServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`SubscriberServiceStubSettings.Builder`

Constructors

SubscriberServiceStubSettings(SubscriberServiceStubSettings.Builder settingsBuilder)

protected SubscriberServiceStubSettings(SubscriberServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`SubscriberServiceStubSettings.Builder`

Methods

createStub()

public SubscriberServiceStub createStub()

Returns

Type	Description
`SubscriberServiceStub`

Exceptions

Type	Description
`IOException`

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 SubscriberServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
`SubscriberServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()