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.

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.
Long	computeMaxDurationPerAckExtension(String subscriptionName, String projectId) Computes the upper bound for a single mod ack extension period.
Long	computeMinDurationPerAckExtension(String subscriptionName, String projectId) Computes the lower bound for a single mod ack 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(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName) Computes flow control settings to use.
PubSubConfiguration.FlowControl	computeSubscriberFlowControlSettings(String subscriptionName, String projectId) Deprecated. use computeSubscriberFlowControlSettings(ProjectSubscriptionName)
PubSubConfiguration.Retry	computeSubscriberRetrySettings(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName) Computes the retry settings.
PubSubConfiguration.Retry	computeSubscriberRetrySettings(String subscriptionName, String projectId) Deprecated. Use {computeSubscriberRetrySettings(ProjectSubscriptionName)}
Map<com.google.pubsub.v1.ProjectSubscriptionName,PubSubConfiguration.Subscriber>	getFullyQualifiedSubscriberProperties() Returns an immutable map of subscription properties keyed by the fully-qualified ProjectSubscriptionName.
PubSubConfiguration.Health	getHealth()
PubSubConfiguration.Publisher	getPublisher()
PubSubConfiguration.Subscriber	getSubscriber()
PubSubConfiguration.Subscriber	getSubscriber(String name, String projectId) Deprecated. use getSubscriptionProperties(ProjectSubscriptionName) instead.
PubSubConfiguration.Subscriber	getSubscriptionProperties(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName) Returns properties for the specified fully-qualified ProjectSubscriptionName.
void	initialize(String defaultProjectId) Standardizes all subscription properties to be keyed by their fully qualified subscription names.
void	setSubscription(Map<String,PubSubConfiguration.Subscriber> subscriberProperties) This method will be called by Spring Framework when binding user properties.

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()

setSubscription

public void setSubscription(Map<String,PubSubConfiguration.Subscriber> subscriberProperties)

This method will be called by Spring Framework when binding user properties. Also potentially useful for tests.

Parameters:

subscriberProperties - map of user-defined properties.

getFullyQualifiedSubscriberProperties

public Map<com.google.pubsub.v1.ProjectSubscriptionName,PubSubConfiguration.Subscriber> getFullyQualifiedSubscriberProperties()

Returns an immutable map of subscription properties keyed by the fully-qualified ProjectSubscriptionName.

Cannot be called before initialize(String).

Returns:

map of subscription properties

initialize

public void initialize(String defaultProjectId)

Standardizes all subscription properties to be keyed by their fully qualified subscription names. Not thread-safe.

If a `fully-qualified-name` property is present, it is used as a key for all subscription properties under the same group. Otherwise, the provided configuration group key is assumed to be the short subscription name in the current project.

Parameters:

defaultProjectId - Project to use with short subscription names

getSubscriber

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

Deprecated. use getSubscriptionProperties(ProjectSubscriptionName) instead.

Returns properties for the specified subscription name and project ID.

Parameters:

name - short subscription name

projectId - subscription project name

Returns:

user-provided subscription properties

getSubscriptionProperties

public PubSubConfiguration.Subscriber getSubscriptionProperties(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName)

Returns properties for the specified fully-qualified ProjectSubscriptionName.

Parameters:

projectSubscriptionName - fully-qualified ProjectSubscriptionName

Returns:

user-provided subscription properties

computeSubscriberFlowControlSettings

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

Deprecated. use computeSubscriberFlowControlSettings(ProjectSubscriptionName)

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

computeSubscriberFlowControlSettings

public PubSubConfiguration.FlowControl computeSubscriberFlowControlSettings(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName)

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:

projectSubscriptionName - Fully qualified subscription name

Returns:

flow control settings defaulting to global where not provided

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

computeMinDurationPerAckExtension

@Nullable
public Long computeMinDurationPerAckExtension(String subscriptionName,
                                                        String projectId)

Computes the lower bound for a single mod ack 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:

min duration per ack extension

computeMaxDurationPerAckExtension

@Nullable
public Long computeMaxDurationPerAckExtension(String subscriptionName,
                                                        String projectId)

Computes the upper bound for a single mod ack 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 duration per ack extension

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

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

Deprecated. Use {computeSubscriberRetrySettings(ProjectSubscriptionName)}

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

computeSubscriberRetrySettings

public PubSubConfiguration.Retry computeSubscriberRetrySettings(com.google.pubsub.v1.ProjectSubscriptionName projectSubscriptionName)

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:

projectSubscriptionName - The fully qualified subscription name

Returns:

retry settings