Represents a LogEntry.
Package
@google-cloud/loggingConstructors
(constructor)(properties)
constructor(properties?: google.logging.v2.ILogEntry);Constructs a new LogEntry.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILogEntry
Properties to set |
Properties
httpRequest
public httpRequest?: (google.logging.type.IHttpRequest|null);LogEntry httpRequest.
insertId
public insertId: string;LogEntry insertId.
jsonPayload
public jsonPayload?: (google.protobuf.IStruct|null);LogEntry jsonPayload.
labels
public labels: { [k: string]: string };LogEntry labels.
logName
public logName: string;LogEntry logName.
operation
public operation?: (google.logging.v2.ILogEntryOperation|null);LogEntry operation.
payload
public payload?: ("protoPayload"|"textPayload"|"jsonPayload");LogEntry payload.
protoPayload
public protoPayload?: (google.protobuf.IAny|null);LogEntry protoPayload.
receiveTimestamp
public receiveTimestamp?: (google.protobuf.ITimestamp|null);LogEntry receiveTimestamp.
resource
public resource?: (google.api.IMonitoredResource|null);LogEntry resource.
severity
public severity: (google.logging.type.LogSeverity|keyof typeof google.logging.type.LogSeverity);LogEntry severity.
sourceLocation
public sourceLocation?: (google.logging.v2.ILogEntrySourceLocation|null);LogEntry sourceLocation.
spanId
public spanId: string;LogEntry spanId.
split
public split?: (google.logging.v2.ILogSplit|null);LogEntry split.
textPayload
public textPayload?: (string|null);LogEntry textPayload.
timestamp
public timestamp?: (google.protobuf.ITimestamp|null);LogEntry timestamp.
trace
public trace: string;LogEntry trace.
traceSampled
public traceSampled: boolean;LogEntry traceSampled.
Methods
create(properties)
public static create(properties?: google.logging.v2.ILogEntry): google.logging.v2.LogEntry;Creates a new LogEntry instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILogEntry
Properties to set |
| Returns | |
|---|---|
| Type | Description |
LogEntry | LogEntry instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.logging.v2.LogEntry;Decodes a LogEntry 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 |
LogEntry | LogEntry |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.LogEntry;Decodes a LogEntry message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
LogEntry | LogEntry |
encode(message, writer)
public static encode(message: google.logging.v2.ILogEntry, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LogEntry message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILogEntry
LogEntry 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.ILogEntry, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LogEntry message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILogEntry
LogEntry 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.LogEntry;Creates a LogEntry 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 |
LogEntry | LogEntry |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LogEntry
| 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 LogEntry to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.logging.v2.LogEntry, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a LogEntry message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
LogEntry
LogEntry |
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 LogEntry message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|