Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/pubsub:v1.ts";

§Classes

GoogleAuth
pubsub

Provides reliable, many-to-many, asynchronous messaging between applications.

§Variables

auth

§Interfaces

AcknowledgeRequest

Request for the Acknowledge method.

AvroConfig

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

AwsKinesis

Ingestion settings for Amazon Kinesis Data Streams.

BigQueryConfig

Configuration for a BigQuery subscription.

Binding

Associates members, or principals, with a role.

CloudStorageConfig

Configuration for a Cloud Storage subscription.

CommitSchemaRequest

Request for CommitSchema method.

CreateSnapshotRequest

Request for the CreateSnapshot method.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

DeadLetterPolicy

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.

DetachSubscriptionResponse

Response for the DetachSubscription method. Reserved for future use.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

ExpirationPolicy

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

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

IngestionDataSourceSettings

Settings for an ingestion data source on a topic.

ListSchemaRevisionsResponse

Response for the ListSchemaRevisions method.

ListSchemasResponse

Response for the ListSchemas method.

ListSnapshotsResponse

Response for the ListSnapshots method.

ListSubscriptionsResponse

Response for the ListSubscriptions method.

ListTopicSnapshotsResponse

Response for the ListTopicSnapshots method.

ListTopicsResponse

Response for the ListTopics method.

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

MessageStoragePolicy

A policy constraining the storage of messages published to the topic.

ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

ModifyPushConfigRequest

Request for the ModifyPushConfig method.

NoWrapper

Sets the data field as the HTTP body for delivery.

OidcToken

Contains information needed for generating an OpenID Connect token.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: ``` bindings: - members:

ProjectsSchemasCreateOptions

Additional options for pubsub#projectsSchemasCreate.

ProjectsSchemasDeleteRevisionOptions

Additional options for pubsub#projectsSchemasDeleteRevision.

ProjectsSchemasGetIamPolicyOptions

Additional options for pubsub#projectsSchemasGetIamPolicy.

ProjectsSchemasGetOptions

Additional options for pubsub#projectsSchemasGet.

ProjectsSchemasListOptions

Additional options for pubsub#projectsSchemasList.

ProjectsSchemasListRevisionsOptions

Additional options for pubsub#projectsSchemasListRevisions.

ProjectsSnapshotsGetIamPolicyOptions

Additional options for pubsub#projectsSnapshotsGetIamPolicy.

ProjectsSnapshotsListOptions

Additional options for pubsub#projectsSnapshotsList.

ProjectsSubscriptionsGetIamPolicyOptions

Additional options for pubsub#projectsSubscriptionsGetIamPolicy.

ProjectsSubscriptionsListOptions

Additional options for pubsub#projectsSubscriptionsList.

ProjectsTopicsGetIamPolicyOptions

Additional options for pubsub#projectsTopicsGetIamPolicy.

ProjectsTopicsListOptions

Additional options for pubsub#projectsTopicsList.

ProjectsTopicsSnapshotsListOptions

Additional options for pubsub#projectsTopicsSnapshotsList.

ProjectsTopicsSubscriptionsListOptions

Additional options for pubsub#projectsTopicsSubscriptionsList.

PublishRequest

Request for the Publish method.

PublishResponse

Response for the Publish method.

PubsubMessage

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

PubsubWrapper

The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

PullRequest

Request for the Pull method.

PullResponse

Response for the Pull method.

PushConfig

Configuration for a push delivery endpoint.

ReceivedMessage

A message and its corresponding acknowledgment ID.

RetryPolicy

A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

RollbackSchemaRequest

Request for the RollbackSchema method.

Schema

A schema resource.

SchemaSettings

Settings for validating messages published against a schema.

SeekRequest

Request for the Seek method.

SeekResponse

Response for the Seek method (this response is empty).

SetIamPolicyRequest

Request message for SetIamPolicy method.

Snapshot

A snapshot resource. 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.

Subscription

A subscription resource. If none of push_config, bigquery_config, or cloud_storage_config is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

TextConfig

Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.

Topic

A topic resource.

UpdateSnapshotRequest

Request for the UpdateSnapshot method.

UpdateSubscriptionRequest

Request for the UpdateSubscription method.

UpdateTopicRequest

Request for the UpdateTopic method.

ValidateMessageRequest

Request for the ValidateMessage method.

ValidateMessageResponse

Response for the ValidateMessage method. Empty for now.

ValidateSchemaRequest

Request for the ValidateSchema method.

ValidateSchemaResponse

Response for the ValidateSchema method. Empty for now.