Package 'googlePubsubR'

Title: R Interface for Google 'Cloud Pub/Sub' REST API
Description: Provides an easy to use interface to the 'Google Pub/Sub' REST API <https://cloud.google.com/pubsub/docs/reference/rest>.
Authors: Andrea Dodet [aut, cre]
Maintainer: Andrea Dodet <[email protected]>
License: MIT + file LICENSE
Version: 0.0.4
Built: 2025-03-18 04:51:52 UTC
Source: https://github.com/andodet/googlepubsubr

Help Index

Builds a DeadLetterPolicy Object

Description

Builds a DeadLetterPolicy Object

Usage

DeadLetterPolicy(max_delivery_attempts = NULL, dead_letter_topic = NULL)

Arguments

max_delivery_attempts

numeric The maximum number of delivery attempts for any message
dead_letter_topic

character, Topic The name of the topic to which dead letter messages should be published

Value

DeadLetterPolicy object

See Also

Other Object functions: DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a DqlPolicy object

Description

Builds a DqlPolicy object

Usage

DlqPolicy(dlq_topic, max_delivery_attempts)

Arguments

dlq_topic

character, Topic Required, topic name or instance of a topic object
max_delivery_attempts

numeric Number of delivery attempts for any message. The value must be between 5 and 100.

Value

DlqPolicy object

See Also

Other Object functions: DeadLetterPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a ExpirationPolicy Object

Description

Builds a ExpirationPolicy Object

Usage

ExpirationPolicy(ttl = NULL)

Arguments

ttl

numeric Specifies the 'time-to-live' duration (in seconds, can be float) for an associated resource

Details

Autogenerated via gar_create_api_objects A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

Value

ExpirationPolicy object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a MessageStoragePolicy object

Description

Builds a MessageStoragePolicy object

Usage

MessageStoragePolicy(regions)

Arguments

regions

character A list of IDs of GCP regions

Value

MessageStoragePolicy object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Decode Pub/Sub message

Description

Converts a Pub/Sub message into an object

Usage

msg_decode(x)

Arguments

x

A base64 encoded string

Value

A deserialized object

Examples

## Not run: 
library(jsonlite)

pulled_msgs$receivedMessages$messages$data %>% 
  msg_decode() %>%
  fromJSON()

## End(Not run)

Encode Pub/Sub message

Description

Converts an object into a base64 string

Usage

msg_encode(x)

Arguments

x

A serializeable object

Value

character a base64 encoded string

Examples

## Not run: 
library(jsonlite)

mtcars %>% 
  toJSON(auto_unbox = TRUE) %>%
  msg_encode() %>% 
  PubsubMessage()

## End(Not run)

Get GCP projectId

Description

Get GCP projectId

Usage

ps_project_get()

Value

character A valid GCP projectId, defaults to GCP_PROJECT env var

See Also

Other Auth functions: ps_project_set(), pubsub_auth()

Set GCP projectId

Description

Set GCP projectId

Usage

ps_project_set(project_id)

Arguments

project_id

character A valid GCP projectId

Value

character ProjectId string

See Also

Other Auth functions: ps_project_get(), pubsub_auth()

Examples

## Not run: 
ps_project_set("my-new-project")
# Do whatever...
# Jump back on the default project
ps_project_set(Sys.getenv("GCP_PROJECT"))

## End(Not run)

Authenticate a Pub/Sub client

Description

Authenticate a Pub/Sub client

Usage

pubsub_auth(
  json_file = Sys.getenv("GCP_AUTH_FILE"),
  token = NULL,
  email = NULL
)

Arguments

json_file

character Path of the JSON file containing credentials for a GCP service account
token

character An existing authentication token
email

character The email to default authentication to

Value

None, called for side effects

See Also

Other Auth functions: ps_project_get(), ps_project_set()

Builds a PubsubMessage Object

Description

Builds a PubsubMessage Object

Usage

PubsubMessage(
  data = NULL,
  message_id = NULL,
  ordering_key = NULL,
  attributes = NULL,
  publish_time = NULL
)

Arguments

data

character The message data field as a base64 encoded string
message_id

character ID of this message, assigned by the server when the message is published
ordering_key

character If non-empty, identifies related messages for which publish order should be respected
attributes

list Key-value pairs attributes for this message
publish_time

character The time at which the message was published, populated by the server when it receives the Publish call

Value

PubsubMessage object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a PushConfig Object

Description

Builds a PushConfig Object

Usage

PushConfig(attributes = NULL, push_endpoint = NULL, oidcToken = NULL)

Arguments

attributes

list The attributes object or list of objects
push_endpoint

character A URL locating the endpoint to which messages should be pushed
oidcToken

character If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message

Value

PushConfig object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a retry policy object

Description

More on this here

Usage

RetryPolicy(min_backoff = 600, max_backoff = 600)

Arguments

min_backoff

numeric The minimum delay between consecutive deliveries of a given message
max_backoff

numeric The maximum delay between consecutive deliveries of a given message

Value

RetryPolicy object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), SchemaSettings(), Schema(), Snapshot(), Subscription(), Topic()

Builds a Schema Object

Description

Builds a Schema Object

Usage

Schema(type = NULL, definition = NULL, name = NULL)

Arguments

type

character The type of the schema definition
definition

character The definition of the schema
name

character The schema name

Value

Schema object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Snapshot(), Subscription(), Topic()

Creates a schema

Description

Creates a schema

Usage

schemas_create(
  name,
  type = c("AVRO", "PROTOCOL_BUFFER", "TYPE_UNSPECIFIED"),
  definition,
  project = ps_project_get()
)

Arguments

name

character, Schema Required, schema name or instance of a schema object
type

character Type of the schema definition
definition

character Required, the definition of the schema
project

character GCP project id

Value

a Schema object

See Also

Other Schema functions: schemas_delete(), schemas_exists(), schemas_get(), schemas_list(), schemas_validate_message(), schemas_validate()

Deletes a schema

Description

Deletes a schema

Usage

schemas_delete(name)

Arguments

name

character, Schema Schema name or instance of a schema object

Value

None, called for side effects

See Also

Other Schema functions: schemas_create(), schemas_exists(), schemas_get(), schemas_list(), schemas_validate_message(), schemas_validate()

Check if a schema exists

Description

Check if a schema exists

Usage

schemas_exists(schema)

Arguments

schema

character, Schema Required, schema name or an instance of a Schema object

Value

logical TRUE if the schema exists

See Also

Other Schema functions: schemas_create(), schemas_delete(), schemas_get(), schemas_list(), schemas_validate_message(), schemas_validate()

Gets a schema

Description

Gets a schema

Usage

schemas_get(schema, view = c("SCHEMA_VIEW_UNSPECIFIED", "BASIC", "FULL"))

Arguments

schema

character, Schema Required, schema name or an instance of a Schema object
view

character The set of fields to return in the response

Value

A Schema object

See Also

Other Schema functions: schemas_create(), schemas_delete(), schemas_exists(), schemas_list(), schemas_validate_message(), schemas_validate()

Lists all schemas in a project

Description

Lists all schemas in a project

Usage

schemas_list(
  project = ps_project_get(),
  pageSize = NULL,
  view = c("SCHEMA_VIEW_UNSPECIFIED", "BASIC", "FULL"),
  pageToken = NULL
)

Arguments

project

character GCP project id
pageSize

numeric Maximum number of schemas to return
view

list The set of Schema fields to return in the response
pageToken

character The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data

Value

A data.frame containing all schema objects and properties

See Also

Other Schema functions: schemas_create(), schemas_delete(), schemas_exists(), schemas_get(), schemas_validate_message(), schemas_validate()

Validates a schema

Description

Validates a schema

Usage

schemas_validate(schema, project = ps_project_get())

Arguments

schema

Schema Required, an instance of a Schema object
project

character GCP project id

Value

logical TRUE if successfully validated

See Also

Other Schema functions: schemas_create(), schemas_delete(), schemas_exists(), schemas_get(), schemas_list(), schemas_validate_message()

Validates a message against a schema

Description

Validates a message against a schema

Usage

schemas_validate_message(
  schema,
  message,
  encoding = c("ENCODING_UNSPECIFIED", "JSON", "BINARY"),
  project = ps_project_get()
)

Arguments

schema

character, Schema Required, schema name or instance of a Schema object
message

PubsubMessage Required, an instance of a PubsubMessage, can be created using PubsubMessage
encoding

character The encoding of the message
project

character A GCP project id

Value

logical TRUE if successfully validated

See Also

Other Schema functions: schemas_create(), schemas_delete(), schemas_exists(), schemas_get(), schemas_list(), schemas_validate()

SchemaSettings Object

Description

SchemaSettings Object

Usage

SchemaSettings(encoding = NULL, schema = NULL)

Arguments

encoding

character The encoding of messages validated against schema
schema

⁠Schema, character⁠ Required, schema object or schema name

Value

SchemaSettings object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), Schema(), Snapshot(), Subscription(), Topic()

Builds a Snapshot Object

Description

Builds a Snapshot Object

Usage

Snapshot(topic = NULL, expire_time = NULL, name = NULL, labels = NULL)

Arguments

topic

character, Topic The name of the topic from which this snapshot is retaining messages
expire_time

character The snapshot is guaranteed to exist up until this time
name

character The name of the snapshot
labels

list Key-value pairs for topic labels

Value

Snapshot object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Subscription(), Topic()

Creates a snapshot from the requested subscription

Description

Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old – and the resulting snapshot would expire in less than 1 hour – then FAILED_PRECONDITION is returned. See also the Snapshot.expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must

Usage

snapshots_create(name, subscription, labels = NULL)

Arguments

name

Snapshot, character Required, an instance of a Snapshot object or a snapshot name
subscription

Subscription, character Required, an instance of a Subscription object or a subscription name
labels

list Key-value pairs for snapshot labels

Value

An instance of a Snapshot object

See Also

Other Snapshot functions: snapshots_delete(), snapshots_exists(), snapshots_list(), snapshots_patch()

Removes an existing snapshot

Description

Removes an existing snapshot

Usage

snapshots_delete(snapshot)

Arguments

snapshot

Snapshot, character Required, an instance of a Snapshot object or a object or a subscription name

Value

None, called for side effects

See Also

Other Snapshot functions: snapshots_create(), snapshots_exists(), snapshots_list(), snapshots_patch()

Check if a snapshot exists

Description

Check if a snapshot exists

Usage

snapshots_exists(snapshot)

Arguments

snapshot

character, Snapshot Required, snapshot name or an instance of a Snapshot object

Value

logical TRUE if snapshot exists

See Also

Other Snapshot functions: snapshots_create(), snapshots_delete(), snapshots_list(), snapshots_patch()

Gets the configuration details of a snapshot

Description

Gets the configuration details of a snapshot

Usage

snapshots_get(snapshot)

Arguments

snapshot

Snapshot, character Required, an instance of a Snapshot object or a snapshot name

Value

An instance of a Snapshot object

Lists the existing snapshots

Description

Lists the existing snapshots

Usage

snapshots_list(project = ps_project_get(), pageSize = NULL, pageToken = NULL)

Arguments

project

character a GCP project ID
pageSize

numeric Maximum number of snapshots to return
pageToken

character The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data

Value

A data.frame containing all snapshots

See Also

Other Snapshot functions: snapshots_create(), snapshots_delete(), snapshots_exists(), snapshots_patch()

Updates an existing snapshot

Description

Updates an existing snapshot

Usage

snapshots_patch(snapshot, topic = NULL, expire_time = NULL, labels = NULL)

Arguments

snapshot

Snapshot, character Required, an instance of a Snapshot object or a snapshot name
topic

character, Topic Topic name or instance of a topic object
expire_time

string The snapshot is guaranteed to exist up until this time. Must be formatted in RFC3339 UTC "Zulu" format
labels

list Key-value pairs for topic labels

Value

An instance the patched Snapshot object

See Also

Other Snapshot functions: snapshots_create(), snapshots_delete(), snapshots_exists(), snapshots_list()

Builds a Subscription Object

Description

Builds a Subscription Object

Usage

Subscription(
  dead_letter_policy = NULL,
  msg_retention_duration = NULL,
  labels = NULL,
  retry_policy = NULL,
  push_config = NULL,
  ack_deadline = NULL,
  expiration_policy = NULL,
  filter = NULL,
  detached = NULL,
  retain_acked_msgs = NULL,
  topic = NULL,
  name = NULL,
  enable_msg_ordering = NULL,
  topic_msg_retention = NULL
)

Arguments

dead_letter_policy

DeadLetterPolicy A policy that specifies the conditions for dead lettering messages in this subscription
msg_retention_duration

character How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published
labels

list See Creating and managing labels
retry_policy

RetryPolicy A policy that specifies how Pub/Sub retries message delivery for this subscription
push_config

PushConfig If push delivery is used with this subscription, this field is used to configure it
ack_deadline

character The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message
expiration_policy

ExpirationPolicy A policy that specifies the conditions for this subscription's expiration
filter

character An expression written in the Pub/Sub filter language
detached

logical Indicates whether the subscription is detached from its topic
retain_acked_msgs

logical Indicates whether to retain acknowledged messages
topic

character, Topic A Topic object or topic name
name

character A name for the subscription
enable_msg_ordering

logical If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system
topic_msg_retention

character minimum duration for which a message is retained after it is published to the subscription's topic

Value

Subscription object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Topic()

Acknowledges the messages

Description

The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Usage

subscriptions_ack(ack_ids, subscription)

Arguments

ack_ids

character A vector containing one or more message ackIDs
subscription

character, Subscription Required, the subscription whose messages are being acknowledged

Value

logical TRUE if message(s) was successfully acknowledged

See Also

Other Subscription functions: subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Creates a subscription to a given topic

Description

Creates a subscription to a given topic

Usage

subscriptions_create(
  name,
  topic,
  dead_letter_policy = NULL,
  msg_retention_duration = NULL,
  labels = NULL,
  retry_policy = NULL,
  push_config = NULL,
  ack_deadline = NULL,
  expiration_policy = NULL,
  filter = NULL,
  detached = NULL,
  retain_acked_messages = NULL,
  enable_msg_ordering = NULL
)

Arguments

name

character Required, name of the subscription to be created
topic

Topic, character Required, an instance of a Topic object or a topic name
dead_letter_policy

DeadLetterPolicy A policy object that specifies the conditions for dead lettering messages in this subscription
msg_retention_duration

string How long to retain unacknowledged messages in the subscription's backlog in seconds
labels

list Key-value pairs for snapshot labels
retry_policy

RetryPolicy A RetryPolicy object that specifies how Pub/Sub retries message delivery for this subscription
push_config

PushConfig A PushConfig object
ack_deadline

numeric The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
expiration_policy

ExpirationPolicy A policy object that specifies the conditions for this subscription's expiration
filter

character An expression written in the Pub/Sub filter language
detached

logical Indicates whether the subscription is detached from its topic
retain_acked_messages

logical Indicates whether to retain acknowledged messages
enable_msg_ordering

logical If true, messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system

Value

A Subscription object

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Deletes an existing subscription.

Description

All messages retained in the subscription will be immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Usage

subscriptions_delete(subscription)

Arguments

subscription

character, Subscription Required, subscription name or instance of a Subscription object

Value

None, called for side effects

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Detaches a subscription from a topic.

Description

Detaches a subscription from a topic.

Usage

subscriptions_detach(subscription)

Arguments

subscription

character, Subscription Required, subscription name or instance of a Subscription object

Value

logical, TRUE if successfully detached

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Check if a subscription exists

Description

Check if a subscription exists

Usage

subscriptions_exists(subscription)

Arguments

subscription

character, Subscription Required, subscription name or instance of a Subscription object

Value

logical TRUE if the subscription exist

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Gets the configuration details of a subscription.

Description

Gets the configuration details of a subscription.

Usage

subscriptions_get(subscription)

Arguments

subscription

character, Subscription Required, subscription name or instance of a Subscription object

Value

A Subscription object

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

List subscriptions

Description

List subscriptions

Usage

subscriptions_list(
  project = Sys.getenv("GCP_PROJECT"),
  pageSize = NULL,
  pageToken = NULL
)

Arguments

project

character Required, GCP project id
pageSize

numeric Maximum number of subscriptions to return
pageToken

character The value returned by the last subscriptions_list; indicates that this is a continuation of a prior subscriptions_list call

Value

list A list containing all subscriptions

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Modify the ack deadline for a subscription

Description

This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

Usage

subscriptions_modify_ack_deadline(subscription, ack_ids, ack_deadline)

Arguments

subscription

character, Subscription A subscription name or Subscription object
ack_ids

character A vector containing ackIDs. They can be acquired using
ack_deadline

numeric The new ack deadline (in seconds)

Value

logical TRUE if successfully modified

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Modify PushConfig for a subscription

Description

Modify PushConfig for a subscription

Usage

subscriptions_modify_pushconf(subscription, push_config)

Arguments

subscription

character, Subscription Required, a subscription name or a Subscription object
push_config

PushConfig New PushConfig object, can be built using PushConfig

Value

logical, TRUE if successfully modified

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_patch(), subscriptions_pull(), subscriptions_seek()

Updates an existing subscription.

Description

Certain properties of a subscription, such as its topic, are not modifiable.

Usage

subscriptions_patch(
  subscription,
  topic,
  labels = NULL,
  dead_letter_policy = NULL,
  msg_retention_duration = NULL,
  retry_policy = NULL,
  push_config = NULL,
  ack_deadline = NULL,
  expiration_policy = NULL,
  filter = NULL,
  detached = NULL,
  retain_acked_msgs = NULL,
  enable_ordering = NULL
)

Arguments

subscription

character, Subscription Required, a subscription name or a Subscription object
topic

character, Topic Required, a topic name or a Topic object
labels

labels Key value pairs
dead_letter_policy

DeadLetterPolicy A DeadLetterPolicy object
msg_retention_duration

numeric How long to retain unacknowledged messages (in seconds)
retry_policy

RetryPolicy policy that specifies how Pub/Sub retries message delivery for this subscription, can be built with RetryPolicy
push_config

PushConfig Can be built with PushConfig
ack_deadline

numeric amount of time (in seconds) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message
expiration_policy

ExpirationPolicy specifies the conditions for this subscription's expiration. Can be built with ExpirationPolicy
filter

character An expression written in the Pub/Sub filter language
detached

logical Indicates whether the subscription is detached from its topic
retain_acked_msgs

logical Indicates whether to retain acknowledged messages
enable_ordering

logicalmessages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system

Value

An updated Subscription object

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_pull(), subscriptions_seek()

Pulls messages from the server.

Description

Pulls messages from the server.

Usage

subscriptions_pull(subscription, max_messages = 100)

Arguments

subscription

character, Subscription Required, subscription where to pull messages from
max_messages

numeric Maximum number of messages to return

Value

A named list with pulled messages

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_seek()

Seek a subscription to a point in time

Description

A subscription can be seeked to a point in time or to a given snapshot.

Usage

subscriptions_seek(subscription, time = NULL, snapshot = NULL)

Arguments

subscription

character, Subscription Required, a snapshot name or a Snapshot object
time

character A timestamp in RFC3339 UTC "Zulu" format
snapshot

character, Snapshot A Snapshot name or a Snapshot object

Value

logical TRUE when succesfull seeked

See Also

Other Subscription functions: subscriptions_ack(), subscriptions_create(), subscriptions_delete(), subscriptions_detach(), subscriptions_exists(), subscriptions_get(), subscriptions_list(), subscriptions_modify_ack_deadline(), subscriptions_modify_pushconf(), subscriptions_patch(), subscriptions_pull()

Builds a Topic Object

Description

Builds a Topic Object

Usage

Topic(
  labels = NULL,
  name = NULL,
  kms_key_name = NULL,
  satisfies_pzs = NULL,
  message_storage_policy = NULL,
  schema_settings = NULL,
  message_retention_duration = NULL
)

Arguments

labels

list Key-value pairs for topic labels
name

character Name of the topic
kms_key_name

character The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic
satisfies_pzs

logical Reserved for future use
message_storage_policy

MessageStoragePolicy Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored
schema_settings

SchemaSettings Settings for validating messages published against a schema
message_retention_duration

character Indicates the minimum duration to retain a message after it is published to the topic

Value

Topic object

See Also

Other Object functions: DeadLetterPolicy(), DlqPolicy(), ExpirationPolicy(), MessageStoragePolicy(), PubsubMessage(), PushConfig(), RetryPolicy(), SchemaSettings(), Schema(), Snapshot(), Subscription()

Creates a pub/sub topic

Description

Creates a pub/sub topic

Usage

topics_create(
  name,
  labels = NULL,
  kms_key_name = NULL,
  satisfies_pzs = NULL,
  message_storage_policy = NULL,
  schema_settings = NULL,
  message_retention_duration = NULL
)

Arguments

name

character, Topic Required, topic name or instance of a topic object
labels

list Key-value pairs for topic labels
kms_key_name

character The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
satisfies_pzs

logical Reserved for future use.
message_storage_policy

MessageStorePolicy An instance of a MessageStorePolicy object Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored
schema_settings

SchemaSettings An instance of a SchemaSettings object
message_retention_duration

numeric Indicates the minimum duration (in seconds) to retain a message after it is published to the topic

Value

A Topic object representing the freshly created topic

See Also

Other Topic functions: topics_delete(), topics_exists(), topics_get(), topics_list_subscriptions(), topics_list(), topics_patch(), topics_publish()

Deletes a pub/sub topic

Description

Deletes a pub/sub topic

Usage

topics_delete(topic)

Arguments

topic

character, Topic Required, topic name or instance of a Topic object

Value

None, called for side effects

See Also

Other Topic functions: topics_create(), topics_exists(), topics_get(), topics_list_subscriptions(), topics_list(), topics_patch(), topics_publish()

Check if a topic exists

Description

Check if a topic exists

Usage

topics_exists(topic, project = ps_project_get())

Arguments

topic

character, Topic Required, topic name or instance of a topic object
project

character GCP project id

Value

logical, TRUE if topic exists, FALSE otherwise

See Also

Other Topic functions: topics_create(), topics_delete(), topics_get(), topics_list_subscriptions(), topics_list(), topics_patch(), topics_publish()

Gets a topic configuration

Description

Gets a topic configuration

Usage

topics_get(topic)

Arguments

topic

character, Topic Required, topic name or instance of a Topic

Value

Topic, A Topic object

See Also

Other Topic functions: topics_create(), topics_delete(), topics_exists(), topics_list_subscriptions(), topics_list(), topics_patch(), topics_publish()

Lists topics from project

Description

Lists topics from project

Usage

topics_list(project = ps_project_get(), pageSize = NULL, pageToken = NULL)

Arguments

project

character GCP project id
pageSize

numeric Maximum number of topics to return
pageToken

character The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

Value

A list of topics

See Also

Other Topic functions: topics_create(), topics_delete(), topics_exists(), topics_get(), topics_list_subscriptions(), topics_patch(), topics_publish()

List attached subscriptions to a topic.

Description

List attached subscriptions to a topic.

Usage

topics_list_subscriptions(topic, pageToken = NULL, pageSize = NULL)

Arguments

topic

Topic, character Required, an instance of a Topic object or a topic name
pageToken

character The value returned by the last response; indicates that this is a continuation of a prior topics_list_subscriptions() paged call, and that the system should return the next page of data
pageSize

numeric Maximum number of subscription names to return

Value

A character vector

See Also

Other Topic functions: topics_create(), topics_delete(), topics_exists(), topics_get(), topics_list(), topics_patch(), topics_publish()

Updates an existing topic

Description

Updates an existing topic

Usage

topics_patch(
  topic,
  labels = NULL,
  message_storage_policy = NULL,
  kms_key_name = NULL,
  schema_settings = NULL,
  satisfies_pzs = NULL,
  message_retention_duration = NULL
)

Arguments

topic

character, Topic Required, topic name or instance of a Topic object
labels

list Key-value pairs for topic labels
message_storage_policy

MessageStoragePolicy Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
kms_key_name

character The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
schema_settings

SchemaSettings An instance of a SchemaSettings object
satisfies_pzs

logical Reserved for future use.
message_retention_duration

character Indicates the minimum duration to retain a message after it is published to the topic.

Value

An instance of the patched Topic

See Also

Other Topic functions: topics_create(), topics_delete(), topics_exists(), topics_get(), topics_list_subscriptions(), topics_list(), topics_publish()

Adds one or more messages to the topic

Description

Adds one or more messages to the topic

Usage

topics_publish(messages, topic)

Arguments

messages

list Required, a list containing the messages to be published
topic

Topic, character Required, an instance of a Topic object or a topic name

Value

A character vector containing message IDs

See Also

Other Topic functions: topics_create(), topics_delete(), topics_exists(), topics_get(), topics_list_subscriptions(), topics_list(), topics_patch()