Google CloudGoogle Cloud
  • Google Cloud
  • Why Google
    • Groundbreaking solutions. Transformative know-how.
    • Whether your business is early in its journey or well on its way to digital transformation, Google Cloud's solutions and technologies help chart a path to success.
    • Learn more
    • Why Google Cloud
    • Choosing Google Cloud
      Reasons why people choose us
    • Trust and security
      Keep your data secure and compliant
    • Open cloud
      Scale with open, flexible technology
    • Customers and case studies
      Learn how businesses use Google Cloud
    • Analyst reports
      See how Google Cloud ranks
    • close
    • Data centers and network
      Build on the same infrastructure Google uses
    • Partners
      Tap into our global ecosystem of cloud experts
    • Google Cloud Blog
      Read the latest stories and product updates
    • Events
      Join events and learn more about Google Cloud
  • Solutions
    • By business need
    • Infrastructure modernization
      Modernize enterprise workloads
    • Data management
      Manage data securely, reliably and at scale
    • Application development
      Build and run apps on an open, secure cloud
    • Smart business analytics and AI
      Generate insights with analytics, ML, and AI
    • Productivity and work transformation
      Transform how people work together
    • Device management
    • By industry
    • Education
    • Energy
    • Financial services
    • Gaming
    • Government
    • Healthcare
    • Life sciences
    • Telecommunications, Media & Entertainment
    • Retail
    • close
    • By role
    • DevOps
    • HR and recruiting
    • Marketing
    • Small business owners
    • See all solutions
  • Products
    • Google Cloud Platform
    • AI and machine learning
    • Text-to-Speech
    • Vision
    • Translation
    • More
    • API management
    • Apigee API Platform
    • Cloud Endpoints
    • More
    • Compute
    • Compute Engine
    • App Engine
    • More
    • Data analytics
    • BigQuery
    • Cloud Datalab
    • More
    • Databases
    • Cloud SQL
    • Cloud Datastore
    • More
    • Developer Tools
    • Container Registry
    • Cloud SDK
    • More
    • Hybrid and multi-cloud
    • Anthos
    • GKE On-Prem
    • Istio on GKE
    • More
    • Internet of Things
    • Cloud IoT Core
    • Edge TPU
    • Migration
    • Data Transfer
    • Transfer Appliance
    • More
    • Networking
    • DNS
    • CDN
    • Virtual Private Cloud
    • More
    • Security
    • Security Key Enforcement
    • Cloud IAM
    • More
    • Storage
    • Cloud Storage
    • Persistent Disk
    • More
    • close
    • More Cloud Products
    • G Suite
      Gmail, Docs, Drive, Hangouts, and more
    • Google Maps Platform
      Build with real-time, comprehensive data
    • Cloud Identity
      Easily manage user identities
    • Chrome Enterprise
      Get Chrome OS devices and browser
    • Android Enterprise
      Intelligent devices, OS, and business apps
    • Hire by Google
      Identify, evaluate, and hire better
    • See all products (100+)
  • Pricing
    • Do more for less with Google Cloud
    • Our customer-friendly pricing means more overall value to your business.
    • Contact sales
    • Google Cloud Platform
    • Overview
      Pay only for what you use with no lock-in
    • Price list
      Pricing details on each GCP product
    • Calculators
      Calculate your cloud savings
    • Free on GCP
      Learn and build on GCP for free
    • close
    • More Cloud Products
    • G Suite
    • Google Maps Platform
    • Cloud Identity
    • Hire by Google
    • Apigee
    • Firebase
    • Zync Render
  • Getting started
    • Get started with Google Cloud
    • Start building right away on our secure, intelligent platform. New customers can use a $300 free credit to get started with any GCP product.
    • Try GCP Free
    • Go to console
    • Resources to Start on Your Own
    • Quickstarts
      View short tutorials to help you get started
    • GCP Marketplace
      Deploy ready-to-go solutions in a few clicks
    • Training
      Enroll in on-demand or classroom training
    • Certification
      Become Google Cloud Certified
    • close
    • Get Help from an Expert
    • Consulting
      Jump-start your project with help from Google
    • Technical Account Management
      Get long-term guidance from Google
    • Find a Partner
      Work with a Partner in our global network
    • Become a Partner
      Join Google Cloud's Partner program
    • More ways to get started
  • Docs
  • Support
Console
 Sign in
  • Docs
More
Contact sales Get started for free
  • Google Cloud
  • Why Google
  • Solutions
  • Products
  • Pricing
  • Getting started
  • Docs More
  • Support
  • Console
  • Groundbreaking solutions. Transformative know-how.
  • Learn more
  • Why Google Cloud
  • Choosing Google Cloud
  • Trust and security
  • Open cloud
  • Customers and case studies
  • Analyst reports
  • close
  • Data centers and network
  • Partners
  • Google Cloud Blog
  • Events
  • By business need
  • Infrastructure modernization
  • Data management
  • Application development
  • Smart business analytics and AI
  • Productivity and work transformation
  • Device management
  • By industry
  • Education
  • Energy
  • Financial services
  • Gaming
  • Government
  • Healthcare
  • Life sciences
  • Telecommunications, Media & Entertainment
  • Retail
  • close
  • By role
  • DevOps
  • HR and recruiting
  • Marketing
  • Small business owners
  • See all solutions
  • Google Cloud Platform
  • AI and machine learning
  • Text-to-Speech
  • Vision
  • Translation
  • More
  • API management
  • Apigee API Platform
  • Cloud Endpoints
  • More
  • Compute
  • Compute Engine
  • App Engine
  • More
  • Data analytics
  • BigQuery
  • Cloud Datalab
  • More
  • Databases
  • Cloud SQL
  • Cloud Datastore
  • More
  • Developer Tools
  • Container Registry
  • Cloud SDK
  • More
  • Hybrid and multi-cloud
  • Anthos
  • GKE On-Prem
  • Istio on GKE
  • More
  • Internet of Things
  • Cloud IoT Core
  • Edge TPU
  • Migration
  • Data Transfer
  • Transfer Appliance
  • More
  • Networking
  • DNS
  • CDN
  • Virtual Private Cloud
  • More
  • Security
  • Security Key Enforcement
  • Cloud IAM
  • More
  • Storage
  • Cloud Storage
  • Persistent Disk
  • More
  • close
  • More Cloud Products
  • G Suite
  • Google Maps Platform
  • Cloud Identity
  • Chrome Enterprise
  • Android Enterprise
  • Hire by Google
  • See all products (100+)
  • Do more for less with Google Cloud
  • Contact sales
  • Google Cloud Platform
  • Overview
  • Price list
  • Calculators
  • Free on GCP
  • close
  • More Cloud Products
  • G Suite
  • Google Maps Platform
  • Cloud Identity
  • Hire by Google
  • Apigee
  • Firebase
  • Zync Render
  • Get started with Google Cloud
  • Try GCP Free
  • Go to console
  • Resources to Start on Your Own
  • Quickstarts
  • GCP Marketplace
  • Training
  • Certification
  • close
  • Get Help from an Expert
  • Consulting
  • Technical Account Management
  • Find a Partner
  • Become a Partner
  • More ways to get started
  • APIs and libraries
  • Latest Reference Docs
  • @google-cloud/pubsub (legacy)
    • 0.28.x (latest)
      • Overview
      • About the NPM package
      • Classes
        • BatchError
        • ChannelError
        • IAM
        • Message
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.27.x
      • Overview
      • About the NPM package
      • Classes
        • BatchError
        • ChannelError
        • IAM
        • Message
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.26.x
      • Overview
      • About the NPM package
      • Classes
        • BatchError
        • ChannelError
        • IAM
        • Message
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.25.x
      • Overview
      • About the NPM package
      • Classes
        • BatchError
        • ChannelError
        • IAM
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.24.x
      • Overview
      • About the NPM package
      • Classes
        • BatchError
        • ChannelError
        • IAM
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.23.x
      • Overview
      • About the NPM package
      • Classes
        • IAM
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • StatusError
        • v1.SubscriberClient
        • Subscription
        • Topic
      • RPC Message Types
        • google.protobuf
        • google.pubsub.v1
      • Other Abstract Types
      • Index of all
    • 0.22.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
    • 0.20.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
    • 0.19.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
    • 0.18.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
    • 0.17.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
    • 0.16.x
      • Overview
      • About the NPM package
      • Classes
        • Iam
        • Publisher
        • v1.PublisherClient
        • PubSub
        • Snapshot
        • v1.SubscriberClient
        • Subscription
        • Topic
      • Other Abstract Types
      • Index of all
  • Documentation
  • Node.js
  • Docs

Index All

  • BatchError
  • ChannelError
  • ConnectionPool#createMessage
  • IAM
  • IAM#getPolicy
  • IAM#setPolicy
  • IAM#testPermissions
  • PubSub
  • PubSub#createSubscription
  • PubSub#createTopic
  • PubSub#getSnapshots
  • PubSub#getSnapshotsStream
  • PubSub#getSubscriptions
  • PubSub#getSubscriptionsStream
  • PubSub#getTopics
  • PubSub#getTopicsStream
  • PubSub#isEmulator
  • PubSub#snapshot
  • PubSub#subscription
  • PubSub#topic
  • PubSub.v1
  • Snapshot
  • Snapshot#create
  • Snapshot#delete
  • Snapshot#seek
  • StatusError
  • Subscription
  • Subscription#iam
  • Subscription#isOpen
  • Subscription#open
  • Subscription#projectId
  • Subscription#setOptions
  • Subscription#snapshot
  • Topic
  • Topic#exists
  • Topic#iam
  • Topic#name
  • Topic#parent
  • Topic#pubsub
  • Topic#setPublishOptions
  • Topic#subscription
  • google.protobuf
  • google.protobuf.Duration
  • google.protobuf.Empty
  • google.protobuf.FieldMask
  • google.protobuf.Timestamp
  • google.pubsub.v1
  • google.pubsub.v1.AcknowledgeRequest
  • google.pubsub.v1.CreateSnapshotRequest
  • google.pubsub.v1.DeleteSnapshotRequest
  • google.pubsub.v1.DeleteSubscriptionRequest
  • google.pubsub.v1.DeleteTopicRequest
  • google.pubsub.v1.ExpirationPolicy
  • google.pubsub.v1.GetSnapshotRequest
  • google.pubsub.v1.GetSubscriptionRequest
  • google.pubsub.v1.GetTopicRequest
  • google.pubsub.v1.ListSnapshotsRequest
  • google.pubsub.v1.ListSnapshotsResponse
  • google.pubsub.v1.ListSubscriptionsRequest
  • google.pubsub.v1.ListSubscriptionsResponse
  • google.pubsub.v1.ListTopicSnapshotsRequest
  • google.pubsub.v1.ListTopicSnapshotsResponse
  • google.pubsub.v1.ListTopicSubscriptionsRequest
  • google.pubsub.v1.ListTopicSubscriptionsResponse
  • google.pubsub.v1.ListTopicsRequest
  • google.pubsub.v1.ListTopicsResponse
  • google.pubsub.v1.MessageStoragePolicy
  • google.pubsub.v1.ModifyAckDeadlineRequest
  • google.pubsub.v1.ModifyPushConfigRequest
  • google.pubsub.v1.PublishRequest
  • google.pubsub.v1.PublishResponse
  • google.pubsub.v1.PubsubMessage
  • google.pubsub.v1.PullRequest
  • google.pubsub.v1.PullResponse
  • google.pubsub.v1.PushConfig
  • google.pubsub.v1.ReceivedMessage
  • google.pubsub.v1.SeekRequest
  • google.pubsub.v1.SeekResponse
  • google.pubsub.v1.Snapshot
  • google.pubsub.v1.StreamingPullRequest
  • google.pubsub.v1.StreamingPullResponse
  • google.pubsub.v1.Subscription
  • google.pubsub.v1.Topic
  • google.pubsub.v1.UpdateSnapshotRequest
  • google.pubsub.v1.UpdateSubscriptionRequest
  • google.pubsub.v1.UpdateTopicRequest
  • module:@google-cloud/pubsub
  • module:@google-cloud/pubsub.v1
  • package:@google-cloud/pubsub
  • v1.PublisherClient
  • v1.PublisherClient#createTopic
  • v1.PublisherClient#deleteTopic
  • v1.PublisherClient#getIamPolicy
  • v1.PublisherClient#getProjectId
  • v1.PublisherClient#getTopic
  • v1.PublisherClient#listTopicSubscriptions
  • v1.PublisherClient#listTopicSubscriptionsStream
  • v1.PublisherClient#listTopics
  • v1.PublisherClient#listTopicsStream
  • v1.PublisherClient#matchProjectFromProjectName
  • v1.PublisherClient#matchProjectFromTopicName
  • v1.PublisherClient#matchTopicFromTopicName
  • v1.PublisherClient#projectPath
  • v1.PublisherClient#publish
  • v1.PublisherClient#setIamPolicy
  • v1.PublisherClient#testIamPermissions
  • v1.PublisherClient#topicPath
  • v1.PublisherClient#updateTopic
  • v1.PublisherClient.port
  • v1.PublisherClient.scopes
  • v1.PublisherClient.servicePath
  • v1.SubscriberClient
  • v1.SubscriberClient#acknowledge
  • v1.SubscriberClient#createSnapshot
  • v1.SubscriberClient#createSubscription
  • v1.SubscriberClient#deleteSnapshot
  • v1.SubscriberClient#deleteSubscription
  • v1.SubscriberClient#getIamPolicy
  • v1.SubscriberClient#getProjectId
  • v1.SubscriberClient#getSubscription
  • v1.SubscriberClient#listSnapshots
  • v1.SubscriberClient#listSnapshotsStream
  • v1.SubscriberClient#listSubscriptions
  • v1.SubscriberClient#listSubscriptionsStream
  • v1.SubscriberClient#matchProjectFromProjectName
  • v1.SubscriberClient#matchProjectFromSnapshotName
  • v1.SubscriberClient#matchProjectFromSubscriptionName
  • v1.SubscriberClient#matchProjectFromTopicName
  • v1.SubscriberClient#matchSnapshotFromSnapshotName
  • v1.SubscriberClient#matchSubscriptionFromSubscriptionName
  • v1.SubscriberClient#matchTopicFromTopicName
  • v1.SubscriberClient#modifyAckDeadline
  • v1.SubscriberClient#modifyPushConfig
  • v1.SubscriberClient#projectPath
  • v1.SubscriberClient#pull
  • v1.SubscriberClient#seek
  • v1.SubscriberClient#setIamPolicy
  • v1.SubscriberClient#snapshotPath
  • v1.SubscriberClient#streamingPull
  • v1.SubscriberClient#subscriptionPath
  • v1.SubscriberClient#testIamPermissions
  • v1.SubscriberClient#topicPath
  • v1.SubscriberClient#updateSnapshot
  • v1.SubscriberClient#updateSubscription
  • v1.SubscriberClient.port
  • v1.SubscriberClient.scopes
  • v1.SubscriberClient.servicePath
Was this page helpful? Let us know how we did:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated June 27, 2019.

  • Why Google

    • Choosing Google Cloud
    • Trust and security
    • Open cloud
    • Data center locations
    • Customers and case studies
    • Analyst reports
    • Whitepapers
    • Products and pricing
    • GCP pricing
    • G Suite pricing
    • Maps Platform pricing
    • See all products

  • Solutions

    • Artificial intelligence
    • Big data analytics
    • Collaboration and productivity
    • Continuous delivery
    • Migrate workloads
    • Mobile apps and sites
    • Serverless computing
    • Industry solutions
    • DevOps solutions
    • HR and recruiting solutions
    • Marketing solutions
    • Small business solutions
    • See all solutions

  • Resources

    • GCP documentation
    • GCP quickstarts
    • GCP Marketplace
    • G Suite Marketplace
    • Support
    • Tutorials
    • Training
    • Certifications
    • Google Developers
    • Google Cloud for Startups
    • System status

  • Engage

    • Contact sales
    • Find a Partner
    • Become a Partner
    • Blog
    • Events
    • Podcast
    • Community
    • Press center
    • Google Cloud on YouTube
    • GCP on YouTube
    • G Suite on YouTube
    • Follow on Twitter
    • We're hiring. Join Google Cloud!
About Google Privacy Site Terms Google Cloud Terms
Sign up for the Google Cloud newsletter
Subscribe

Send feedback about...

This page
Documentation feedback
Node.js
Product feedback