Class protos.google.logging.v2.LogSink (9.5.7)

Represents a LogSink.

Package

@google-cloud/logging!

Constructors

(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.

Property Value

Type	Description
(google.logging.v2.IBigQueryOptions\|null)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

LogSink createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

description

public description: string;

LogSink description.

Property Value

Type	Description
string

destination

public destination: string;

LogSink destination.

Property Value

Type	Description
string

disabled

public disabled: boolean;

LogSink disabled.

Property Value

Type	Description
boolean

exclusions

public exclusions: google.logging.v2.ILogExclusion[];

LogSink exclusions.

Property Value

Type	Description
google.logging.v2.ILogExclusion[]

filter

public filter: string;

LogSink filter.

Property Value

Type	Description
string

includeChildren

public includeChildren: boolean;

LogSink includeChildren.

Property Value

Type	Description
boolean

name

public name: string;

LogSink name.

Property Value

Type	Description
string

options

public options?: "bigqueryOptions";

LogSink options.

Property Value

Type	Description
"bigqueryOptions"

outputVersionFormat

public outputVersionFormat: (google.logging.v2.LogSink.VersionFormat|keyof typeof google.logging.v2.LogSink.VersionFormat);

LogSink outputVersionFormat.

Property Value

Type	Description
(google.logging.v2.LogSink.VersionFormat\|keyof typeof google.logging.v2.LogSink.VersionFormat)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

LogSink updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

writerIdentity

public writerIdentity: string;

LogSink writerIdentity.

Property Value

Type	Description
string

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
google.logging.v2.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.logging.v2.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.logging.v2.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
google.logging.v2.LogSink	LogSink

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	`google.logging.v2.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)	`null` if valid, otherwise the reason why it is not