SubscriberSettings.Builder

java.lang.Object
- com.google.api.gax.grpc.ServiceApiSettings.Builder
- - com.google.cloud.pubsub.spi.v1.SubscriberSettings.Builder

Enclosing class:: SubscriberSettings

public static class SubscriberSettings.Builder
extends ServiceApiSettings.Builder

Builder for SubscriberSettings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimpleCallSettings.Builder<AcknowledgeRequest,Empty>`	`acknowledgeSettings()` Returns the builder for the settings used for calls to acknowledge.
`SubscriberSettings.Builder`	`applyToAllApiMethods(ApiCallSettings.Builder apiCallSettings)` Applies the given settings to all of the API methods in this service.
`SubscriberSettings`	`build()`
`SimpleCallSettings.Builder<Subscription,Subscription>`	`createSubscriptionSettings()` Returns the builder for the settings used for calls to createSubscription.
`SimpleCallSettings.Builder<DeleteSubscriptionRequest,Empty>`	`deleteSubscriptionSettings()` Returns the builder for the settings used for calls to deleteSubscription.
`SimpleCallSettings.Builder<GetSubscriptionRequest,Subscription>`	`getSubscriptionSettings()` Returns the builder for the settings used for calls to getSubscription.
`PageStreamingCallSettings.Builder<ListSubscriptionsRequest,ListSubscriptionsResponse,Subscription>`	`listSubscriptionsSettings()` Returns the builder for the settings used for calls to listSubscriptions.
`SimpleCallSettings.Builder<ModifyAckDeadlineRequest,Empty>`	`modifyAckDeadlineSettings()` Returns the builder for the settings used for calls to modifyAckDeadline.
`SimpleCallSettings.Builder<ModifyPushConfigRequest,Empty>`	`modifyPushConfigSettings()` Returns the builder for the settings used for calls to modifyPushConfig.
`SubscriberSettings.Builder`	`provideChannelWith(ConnectionSettings settings)` Provides the connection settings necessary to create a channel.
`SubscriberSettings.Builder`	`provideChannelWith(com.google.auth.Credentials credentials)` Provides the credentials necessary to create a channel.
`SubscriberSettings.Builder`	`provideChannelWith(java.util.List<java.lang.String> scopes)` Provides a list of scopes that will be applied to the credentials used to create a channel.
`SubscriberSettings.Builder`	`provideChannelWith(io.grpc.ManagedChannel channel, boolean shouldAutoClose)` Sets a channel for this ServiceApiSettings to use.
`SubscriberSettings.Builder`	`provideExecutorWith(java.util.concurrent.ScheduledExecutorService executor, boolean shouldAutoClose)` Sets the executor to use for channels, retries, and bundling.
`SimpleCallSettings.Builder<PullRequest,PullResponse>`	`pullSettings()` Returns the builder for the settings used for calls to pull.
`SubscriberSettings.Builder`	`setClientLibHeader(java.lang.String name, java.lang.String version)` Sets the client library name and version for the GRPC custom header.
`SubscriberSettings.Builder`	`setGeneratorHeader(java.lang.String name, java.lang.String version)` Sets the generator name and version for the GRPC custom header.

Methods inherited from class com.google.api.gax.grpc.ServiceApiSettings.Builder
getChannelProvider, getClientLibName, getClientLibVersion, getExecutorProvider, getGeneratorName, getGeneratorVersion

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - provideExecutorWith
```
public SubscriberSettings.Builder provideExecutorWith(java.util.concurrent.ScheduledExecutorService executor,
                                                      boolean shouldAutoClose)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Sets the executor to use for channels, retries, and bundling. If multiple Api objects will use this executor, shouldAutoClose must be set to false to prevent the ExecutorProvider from throwing an IllegalStateException. See ExecutorProvider for more details.
    
    Overrides:
    
    provideExecutorWith in class ServiceApiSettings.Builder
  - provideChannelWith
```
public SubscriberSettings.Builder provideChannelWith(io.grpc.ManagedChannel channel,
                                                     boolean shouldAutoClose)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Sets a channel for this ServiceApiSettings to use. This prevents a channel from being created. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or Credentials. See class documentation for more details on channels. If multiple Api objects will use this channel, shouldAutoClose must be set to false to prevent the ChannelProvider from throwing an IllegalStateException. See ChannelProvider for more details.
    
    Overrides:
    
    provideChannelWith in class ServiceApiSettings.Builder
  - provideChannelWith
```
public SubscriberSettings.Builder provideChannelWith(ConnectionSettings settings)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Provides the connection settings necessary to create a channel. This will overwrite any previous calls to provideChannelWith, including calls providing Credentials or a ManagedChannel.
    
    Overrides:
    
    provideChannelWith in class ServiceApiSettings.Builder
  - provideChannelWith
```
public SubscriberSettings.Builder provideChannelWith(com.google.auth.Credentials credentials)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Provides the credentials necessary to create a channel. Other settings required to create the channel will be set to the defaults for the service. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or a ManagedChannel.
    
    Overrides:
    
    provideChannelWith in class ServiceApiSettings.Builder
  - provideChannelWith
```
public SubscriberSettings.Builder provideChannelWith(java.util.List<java.lang.String> scopes)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Provides a list of scopes that will be applied to the credentials used to create a channel. The credentials will be acquired using Application Default Credentials, and the scopes will be applied to the result if that is required from the type of credentials. Other settings required to create the channel will be set to the defaults for the service. This will overwrite any previous calls to provideChannelWith, including calls providing ConnectionSettings or a ManagedChannel.
    
    Overrides:
    
    provideChannelWith in class ServiceApiSettings.Builder
  - setGeneratorHeader
```
public SubscriberSettings.Builder setGeneratorHeader(java.lang.String name,
                                                     java.lang.String version)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Sets the generator name and version for the GRPC custom header.
    
    Overrides:
    
    setGeneratorHeader in class ServiceApiSettings.Builder
  - setClientLibHeader
```
public SubscriberSettings.Builder setClientLibHeader(java.lang.String name,
                                                     java.lang.String version)
```
    Description copied from class: ServiceApiSettings.Builder
    
    Sets the client library name and version for the GRPC custom header.
    
    Overrides:
    
    setClientLibHeader in class ServiceApiSettings.Builder
  - applyToAllApiMethods
```
public SubscriberSettings.Builder applyToAllApiMethods(ApiCallSettings.Builder apiCallSettings)
                                                throws java.lang.Exception
```
    Applies the given settings to all of the API methods in this service. Only values that are non-null will be applied, so this method is not capable of un-setting any values.
    
    Throws:
    
    java.lang.Exception
  - createSubscriptionSettings
```
public SimpleCallSettings.Builder<Subscription,Subscription> createSubscriptionSettings()
```
    Returns the builder for the settings used for calls to createSubscription.
  - getSubscriptionSettings
```
public SimpleCallSettings.Builder<GetSubscriptionRequest,Subscription> getSubscriptionSettings()
```
    Returns the builder for the settings used for calls to getSubscription.
  - listSubscriptionsSettings
```
public PageStreamingCallSettings.Builder<ListSubscriptionsRequest,ListSubscriptionsResponse,Subscription> listSubscriptionsSettings()
```
    Returns the builder for the settings used for calls to listSubscriptions.
  - deleteSubscriptionSettings
```
public SimpleCallSettings.Builder<DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()
```
    Returns the builder for the settings used for calls to deleteSubscription.
  - modifyAckDeadlineSettings
```
public SimpleCallSettings.Builder<ModifyAckDeadlineRequest,Empty> modifyAckDeadlineSettings()
```
    Returns the builder for the settings used for calls to modifyAckDeadline.
  - acknowledgeSettings
```
public SimpleCallSettings.Builder<AcknowledgeRequest,Empty> acknowledgeSettings()
```
    Returns the builder for the settings used for calls to acknowledge.
  - pullSettings
```
public SimpleCallSettings.Builder<PullRequest,PullResponse> pullSettings()
```
    Returns the builder for the settings used for calls to pull.
  - modifyPushConfigSettings
```
public SimpleCallSettings.Builder<ModifyPushConfigRequest,Empty> modifyPushConfigSettings()
```
    Returns the builder for the settings used for calls to modifyPushConfig.
  - build
```
public SubscriberSettings build()
                         throws java.io.IOException
```
    Specified by:
    
    build in class ServiceApiSettings.Builder
    
    Throws:
    
    java.io.IOException

Class SubscriberSettings.Builder

Method Summary

Methods inherited from class com.google.api.gax.grpc.ServiceApiSettings.Builder

Methods inherited from class java.lang.Object

Method Detail

provideExecutorWith

provideChannelWith

provideChannelWith

provideChannelWith

provideChannelWith

setGeneratorHeader

setClientLibHeader

applyToAllApiMethods

createSubscriptionSettings

getSubscriptionSettings

listSubscriptionsSettings

deleteSubscriptionSettings

modifyAckDeadlineSettings

acknowledgeSettings

pullSettings

modifyPushConfigSettings

build