Stackdriver Logging V2 Client - Class LogEntry (1.24.10)

Reference documentation and code samples for the Stackdriver Logging V2 Client class LogEntry.

An individual entry in a log.

Generated from protobuf message google.logging.v2.LogEntry

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ log_name`	`string` Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the `log_name` field will contain PROJECT_ID in queries and exports. `[LOG_ID]` must be URL-encoded within `log_name`. Example: `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`. `[LOG_ID]` must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period. For backward compatibility, if `log_name` begins with a forward-slash, such as `/projects/...`, then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
`↳ resource`	`Google\Api\MonitoredResource` Required. The monitored resource that produced this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
`↳ proto_payload`	`Google\Protobuf\Any` The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads. The following protocol buffer types are supported; user-defined types are not supported: "type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"
`↳ text_payload`	`string` The log entry payload, represented as a Unicode string (UTF-8).
`↳ json_payload`	`Google\Protobuf\Struct` The log entry payload, represented as a structure that is expressed as a JSON object.
`↳ timestamp`	`Google\Protobuf\Timestamp` Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. Incoming log entries must have timestamps that don't exceed the logs retention period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.
`↳ receive_timestamp`	`Google\Protobuf\Timestamp` Output only. The time the log entry was received by Logging.
`↳ severity`	`int` Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
`↳ insert_id`	`string` Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same `timestamp`, and with the same `insert_id` to be duplicates which are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs. If the `insert_id` is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field. In queries, the `insert_id` is also used to order log entries that have the same `log_name` and `timestamp` values.
`↳ http_request`	`Google\Cloud\Logging\Type\HttpRequest` Optional. Information about the HTTP request associated with this log entry, if applicable.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined. User-defined labels are arbitrary key, value pairs that you can use to classify logs. System-defined labels are defined by GCP services for platform logs. They have two components - a service namespace component and the attribute name. For example: `compute.googleapis.com/resource_name`. Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
`↳ operation`	`Google\Cloud\Logging\V2\LogEntryOperation` Optional. Information about an operation associated with the log entry, if applicable.
`↳ trace`	`string` Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
`↳ span_id`	`string` Optional. The span ID within the trace associated with the log entry. For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as `000000000000004a`.
`↳ trace_sampled`	`bool` Optional. The sampling decision of the trace associated with the log entry. True means that the trace resource name in the `trace` field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled `trace` value is still useful as a request correlation identifier. The default is False.
`↳ source_location`	`Google\Cloud\Logging\V2\LogEntrySourceLocation` Optional. Source code location information associated with the log entry, if any.
`↳ split`	`Google\Cloud\Logging\V2\LogSplit` Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.

getLogName

Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.

[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period. For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.

Generated from protobuf field string log_name = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setLogName

Generated from protobuf field string log_name = 12 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getResource

Required. The monitored resource that produced this log entry.

Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.

Generated from protobuf field .google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Google\Api\MonitoredResource\|null`

hasResource

clearResource

setResource

Required. The monitored resource that produced this log entry.

Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.

Generated from protobuf field .google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`Google\Api\MonitoredResource`

Returns
Type	Description
`$this`

getProtoPayload

The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.

The following protocol buffer types are supported; user-defined types are not supported: "type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"

Generated from protobuf field .google.protobuf.Any proto_payload = 2;

Returns
Type	Description
`Google\Protobuf\Any\|null`

hasProtoPayload

setProtoPayload

The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.

The following protocol buffer types are supported; user-defined types are not supported: "type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"

Generated from protobuf field .google.protobuf.Any proto_payload = 2;

Parameter
Name	Description
`var`	`Google\Protobuf\Any`

Returns
Type	Description
`$this`

getTextPayload

The log entry payload, represented as a Unicode string (UTF-8).

Generated from protobuf field string text_payload = 3;

Returns
Type	Description
`string`

hasTextPayload

setTextPayload

The log entry payload, represented as a Unicode string (UTF-8).

Generated from protobuf field string text_payload = 3;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getJsonPayload

The log entry payload, represented as a structure that is expressed as a JSON object.

Generated from protobuf field .google.protobuf.Struct json_payload = 6;

Returns
Type	Description
`Google\Protobuf\Struct\|null`

hasJsonPayload

setJsonPayload

The log entry payload, represented as a structure that is expressed as a JSON object.

Generated from protobuf field .google.protobuf.Struct json_payload = 6;

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getTimestamp

Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period.

If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. Incoming log entries must have timestamps that don't exceed the logs retention period in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.

Generated from protobuf field .google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasTimestamp

clearTimestamp

setTimestamp

Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period.

Generated from protobuf field .google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getReceiveTimestamp

Output only. The time the log entry was received by Logging.

Generated from protobuf field .google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasReceiveTimestamp

clearReceiveTimestamp

setReceiveTimestamp

Output only. The time the log entry was received by Logging.

Generated from protobuf field .google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getSeverity

Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.

Generated from protobuf field .google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

setSeverity

Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.

Generated from protobuf field .google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getInsertId

Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs.

If the insert_id is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field. In queries, the insert_id is also used to order log entries that have the same log_name and timestamp values.

Generated from protobuf field string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setInsertId

Generated from protobuf field string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHttpRequest

Optional. Information about the HTTP request associated with this log entry, if applicable.

Generated from protobuf field .google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Cloud\Logging\Type\HttpRequest\|null`

hasHttpRequest

clearHttpRequest

setHttpRequest

Optional. Information about the HTTP request associated with this log entry, if applicable.

Generated from protobuf field .google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Cloud\Logging\Type\HttpRequest`

Returns
Type	Description
`$this`

getLabels

Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.

User-defined labels are arbitrary key, value pairs that you can use to classify logs. System-defined labels are defined by GCP services for platform logs. They have two components - a service namespace component and the attribute name. For example: compute.googleapis.com/resource_name. Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.

Generated from protobuf field map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.

Generated from protobuf field map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getOperation

Optional. Information about an operation associated with the log entry, if applicable.

Generated from protobuf field .google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Cloud\Logging\V2\LogEntryOperation\|null`

hasOperation

clearOperation

setOperation

Optional. Information about an operation associated with the log entry, if applicable.

Generated from protobuf field .google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Cloud\Logging\V2\LogEntryOperation`

Returns
Type	Description
`$this`

getTrace

Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824

Generated from protobuf field string trace = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setTrace

Generated from protobuf field string trace = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSpanId

Optional. The span ID within the trace associated with the log entry.

For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.

Generated from protobuf field string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`string`

setSpanId

Optional. The span ID within the trace associated with the log entry.

For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.

Generated from protobuf field string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTraceSampled

Optional. The sampling decision of the trace associated with the log entry.

True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False.

Generated from protobuf field bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`bool`

setTraceSampled

Optional. The sampling decision of the trace associated with the log entry.

Generated from protobuf field bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSourceLocation

Optional. Source code location information associated with the log entry, if any.

Generated from protobuf field .google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Cloud\Logging\V2\LogEntrySourceLocation\|null`

hasSourceLocation

clearSourceLocation

setSourceLocation

Optional. Source code location information associated with the log entry, if any.

Generated from protobuf field .google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Cloud\Logging\V2\LogEntrySourceLocation`

Returns
Type	Description
`$this`

getSplit

Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.

Generated from protobuf field .google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Google\Cloud\Logging\V2\LogSplit\|null`

hasSplit

clearSplit

setSplit

Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.

Generated from protobuf field .google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`var`	`Google\Cloud\Logging\V2\LogSplit`

Returns
Type	Description
`$this`

getPayload

Returns
Type	Description
`string`