public interface WriteLogEntriesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key) Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDryRun()
public abstract boolean getDryRun()Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.
bool dry_run = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | The dryRun. |
getEntries(int index)
public abstract LogEntry getEntries(int index) Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
LogEntry | |
getEntriesCount()
public abstract int getEntriesCount() Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
getEntriesList()
public abstract List<LogEntry> getEntriesList() Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<LogEntry> | |
getEntriesOrBuilder(int index)
public abstract LogEntryOrBuilder getEntriesOrBuilder(int index) Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
LogEntryOrBuilder | |
getEntriesOrBuilderList()
public abstract List<? extends LogEntryOrBuilder> getEntriesOrBuilderList() Required. The log entries to send to Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name, resource, and labels fields are copied into those log
entries in this list that do not include values for their corresponding
fields. For more information, see the
LogEntry type.
If the timestamp or insert_id fields are missing in log entries, then
this method supplies the current time or a unique identifier, respectively.
The supplied values are chosen so that, among the log entries that did not
supply their own values, the entries earlier in the list will sort before
the entries later in the list. See the entries.list method.
Log entries with timestamps that are more than the
logs retention period in
the past or more than 24 hours in the future will not be available when
calling entries.list. However, those log entries can still be exported
with
LogSinks.
To improve throughput and to avoid exceeding the
quota limit for calls to
entries.write, you should try to include several log entries in this
list, rather than calling this method for each individual log entry.
repeated .google.logging.v2.LogEntry entries = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.logging.v2.LogEntryOrBuilder> | |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract int getLabelsCount() Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public abstract Map<String,String> getLabelsMap() Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue) Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key) Optional. Default labels that are added to the labels field of all log
entries in entries. If a log entry already has a label with the same key
as a label in this parameter, then the log entry's label is not changed.
See LogEntry.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLogName()
public abstract String getLogName() Optional. A default log resource name that is assigned to all log entries
in entries that do not specify a value for log_name:
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][LOG_ID]must be URL-encoded. For example:"projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
The permission
logging.logEntries.createis needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified inlogNameor in an individual log entry.
string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The logName. |
getLogNameBytes()
public abstract ByteString getLogNameBytes() Optional. A default log resource name that is assigned to all log entries
in entries that do not specify a value for log_name:
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][LOG_ID]must be URL-encoded. For example:"projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
The permission
logging.logEntries.createis needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified inlogNameor in an individual log entry.
string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for logName. |
getPartialSuccess()
public abstract boolean getPartialSuccess() Optional. Whether a batch's valid entries should be written even if some
other entry failed due to a permanent error such as INVALID_ARGUMENT or
PERMISSION_DENIED. If any entry failed, then the response status is the
response status of one of the failed entries. The response will include
error details in WriteLogEntriesPartialErrors.log_entry_errors keyed by
the entries' zero-based index in the entries. Failed requests for which
no entries are written will not include per-entry errors.
bool partial_success = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | The partialSuccess. |
getResource()
public abstract MonitoredResource getResource() Optional. A default monitored resource object that is assigned to all log
entries in entries that do not specify a value for resource. Example:
{ "type": "gce_instance",
"labels": {
"zone": "us-central1-a", "instance_id": "00000000000000000000" }}
See LogEntry.
.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource | The resource. |
getResourceOrBuilder()
public abstract MonitoredResourceOrBuilder getResourceOrBuilder() Optional. A default monitored resource object that is assigned to all log
entries in entries that do not specify a value for resource. Example:
{ "type": "gce_instance",
"labels": {
"zone": "us-central1-a", "instance_id": "00000000000000000000" }}
See LogEntry.
.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceOrBuilder | |
hasResource()
public abstract boolean hasResource() Optional. A default monitored resource object that is assigned to all log
entries in entries that do not specify a value for resource. Example:
{ "type": "gce_instance",
"labels": {
"zone": "us-central1-a", "instance_id": "00000000000000000000" }}
See LogEntry.
.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the resource field is set. |