Cloud Pub/Sub API - Module Google::Cloud (v3.0.2)

Reference documentation and code samples for the Cloud Pub/Sub API module Google::Cloud.

Methods

.pubsub

  def 
  
 self 
 . 
 pubsub 
 ( 
 project_id 
  
 = 
  
 nil 
 , 
  
 credentials 
  
 = 
  
 nil 
 , 
  
 scope 
 : 
  
 nil 
 , 
  
 timeout 
 : 
  
 nil 
 ) 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 PubSub 
 :: 
 Project 
 

Creates a new object for connecting to the Pub/Sub service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide .

Parameters
  • project_id(String) — Project identifier for the Pub/Sub service you are connecting to. If not present, the default project for the credentials is used.
  • credentials(String, Hash, Google::Auth::Credentials) — The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See PubSub::Credentials )
  • scope(String, Array<String>) (defaults to: nil)

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs .

    The default scope is:

    • https://www.googleapis.com/auth/pubsub
  • timeout(Numeric) (defaults to: nil) — Default timeout to use in requests. Optional.
Example
 require 
  
 "google/cloud" 
 pubsub 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 pubsub 
 publisher 
  
 = 
  
 pubsub 
 . 
 publisher 
  
 "my-topic" 
 publisher 
 . 
 publish 
  
 "task completed" 

#pubsub

  def 
  
 pubsub 
 ( 
 scope 
 : 
  
 nil 
 , 
  
 timeout 
 : 
  
 nil 
 ) 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 PubSub 
 :: 
 Project 
 

Creates a new object for connecting to the Pub/Sub service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide .

Parameters
  • scope(String, Array<String>) (defaults to: nil)

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs .

    The default scope is:

    • https://www.googleapis.com/auth/pubsub
  • timeout(Numeric) (defaults to: nil) — Default timeout to use in requests. Optional.
Examples
 require 
  
 "google/cloud" 
 gcloud 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 new 
 pubsub 
  
 = 
  
 gcloud 
 . 
 pubsub 
 topic_admin 
  
 = 
  
 pubsub 
 . 
 topic_admin 
 publisher 
  
 = 
  
 pubsub 
 . 
 publisher 
  
 "my-topic" 
 publisher 
 . 
 publish 
  
 "task completed" 

The default scope can be overridden with the scope option:

 require 
  
 "google/cloud" 
 gcloud 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 new 
 platform_scope 
  
 = 
  
 "https://www.googleapis.com/auth/cloud-platform" 
 pubsub 
  
 = 
  
 gcloud 
 . 
 pubsub 
  
 scope 
 : 
  
 platform_scope 

Constants

Pubsub

value: PubSub
Legacy veneer namespace

Create a Mobile Website
View Site in Mobile | Classic
Share by: