Globals
Abstract types
ClientConfig
object
Properties
Parameter |
|||||||
---|---|---|---|---|---|---|---|
projectId |
Optional string The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable |
||||||
keyFilename |
Optional string Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the |
||||||
|
Optional string Account email address. Required when using a .pem or .p12 keyFilename. |
||||||
credentials |
Optional object Credentials object. Values in
|
||||||
autoRetry |
Optional boolean Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default. |
||||||
maxRetries |
Optional number Maximum number of automatic retries attempted before returning the error. |
||||||
promise |
Optional Constructor Custom promise module to use instead of native Promises. |
CreateSinkCallback
CreateSinkCallback(err, sink, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
sink |
The new Sink. |
apiResponse |
object The full API response. |
CreateSinkRequest
object
Config to set for the sink. Not all available options are listed here, see the Sink resource definition for full details.
Properties
Parameter |
|
---|---|
gaxOptions |
Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. |
destination |
Optional (Bucket, Dataset, or Topic) The destination. The proper ACL scopes will be granted to the provided destination. Can be one of: Bucket, Dataset, or Topic |
filter |
Optional string An advanced logs filter. Only log entries matching the filter are written. |
CreateSinkResponse
array
Properties
Parameter |
|
---|---|
0 |
The new Sink. |
1 |
object The full API response. |
DeleteLogCallback
DeleteLogCallback(err, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
apiResponse |
object The full API response. |
DeleteLogResponse
array
Property
Parameter |
|
---|---|
0 |
object The full API response. |
DeleteSinkCallback
DeleteSinkCallback(err, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
apiResponse |
object The full API response. |
DeleteSinkResponse
array
Property
Parameter |
|
---|---|
0 |
object The full API response. |
GetEntriesCallback
GetEntriesCallback(err, entries, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
entries |
Array of Entry Array of Entry instances. |
apiResponse |
object The full API response. |
GetEntriesRequest
object
Query object for listing entries.
Properties
Parameter |
|
---|---|
autoPaginate |
Optional boolean Have pagination handled automatically. |
filter |
Optional string An advanced logs filter. An empty filter matches all log entries. |
gaxOptions |
Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. |
maxApiCalls |
Optional number Maximum number of API calls to make. |
maxResults |
Optional number Maximum number of items plus prefixes to return. |
orderBy |
Optional string How the results should be sorted,
|
pageSize |
Optional number Maximum number of logs to return. |
pageToken |
Optional string A previously-returned page token representing part of the larger set of results to view. |
GetEntriesResponse
array
Properties
Parameter |
|
---|---|
0 |
Array of Entry Array of Entry instances. |
1 |
object The full API response. |
GetSinkMetadataCallback
GetSinkMetadataCallback(err, metadata, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
metadata |
object The Sink metadata. |
apiResponse |
object The full API response. |
GetSinkMetadataResponse
array
Properties
Parameter |
|
---|---|
0 |
object The Sink metadata. |
1 |
object The full API response. |
GetSinksCallback
GetSinksCallback(err, sinks, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
sinks |
Array of Sink Array of Sink instances. |
apiResponse |
object The full API response. |
GetSinksRequest
object
Query object for listing sinks.
Properties
Parameter |
|
---|---|
autoPaginate |
Optional boolean Have pagination handled automatically. |
gaxOptions |
Optional object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. |
maxApiCalls |
Optional number Maximum number of API calls to make. |
maxResults |
Optional number Maximum number of items plus prefixes to return. |
pageSize |
Optional number Maximum number of logs to return. |
pageToken |
Optional string A previously-returned page token representing part of the larger set of results to view. |
GetSinksResponse
array
Properties
Parameter |
|
---|---|
0 |
Array of Sink Array of Sink instances. |
1 |
object The full API response. |
LogWriteCallback
LogWriteCallback(err, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
apiResponse |
object The full API response. |
LogWriteResponse
array
Property
Parameter |
|
---|---|
0 |
object The full API response. |
SetSinkFilterCallback
SetSinkFilterCallback(err, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
apiResponse |
object The full API response. |
SetSinkFilterResponse
array
Property
Parameter |
|
---|---|
0 |
object The full API response. |
SetSinkMetadataCallback
SetSinkMetadataCallback(err, apiResponse)
Parameter |
|
---|---|
err |
Error Request error, if any. Value may be null. |
apiResponse |
object The full API response. |
SetSinkMetadataResponse
array
Property
Parameter |
|
---|---|
0 |
object The full API response. |
WriteOptions
object
Write options.
Properties
Parameter |
|
---|---|
gaxOptions |
object Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. |
labels |
Array of object Labels to set on the log. |
resource |
object A default monitored resource for entries where one isn't specified. |