Class PublisherServiceSettings (1.5.5)

public class PublisherServiceSettings extends ClientSettings<PublisherServiceSettings>

Settings class to configure an instance of PublisherServiceClient.

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 publish to 30 seconds:


 PublisherServiceSettings.Builder publisherServiceSettingsBuilder =
     PublisherServiceSettings.newBuilder();
 publisherServiceSettingsBuilder
     .publishSettings()
     .setRetrySettings(
         publisherServiceSettingsBuilder
             .publishSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PublisherServiceSettings publisherServiceSettings = publisherServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > PublisherServiceSettings

Static Methods

create(PublisherServiceStubSettings stub)

public static final PublisherServiceSettings create(PublisherServiceStubSettings stub)
Parameter
NameDescription
stubPublisherServiceStubSettings
Returns
TypeDescription
PublisherServiceSettings
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 PublisherServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
PublisherServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static PublisherServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
PublisherServiceSettings.Builder

Constructors

PublisherServiceSettings(PublisherServiceSettings.Builder settingsBuilder)

protected PublisherServiceSettings(PublisherServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderPublisherServiceSettings.Builder

Methods

publishSettings()

public StreamingCallSettings<PublishRequest,PublishResponse> publishSettings()

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

Returns
TypeDescription
StreamingCallSettings<PublishRequest,PublishResponse>

toBuilder()

public PublisherServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
PublisherServiceSettings.Builder
Overrides