Class Snapshot (2.17.0)

A Snapshot object will give you access to your Cloud Pub/Sub snapshot.

Snapshots are sometimes retrieved when using various methods:

Snapshots may be created with:

You can use snapshots to seek a subscription to a specific point in time.

Package

@google-cloud/pubsub!

Constructors

(constructor)(parent, name)

  constructor 
 ( 
 parent 
 : 
  
 Subscription 
  
 | 
  
 PubSub 
 , 
  
 name 
 : 
  
 string 
 );

Constructs a new instance of the Snapshot class

Parameters

Name	Description
parent	`Subscription \| PubSub`
name	`string`

Properties

metadata

  metadata 
 ?: 
  
 google 
 . 
 pubsub 
 . 
 v1 
 . 
 ISnapshot 
 ;

Property Value

Type	Description
google.pubsub.v1.ISnapshot

name

  name 
 : 
  
 string 
 ;

Property Value

Type	Description
string

parent

  parent 
 : 
  
 Subscription 
  
 | 
  
 PubSub 
 ;

Property Value

Type	Description
Subscription \| PubSub

Methods

create(gaxOpts)

  create 
 ( 
 gaxOpts 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<CreateSnapshotResponse> 
 ;

Parameter

Name	Description
gaxOpts	`CallOptions`

Returns

Type	Description
Promise < CreateSnapshotResponse >

create(callback)

  create 
 ( 
 callback 
 : 
  
 CreateSnapshotCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`CreateSnapshotCallback`

Returns

Type	Description
void

create(gaxOpts, callback)

  create 
 ( 
 gaxOpts 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 CreateSnapshotCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
gaxOpts	`CallOptions`
callback	`CreateSnapshotCallback`

Returns

Type	Description
void

delete()

  delete 
 () 
 : 
  
 Promise<EmptyResponse> 
 ;

Returns

Type	Description
Promise < EmptyResponse >

delete(callback)

  delete 
 ( 
 callback 
 : 
  
 EmptyCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`EmptyCallback`

Returns

Type	Description
void

formatName_(projectId, name)

  static 
  
 formatName_ 
 ( 
 projectId 
 : 
  
 string 
 , 
  
 name 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Parameters

Name	Description
projectId	`string`
name	`string`

Returns

Type	Description
string

seek(gaxOpts)

  seek 
 ( 
 gaxOpts 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<SeekResponse> 
 ;

Parameter

Name	Description
gaxOpts	`CallOptions`

Returns

Type	Description
Promise < SeekResponse >

seek(callback)

  seek 
 ( 
 callback 
 : 
  
 SeekCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`SeekCallback`

Returns

Type	Description
void

seek(gaxOpts, callback)

  seek 
 ( 
 gaxOpts 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 SeekCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
gaxOpts	`CallOptions`
callback	`SeekCallback`

Returns

Type	Description
void

Class Snapshot (2.17.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(parent, name)

Properties

metadata

name

parent

Methods

create(gaxOpts)

create(callback)

create(gaxOpts, callback)

delete()

delete(callback)

formatName_(projectId, name)

seek(gaxOpts)

seek(callback)

seek(gaxOpts, callback)

Class Snapshot (2.17.0)