public static final class LogEntry.Builder extends GeneratedMessageV3.Builder<LogEntry.Builder> implements LogEntryOrBuilderAn individual entry in a log.
Protobuf type google.logging.v2.LogEntry
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LogEntry.BuilderImplements
LogEntryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LogEntry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
build()
public LogEntry build()| Returns | |
|---|---|
| Type | Description |
LogEntry | |
buildPartial()
public LogEntry buildPartial()| Returns | |
|---|---|
| Type | Description |
LogEntry | |
clear()
public LogEntry.Builder clear()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearField(Descriptors.FieldDescriptor field)
public LogEntry.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearHttpRequest()
public LogEntry.Builder clearHttpRequest()Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearInsertId()
public LogEntry.Builder clearInsertId() 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.
string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearJsonPayload()
public LogEntry.Builder clearJsonPayload()The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearLabels()
public LogEntry.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearLogName()
public LogEntry.Builder clearLogName() 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.
string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public LogEntry.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearOperation()
public LogEntry.Builder clearOperation()Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearPayload()
public LogEntry.Builder clearPayload()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearProtoPayload()
public LogEntry.Builder clearProtoPayload()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"
.google.protobuf.Any proto_payload = 2;
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearReceiveTimestamp()
public LogEntry.Builder clearReceiveTimestamp()Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearResource()
public LogEntry.Builder clearResource()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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearSeverity()
public LogEntry.Builder clearSeverity() Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearSourceLocation()
public LogEntry.Builder clearSourceLocation()Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearSpanId()
public LogEntry.Builder clearSpanId() Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A
Span
represents a single operation within a trace. Whereas a trace may involve
multiple different microservices running on multiple different machines,
a span generally corresponds to a single logical operation being performed
in a single instance of a microservice on one specific machine. Spans
are the nodes within the tree that is a trace.
Applications that are instrumented for
tracing will generally assign a
new, unique span ID on each incoming request. It is also common to create
and record additional spans corresponding to internal processing elements
as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an
8-byte array and should not be zero. It should be unique within the trace
and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearSplit()
public LogEntry.Builder clearSplit()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearTextPayload()
public LogEntry.Builder clearTextPayload()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearTimestamp()
public LogEntry.Builder clearTimestamp()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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
clearTrace()
public LogEntry.Builder clearTrace() Optional. The REST resource name of the trace being written to
Cloud Trace in
association with this log entry. For example, if your trace data is stored
in the Cloud project "my-trace-project" and if the service that is creating
the log entry receives a trace header that includes the trace ID "12345",
then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clearTraceSampled()
public LogEntry.Builder clearTraceSampled() 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.
bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
clone()
public LogEntry.Builder clone()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
containsLabels(String key)
public boolean containsLabels(String key) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public LogEntry getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LogEntry | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getHttpRequest()
public HttpRequest getHttpRequest()Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.logging.type.HttpRequest | The httpRequest. |
getHttpRequestBuilder()
public HttpRequest.Builder getHttpRequestBuilder()Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.logging.type.HttpRequest.Builder | |
getHttpRequestOrBuilder()
public HttpRequestOrBuilder getHttpRequestOrBuilder()Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.logging.type.HttpRequestOrBuilder | |
getInsertId()
public String 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.
string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The insertId. |
getInsertIdBytes()
public ByteString getInsertIdBytes() 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.
string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for insertId. |
getJsonPayload()
public Struct getJsonPayload()The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Returns | |
|---|---|
| Type | Description |
Struct | The jsonPayload. |
getJsonPayloadBuilder()
public Struct.Builder getJsonPayloadBuilder()The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getJsonPayloadOrBuilder()
public StructOrBuilder getJsonPayloadOrBuilder()The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder | |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount() 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap() 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLogName()
public String 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.
string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The logName. |
getLogNameBytes()
public ByteString getLogNameBytes() 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.
string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for logName. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getOperation()
public LogEntryOperation getOperation()Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntryOperation | The operation. |
getOperationBuilder()
public LogEntryOperation.Builder getOperationBuilder()Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntryOperation.Builder | |
getOperationOrBuilder()
public LogEntryOperationOrBuilder getOperationOrBuilder()Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntryOperationOrBuilder | |
getPayloadCase()
public LogEntry.PayloadCase getPayloadCase()| Returns | |
|---|---|
| Type | Description |
LogEntry.PayloadCase | |
getProtoPayload()
public Any 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"
.google.protobuf.Any proto_payload = 2;
| Returns | |
|---|---|
| Type | Description |
Any | The protoPayload. |
getProtoPayloadBuilder()
public Any.Builder getProtoPayloadBuilder()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"
.google.protobuf.Any proto_payload = 2;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getProtoPayloadOrBuilder()
public AnyOrBuilder getProtoPayloadOrBuilder()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"
.google.protobuf.Any proto_payload = 2;
| Returns | |
|---|---|
| Type | Description |
AnyOrBuilder | |
getReceiveTimestamp()
public Timestamp getReceiveTimestamp()Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The receiveTimestamp. |
getReceiveTimestampBuilder()
public Timestamp.Builder getReceiveTimestampBuilder()Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getReceiveTimestampOrBuilder()
public TimestampOrBuilder getReceiveTimestampOrBuilder()Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getResource()
public MonitoredResource 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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource | The resource. |
getResourceBuilder()
public MonitoredResource.Builder getResourceBuilder()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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource.Builder | |
getResourceOrBuilder()
public MonitoredResourceOrBuilder getResourceOrBuilder()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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceOrBuilder | |
getSeverity()
public LogSeverity getSeverity() Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.logging.type.LogSeverity | The severity. |
getSeverityValue()
public int getSeverityValue() Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for severity. |
getSourceLocation()
public LogEntrySourceLocation getSourceLocation()Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntrySourceLocation | The sourceLocation. |
getSourceLocationBuilder()
public LogEntrySourceLocation.Builder getSourceLocationBuilder()Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntrySourceLocation.Builder | |
getSourceLocationOrBuilder()
public LogEntrySourceLocationOrBuilder getSourceLocationOrBuilder()Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogEntrySourceLocationOrBuilder | |
getSpanId()
public String getSpanId() Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A
Span
represents a single operation within a trace. Whereas a trace may involve
multiple different microservices running on multiple different machines,
a span generally corresponds to a single logical operation being performed
in a single instance of a microservice on one specific machine. Spans
are the nodes within the tree that is a trace.
Applications that are instrumented for
tracing will generally assign a
new, unique span ID on each incoming request. It is also common to create
and record additional spans corresponding to internal processing elements
as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an
8-byte array and should not be zero. It should be unique within the trace
and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The spanId. |
getSpanIdBytes()
public ByteString getSpanIdBytes() Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A
Span
represents a single operation within a trace. Whereas a trace may involve
multiple different microservices running on multiple different machines,
a span generally corresponds to a single logical operation being performed
in a single instance of a microservice on one specific machine. Spans
are the nodes within the tree that is a trace.
Applications that are instrumented for
tracing will generally assign a
new, unique span ID on each incoming request. It is also common to create
and record additional spans corresponding to internal processing elements
as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an
8-byte array and should not be zero. It should be unique within the trace
and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for spanId. |
getSplit()
public LogSplit getSplit()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogSplit | The split. |
getSplitBuilder()
public LogSplit.Builder getSplitBuilder()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogSplit.Builder | |
getSplitOrBuilder()
public LogSplitOrBuilder getSplitOrBuilder()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogSplitOrBuilder | |
getTextPayload()
public String getTextPayload()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| Type | Description |
String | The textPayload. |
getTextPayloadBytes()
public ByteString getTextPayloadBytes()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for textPayload. |
getTimestamp()
public Timestamp 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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The timestamp. |
getTimestampBuilder()
public Timestamp.Builder getTimestampBuilder()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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getTimestampOrBuilder()
public TimestampOrBuilder getTimestampOrBuilder()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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getTrace()
public String getTrace() Optional. The REST resource name of the trace being written to
Cloud Trace in
association with this log entry. For example, if your trace data is stored
in the Cloud project "my-trace-project" and if the service that is creating
the log entry receives a trace header that includes the trace ID "12345",
then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The trace. |
getTraceBytes()
public ByteString getTraceBytes() Optional. The REST resource name of the trace being written to
Cloud Trace in
association with this log entry. For example, if your trace data is stored
in the Cloud project "my-trace-project" and if the service that is creating
the log entry receives a trace header that includes the trace ID "12345",
then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for trace. |
getTraceSampled()
public boolean 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.
bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | The traceSampled. |
hasHttpRequest()
public boolean hasHttpRequest()Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the httpRequest field is set. |
hasJsonPayload()
public boolean hasJsonPayload()The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the jsonPayload field is set. |
hasOperation()
public boolean hasOperation()Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the operation field is set. |
hasProtoPayload()
public boolean hasProtoPayload()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"
.google.protobuf.Any proto_payload = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the protoPayload field is set. |
hasReceiveTimestamp()
public boolean hasReceiveTimestamp()Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the receiveTimestamp field is set. |
hasResource()
public boolean hasResource()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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the resource field is set. |
hasSourceLocation()
public boolean hasSourceLocation()Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceLocation field is set. |
hasSplit()
public boolean hasSplit()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the split field is set. |
hasTextPayload()
public boolean hasTextPayload()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the textPayload field is set. |
hasTimestamp()
public boolean hasTimestamp()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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the timestamp field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(LogEntry other)
public LogEntry.Builder mergeFrom(LogEntry other)| Parameter | |
|---|---|
| Name | Description |
other | LogEntry |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LogEntry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public LogEntry.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeHttpRequest(HttpRequest value)
public LogEntry.Builder mergeHttpRequest(HttpRequest value)Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.logging.type.HttpRequest |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeJsonPayload(Struct value)
public LogEntry.Builder mergeJsonPayload(Struct value)The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeOperation(LogEntryOperation value)
public LogEntry.Builder mergeOperation(LogEntryOperation value)Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogEntryOperation |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeProtoPayload(Any value)
public LogEntry.Builder mergeProtoPayload(Any value)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"
.google.protobuf.Any proto_payload = 2;
| Parameter | |
|---|---|
| Name | Description |
value | Any |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeReceiveTimestamp(Timestamp value)
public LogEntry.Builder mergeReceiveTimestamp(Timestamp value)Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeResource(MonitoredResource value)
public LogEntry.Builder mergeResource(MonitoredResource value)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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.api.MonitoredResource |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeSourceLocation(LogEntrySourceLocation value)
public LogEntry.Builder mergeSourceLocation(LogEntrySourceLocation value)Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogEntrySourceLocation |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeSplit(LogSplit value)
public LogEntry.Builder mergeSplit(LogSplit value)Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogSplit |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeTimestamp(Timestamp value)
public LogEntry.Builder mergeTimestamp(Timestamp value)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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LogEntry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
putAllLabels(Map<String,String> values)
public LogEntry.Builder putAllLabels(Map<String,String> values) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
putLabels(String key, String value)
public LogEntry.Builder putLabels(String key, String value) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
removeLabels(String key)
public LogEntry.Builder removeLabels(String key) 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.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public LogEntry.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setHttpRequest(HttpRequest value)
public LogEntry.Builder setHttpRequest(HttpRequest value)Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.logging.type.HttpRequest |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setHttpRequest(HttpRequest.Builder builderForValue)
public LogEntry.Builder setHttpRequest(HttpRequest.Builder builderForValue)Optional. Information about the HTTP request associated with this log entry, if applicable.
.google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.logging.type.HttpRequest.Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setInsertId(String value)
public LogEntry.Builder setInsertId(String value) 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.
string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe insertId to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setInsertIdBytes(ByteString value)
public LogEntry.Builder setInsertIdBytes(ByteString value) 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.
string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for insertId to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setJsonPayload(Struct value)
public LogEntry.Builder setJsonPayload(Struct value)The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setJsonPayload(Struct.Builder builderForValue)
public LogEntry.Builder setJsonPayload(Struct.Builder builderForValue)The log entry payload, represented as a structure that is expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setLogName(String value)
public LogEntry.Builder setLogName(String value) 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.
string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe logName to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setLogNameBytes(ByteString value)
public LogEntry.Builder setLogNameBytes(ByteString value) 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.
string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for logName to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setOperation(LogEntryOperation value)
public LogEntry.Builder setOperation(LogEntryOperation value)Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogEntryOperation |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setOperation(LogEntryOperation.Builder builderForValue)
public LogEntry.Builder setOperation(LogEntryOperation.Builder builderForValue)Optional. Information about an operation associated with the log entry, if applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | LogEntryOperation.Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setProtoPayload(Any value)
public LogEntry.Builder setProtoPayload(Any value)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"
.google.protobuf.Any proto_payload = 2;
| Parameter | |
|---|---|
| Name | Description |
value | Any |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setProtoPayload(Any.Builder builderForValue)
public LogEntry.Builder setProtoPayload(Any.Builder builderForValue)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"
.google.protobuf.Any proto_payload = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setReceiveTimestamp(Timestamp value)
public LogEntry.Builder setReceiveTimestamp(Timestamp value)Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setReceiveTimestamp(Timestamp.Builder builderForValue)
public LogEntry.Builder setReceiveTimestamp(Timestamp.Builder builderForValue)Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LogEntry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setResource(MonitoredResource value)
public LogEntry.Builder setResource(MonitoredResource value)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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.api.MonitoredResource |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setResource(MonitoredResource.Builder builderForValue)
public LogEntry.Builder setResource(MonitoredResource.Builder builderForValue)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.
.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.api.MonitoredResource.Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setSeverity(LogSeverity value)
public LogEntry.Builder setSeverity(LogSeverity value) Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.logging.type.LogSeverityThe severity to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setSeverityValue(int value)
public LogEntry.Builder setSeverityValue(int value) Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for severity to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setSourceLocation(LogEntrySourceLocation value)
public LogEntry.Builder setSourceLocation(LogEntrySourceLocation value)Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogEntrySourceLocation |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setSourceLocation(LogEntrySourceLocation.Builder builderForValue)
public LogEntry.Builder setSourceLocation(LogEntrySourceLocation.Builder builderForValue)Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | LogEntrySourceLocation.Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setSpanId(String value)
public LogEntry.Builder setSpanId(String value) Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A
Span
represents a single operation within a trace. Whereas a trace may involve
multiple different microservices running on multiple different machines,
a span generally corresponds to a single logical operation being performed
in a single instance of a microservice on one specific machine. Spans
are the nodes within the tree that is a trace.
Applications that are instrumented for
tracing will generally assign a
new, unique span ID on each incoming request. It is also common to create
and record additional spans corresponding to internal processing elements
as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an
8-byte array and should not be zero. It should be unique within the trace
and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe spanId to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setSpanIdBytes(ByteString value)
public LogEntry.Builder setSpanIdBytes(ByteString value) Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A
Span
represents a single operation within a trace. Whereas a trace may involve
multiple different microservices running on multiple different machines,
a span generally corresponds to a single logical operation being performed
in a single instance of a microservice on one specific machine. Spans
are the nodes within the tree that is a trace.
Applications that are instrumented for
tracing will generally assign a
new, unique span ID on each incoming request. It is also common to create
and record additional spans corresponding to internal processing elements
as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an
8-byte array and should not be zero. It should be unique within the trace
and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for spanId to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setSplit(LogSplit value)
public LogEntry.Builder setSplit(LogSplit value)Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | LogSplit |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setSplit(LogSplit.Builder builderForValue)
public LogEntry.Builder setSplit(LogSplit.Builder builderForValue)Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | LogSplit.Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setTextPayload(String value)
public LogEntry.Builder setTextPayload(String value)The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe textPayload to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setTextPayloadBytes(ByteString value)
public LogEntry.Builder setTextPayloadBytes(ByteString value)The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for textPayload to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setTimestamp(Timestamp value)
public LogEntry.Builder setTimestamp(Timestamp value)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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setTimestamp(Timestamp.Builder builderForValue)
public LogEntry.Builder setTimestamp(Timestamp.Builder builderForValue)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.
.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |
setTrace(String value)
public LogEntry.Builder setTrace(String value) Optional. The REST resource name of the trace being written to
Cloud Trace in
association with this log entry. For example, if your trace data is stored
in the Cloud project "my-trace-project" and if the service that is creating
the log entry receives a trace header that includes the trace ID "12345",
then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe trace to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setTraceBytes(ByteString value)
public LogEntry.Builder setTraceBytes(ByteString value) Optional. The REST resource name of the trace being written to
Cloud Trace in
association with this log entry. For example, if your trace data is stored
in the Cloud project "my-trace-project" and if the service that is creating
the log entry receives a trace header that includes the trace ID "12345",
then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for trace to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setTraceSampled(boolean value)
public LogEntry.Builder setTraceSampled(boolean value) 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.
bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe traceSampled to set. |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final LogEntry.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder | |