Represents a LogSink.
Package
@google-cloud/loggingConstructors
(constructor)(properties)
constructor(properties?: google.logging.v2.ILogSink);Constructs a new LogSink.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILogSink
Properties to set |
Properties
bigqueryOptions
public bigqueryOptions?: (google.logging.v2.IBigQueryOptions|null);LogSink bigqueryOptions.
createTime
public createTime?: (google.protobuf.ITimestamp|null);LogSink createTime.
description
public description: string;LogSink description.
destination
public destination: string;LogSink destination.
disabled
public disabled: boolean;LogSink disabled.
exclusions
public exclusions: google.logging.v2.ILogExclusion[];LogSink exclusions.
filter
public filter: string;LogSink filter.
includeChildren
public includeChildren: boolean;LogSink includeChildren.
name
public name: string;LogSink name.
options
public options?: "bigqueryOptions";LogSink options.
outputVersionFormat
public outputVersionFormat: (google.logging.v2.LogSink.VersionFormat|keyof typeof google.logging.v2.LogSink.VersionFormat);LogSink outputVersionFormat.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);LogSink updateTime.
writerIdentity
public writerIdentity: string;LogSink writerIdentity.
Methods
create(properties)
public static create(properties?: google.logging.v2.ILogSink): google.logging.v2.LogSink;Creates a new LogSink instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILogSink
Properties to set |
| Returns | |
|---|---|
| Type | Description |
LogSink | LogSink instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.logging.v2.LogSink;Decodes a LogSink message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
LogSink | LogSink |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.LogSink;Decodes a LogSink message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
LogSink | LogSink |
encode(message, writer)
public static encode(message: google.logging.v2.ILogSink, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LogSink message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILogSink
LogSink message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.logging.v2.ILogSink, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LogSink message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILogSink
LogSink message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.logging.v2.LogSink;Creates a LogSink message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
LogSink | LogSink |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LogSink
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this LogSink to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.logging.v2.LogSink, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a LogSink message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
LogSink
LogSink |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a LogSink message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|