com.google.cloud.spring.pubsub.core

Class PubSubConfiguration

java.lang.Object

com.google.cloud.spring.pubsub.core.PubSubConfiguration

Direct Known Subclasses:

GcpPubSubProperties

public class PubSubConfiguration
extends Object

Properties for Publisher or Subscriber specific configurations.

Author:

João André Martins, Mike Eltsufin, Chengyuan Zhao, Emmanouil Gkatziouras

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubConfiguration.Batching Batching settings.
static class	PubSubConfiguration.FlowControl flow control settings.
static class	PubSubConfiguration.Health Health Check settings.
static class	PubSubConfiguration.Publisher Publisher settings.
static class	PubSubConfiguration.Retry Retry settings.
static class	PubSubConfiguration.Subscriber Subscriber settings.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXECUTOR_THREADS Default number of executor threads.

Constructor Summary

Constructors

Constructor and Description
PubSubConfiguration()

Method Summary

Modifier and Type	Method and Description
Long	computeMaxAckExtensionPeriod(String subscriptionName, String projectId) Computes the max extension period.
Integer	computeParallelPullCount(String subscriptionName, String projectId) Computes parallel pull count.
String	computePullEndpoint(String subscriptionName, String projectId) Returns the pull endpoint.
com.google.api.gax.rpc.StatusCode.Code[]	computeRetryableCodes(String subscriptionName, String projectId) Retrieves collection of retryable codes from configuration.
PubSubConfiguration.FlowControl	computeSubscriberFlowControlSettings(String subscriptionName, String projectId) Computes flow control settings to use.
PubSubConfiguration.Retry	computeSubscriberRetrySettings(String subscriptionName, String projectId) Computes the retry settings.
PubSubConfiguration.Health	getHealth()
PubSubConfiguration.Publisher	getPublisher()
PubSubConfiguration.Subscriber	getSubscriber()
PubSubConfiguration.Subscriber	getSubscriber(String name, String projectId)
ConcurrentMap<String,PubSubConfiguration.Subscriber>	getSubscription()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXECUTOR_THREADS

public static final int DEFAULT_EXECUTOR_THREADS

Default number of executor threads.

See Also:

Constant Field Values

Constructor Detail

PubSubConfiguration

public PubSubConfiguration()

Method Detail

getSubscriber

public PubSubConfiguration.Subscriber getSubscriber()

getPublisher

public PubSubConfiguration.Publisher getPublisher()

getHealth

public PubSubConfiguration.Health getHealth()

getSubscription

public ConcurrentMap<String,PubSubConfiguration.Subscriber> getSubscription()

getSubscriber

public PubSubConfiguration.Subscriber getSubscriber(String name,
                                                    String projectId)

computeSubscriberFlowControlSettings

public PubSubConfiguration.FlowControl computeSubscriberFlowControlSettings(String subscriptionName,
                                                                            String projectId)

Computes flow control settings to use. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If subscription-specific settings are not set then global settings are picked.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

flow control settings

computeParallelPullCount

public Integer computeParallelPullCount(String subscriptionName,
                                        String projectId)

Computes parallel pull count. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If subscription-specific configuration is not set then the global configuration is picked.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

parallel pull count

computeRetryableCodes

public com.google.api.gax.rpc.StatusCode.Code[] computeRetryableCodes(String subscriptionName,
                                                                      String projectId)

Retrieves collection of retryable codes from configuration. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If subscription-specific configuration is not set then the global configuration is picked.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

retryable codes

computeMaxAckExtensionPeriod

public Long computeMaxAckExtensionPeriod(String subscriptionName,
                                         String projectId)

Computes the max extension period. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If none are set then the default (0) is returned.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

max extension period

computePullEndpoint

public String computePullEndpoint(String subscriptionName,
                                  String projectId)

Returns the pull endpoint. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If subscription-specific configuration is not set then the global configuration is picked.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

pull endpoint

computeSubscriberRetrySettings

public PubSubConfiguration.Retry computeSubscriberRetrySettings(String subscriptionName,
                                                                String projectId)

Computes the retry settings. The subscription-specific property takes precedence if both global and subscription-specific properties are set. If subscription-specific settings are not set then the global settings are picked.

Parameters:

subscriptionName - subscription name

projectId - project id

Returns:

retry settings