com.google.cloud.pubsub.spi.v1

Class SubscriberSettings

java.lang.Object

com.google.api.gax.grpc.ServiceApiSettings

com.google.cloud.pubsub.spi.v1.SubscriberSettings

@Generated(value="by GAPIC")
public class SubscriberSettings
extends ServiceApiSettings

Settings class to configure an instance of SubscriberApi.

The default instance has everything set to sensible defaults:

• The default service address (pubsub.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 CreateSubscription to 30 seconds:

 
 SubscriberSettings.Builder subscriberSettingsBuilder =
     SubscriberSettings.defaultBuilder();
 subscriberSettingsBuilder.CreateSubscriptionSettings().getRetrySettingsBuilder()
     .setTotalTimeout(Duration.standardSeconds(30));
 SubscriberSettings subscriberSettings = subscriberSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriberSettings.Builder Builder for SubscriberSettings.

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionSettings	DEFAULT_CONNECTION_SETTINGS The default connection settings of the service.
static java.lang.String	DEFAULT_SERVICE_ADDRESS The default address of the service.
static int	DEFAULT_SERVICE_PORT The default port of the service.
static com.google.common.collect.ImmutableList<java.lang.String>	DEFAULT_SERVICE_SCOPES The default scopes of the service.

Method Summary

Modifier and Type	Method and Description
SimpleCallSettings<AcknowledgeRequest,Empty>	acknowledgeSettings() Returns the object with the settings used for calls to acknowledge.
SimpleCallSettings<Subscription,Subscription>	createSubscriptionSettings() Returns the object with the settings used for calls to createSubscription.
static SubscriberSettings.Builder	defaultBuilder() Returns a builder for this class with recommended defaults.
SimpleCallSettings<DeleteSubscriptionRequest,Empty>	deleteSubscriptionSettings() Returns the object with the settings used for calls to deleteSubscription.
SimpleCallSettings<GetSubscriptionRequest,Subscription>	getSubscriptionSettings() Returns the object with the settings used for calls to getSubscription.
PageStreamingCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,Subscription>	listSubscriptionsSettings() Returns the object with the settings used for calls to listSubscriptions.
SimpleCallSettings<ModifyAckDeadlineRequest,Empty>	modifyAckDeadlineSettings() Returns the object with the settings used for calls to modifyAckDeadline.
SimpleCallSettings<ModifyPushConfigRequest,Empty>	modifyPushConfigSettings() Returns the object with the settings used for calls to modifyPushConfig.
static SubscriberSettings.Builder	newBuilder() Returns a new builder for this class.
SimpleCallSettings<PullRequest,PullResponse>	pullSettings() Returns the object with the settings used for calls to pull.
SubscriberSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

getChannelProvider, getExecutorProvider

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SERVICE_ADDRESS

public static final java.lang.String DEFAULT_SERVICE_ADDRESS

The default address of the service.

See Also:

Constant Field Values

DEFAULT_SERVICE_PORT

public static final int DEFAULT_SERVICE_PORT

The default port of the service.

See Also:

Constant Field Values

DEFAULT_SERVICE_SCOPES

public static final com.google.common.collect.ImmutableList<java.lang.String> DEFAULT_SERVICE_SCOPES

The default scopes of the service.

DEFAULT_CONNECTION_SETTINGS

public static final ConnectionSettings DEFAULT_CONNECTION_SETTINGS

The default connection settings of the service.

Method Detail

createSubscriptionSettings

public SimpleCallSettings<Subscription,Subscription> createSubscriptionSettings()

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

getSubscriptionSettings

public SimpleCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()

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

listSubscriptionsSettings

public PageStreamingCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,Subscription> listSubscriptionsSettings()

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

deleteSubscriptionSettings

public SimpleCallSettings<DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()

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

modifyAckDeadlineSettings

public SimpleCallSettings<ModifyAckDeadlineRequest,Empty> modifyAckDeadlineSettings()

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

acknowledgeSettings

public SimpleCallSettings<AcknowledgeRequest,Empty> acknowledgeSettings()

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

pullSettings

public SimpleCallSettings<PullRequest,PullResponse> pullSettings()

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

modifyPushConfigSettings

public SimpleCallSettings<ModifyPushConfigRequest,Empty> modifyPushConfigSettings()

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

defaultBuilder

public static SubscriberSettings.Builder defaultBuilder()

Returns a builder for this class with recommended defaults.

newBuilder

public static SubscriberSettings.Builder newBuilder()

Returns a new builder for this class.

toBuilder

public SubscriberSettings.Builder toBuilder()

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