Class Sink (9.3.1)

A sink is an object that lets you to specify a set of log entries to export to a particular destination. Cloud Logging lets you export log entries to destinations including Cloud Storage buckets (for long term log storage), Google BigQuery datasets (for log analysis), Google Pub/Sub (for streaming to other applications).

[Introduction to Sinks] https://cloud.google.com/logging/docs/basic-concepts#sinks

Package

@google-cloud/logging!

Constructors

(constructor)(logging, name)

  constructor 
 ( 
 logging 
 : 
  
 Logging 
 , 
  
 name 
 : 
  
 string 
 );

Constructs a new instance of the Sink class

Parameters

Name	Description
logging	`Logging`
name	`string`

Properties

formattedName_

  formattedName_ 
 : 
  
 string 
 ;

Property Value

Type	Description
string

logging

  logging 
 : 
  
 Logging 
 ;

Property Value

Type	Description
Logging

metadata

  metadata 
 ?: 
  
 LogSink 
 ;

Property Value

Type	Description
LogSink

name

  name 
 : 
  
 string 
 ;

Property Value

Type	Description
string

Methods

create(config)

  create 
 ( 
 config 
 : 
  
 CreateSinkRequest 
 ) 
 : 
  
 Promise 
< [ 
 Sink 
 , 
  
 LogSink 
 ]>;

Parameter

Name	Description
config	`CreateSinkRequest`

Returns

Type	Description
Promise <[ Sink , LogSink ]>

create(config, callback)

  create 
 ( 
 config 
 : 
  
 CreateSinkRequest 
 , 
  
 callback 
 : 
  
 CreateSinkCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
config	`CreateSinkRequest`
callback	`CreateSinkCallback`

Returns

Type	Description
void

delete(gaxOptions)

  delete 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<DeleteResponse> 
 ;

Parameter

Name	Description
gaxOptions	`CallOptions`

Returns

Type	Description
Promise < DeleteResponse >

delete(callback)

  delete 
 ( 
 callback 
 : 
  
 DeleteCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`DeleteCallback`

Returns

Type	Description
void

delete(gaxOptions, callback)

  delete 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DeleteCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
gaxOptions	`CallOptions`
callback	`DeleteCallback`

Returns

Type	Description
void

getMetadata(gaxOptions)

  getMetadata 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<SinkMetadataResponse> 
 ;

Parameter

Name	Description
gaxOptions	`CallOptions`

Returns

Type	Description
Promise < SinkMetadataResponse >

getMetadata(callback)

  getMetadata 
 ( 
 callback 
 : 
  
 SinkMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`SinkMetadataCallback`

Returns

Type	Description
void

getMetadata(gaxOptions, callback)

  getMetadata 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 SinkMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
gaxOptions	`CallOptions`
callback	`SinkMetadataCallback`

Returns

Type	Description
void

setFilter(filter)

  setFilter 
 ( 
 filter 
 : 
  
 string 
 ) 
 : 
  
 Promise<SinkMetadataResponse> 
 ;

Parameter

Name	Description
filter	`string`

Returns

Type	Description
Promise < SinkMetadataResponse >

setFilter(filter, callback)

  setFilter 
 ( 
 filter 
 : 
  
 string 
 , 
  
 callback 
 : 
  
 SinkMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
filter	`string`
callback	`SinkMetadataCallback`

Returns

Type	Description
void

setMetadata(metadata)

  setMetadata 
 ( 
 metadata 
 : 
  
 SetSinkMetadata 
 ) 
 : 
  
 Promise<SinkMetadataResponse> 
 ;

Parameter

Name	Description
metadata	`SetSinkMetadata`

Returns

Type	Description
Promise < SinkMetadataResponse >

setMetadata(metadata, callback)

  setMetadata 
 ( 
 metadata 
 : 
  
 SetSinkMetadata 
 , 
  
 callback 
 : 
  
 SinkMetadataCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
metadata	`SetSinkMetadata`
callback	`SinkMetadataCallback`

Returns

Type	Description
void

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

Package

Constructors

(constructor)(logging, name)

Properties

formattedName_

logging

metadata

name

Methods

create(config)

create(config, callback)

delete(gaxOptions)

delete(callback)

delete(gaxOptions, callback)

getMetadata(gaxOptions)

getMetadata(callback)

getMetadata(gaxOptions, callback)

setFilter(filter)

setFilter(filter, callback)

setMetadata(metadata)

setMetadata(metadata, callback)

Class Sink (9.3.1)