Pub/Sub Client Library Configuration Options

Classes
struct	google::cloud::pubsub::RetryPolicyOption
	The retry policy. More...
struct	google::cloud::pubsub::BackoffPolicyOption
	The backoff policy. More...
struct	google::cloud::pubsub::MaxHoldTimeOption
	The maximum hold time for the messages. More...
struct	google::cloud::pubsub::MaxBatchMessagesOption
	The maximum number of messages in a batch. More...
struct	google::cloud::pubsub::MaxBatchBytesOption
	The maximum size for the messages in a batch. More...
struct	google::cloud::pubsub::MaxPendingMessagesOption
	The maximum number of pending messages. More...
struct	google::cloud::pubsub::MaxPendingBytesOption
	The maximum size for pending messages. More...
struct	google::cloud::pubsub::MessageOrderingOption
	Publisher message ordering. More...
struct	google::cloud::pubsub::FullPublisherActionOption
	The action taken by a full publisher. More...
struct	google::cloud::pubsub::CompressionThresholdOption
	Compression threshold. More...
struct	google::cloud::pubsub::CompressionAlgorithmOption
	Compression algorithm. More...
struct	google::cloud::pubsub::MaxDeadlineTimeOption
	The maximum deadline for each incoming message. More...
struct	google::cloud::pubsub::MaxDeadlineExtensionOption
	The maximum time by which the deadline for each incoming message is extended. More...
struct	google::cloud::pubsub::MinDeadlineExtensionOption
	The minimum time by which the deadline for each incoming message is extended. More...
struct	google::cloud::pubsub::MaxOutstandingMessagesOption
	The maximum number of outstanding messages per streaming pull. More...
struct	google::cloud::pubsub::MaxOutstandingBytesOption
	The maximum number of outstanding bytes per streaming pull. More...
struct	google::cloud::pubsub::MaxConcurrencyOption
	The maximum callback concurrency. More...
struct	google::cloud::pubsub::ShutdownPollingPeriodOption
	How often the session polls for automatic shutdowns. More...
struct	google::cloud::pubsub::SubscriptionOption
	Override the default subscription for a request. More...

Typedefs
using	google::cloud::pubsub::SubscriberOptionList = OptionList< MaxDeadlineTimeOption, MaxDeadlineExtensionOption, MinDeadlineExtensionOption, MaxOutstandingMessagesOption, MaxOutstandingBytesOption, MaxConcurrencyOption, ShutdownPollingPeriodOption, SubscriptionOption >
	The list of options specific to subscribers. More...

Functions
Options	google::cloud::pubsub::IAMPolicyOptions (Options opts={})
	Convenience function to initialize a google::cloud::iam::IAMPolicyConnection. More...

Detailed Description

The Pub/Sub client library uses the same mechanism as all other C++ client libraries for configuration. As usual for the C++ client libraries, it adds a number of unique options only applicable for the Pub/Sub library.

See also

Client Library Configuration - for an overview of client library configuration.

Typedef Documentation

SubscriberOptionList

using google::cloud::pubsub::SubscriberOptionList = typedef OptionList<MaxDeadlineTimeOption, MaxDeadlineExtensionOption, MinDeadlineExtensionOption, MaxOutstandingMessagesOption, MaxOutstandingBytesOption, MaxConcurrencyOption, ShutdownPollingPeriodOption, SubscriptionOption>

The list of options specific to subscribers.

Function Documentation

IAMPolicyOptions()

Options google::cloud::pubsub::IAMPolicyOptions

(

Options

opts = {}

)

Convenience function to initialize a google::cloud::iam::IAMPolicyConnection.

To manage the IAM policies of Pub/Sub resources you need to configure the google::cloud::IAMPolicyClient to use pubsub.googleapis.com as the google::cloud::EndpointOption and google::cloud::AuthorityOption.

This function returns an object that is initialized with these values, you can provide additional configuration, or override some of the values before passing the object to google::cloud::iam::MakeIAMPolicyConnection.