Class WriteLogEntriesRequest.Builder (3.17.0)

public static final class WriteLogEntriesRequest.Builder extends GeneratedMessageV3.Builder<WriteLogEntriesRequest.Builder> implements WriteLogEntriesRequestOrBuilder

The parameters to WriteLogEntries.

Protobuf type google.logging.v2.WriteLogEntriesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllEntries(Iterable<? extends LogEntry> values)

public WriteLogEntriesRequest.Builder addAllEntries(Iterable<? extends LogEntry> values)

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
values Iterable<? extends com.google.logging.v2.LogEntry>
Returns
Type Description
WriteLogEntriesRequest.Builder

addEntries(LogEntry value)

public WriteLogEntriesRequest.Builder addEntries(LogEntry value)

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
value LogEntry
Returns
Type Description
WriteLogEntriesRequest.Builder

addEntries(LogEntry.Builder builderForValue)

public WriteLogEntriesRequest.Builder addEntries(LogEntry.Builder builderForValue)

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
builderForValue LogEntry.Builder
Returns
Type Description
WriteLogEntriesRequest.Builder

addEntries(int index, LogEntry value)

public WriteLogEntriesRequest.Builder addEntries(int index, LogEntry value)

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];

Parameters
Name Description
index int
value LogEntry
Returns
Type Description
WriteLogEntriesRequest.Builder

addEntries(int index, LogEntry.Builder builderForValue)

public WriteLogEntriesRequest.Builder addEntries(int index, LogEntry.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LogEntry.Builder
Returns
Type Description
WriteLogEntriesRequest.Builder

addEntriesBuilder()

public LogEntry.Builder addEntriesBuilder()

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
LogEntry.Builder

addEntriesBuilder(int index)

public LogEntry.Builder addEntriesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteLogEntriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

build()

public WriteLogEntriesRequest build()
Returns
Type Description
WriteLogEntriesRequest

buildPartial()

public WriteLogEntriesRequest buildPartial()
Returns
Type Description
WriteLogEntriesRequest

clear()

public WriteLogEntriesRequest.Builder clear()
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

clearDryRun()

public WriteLogEntriesRequest.Builder clearDryRun()

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
WriteLogEntriesRequest.Builder

This builder for chaining.

clearEntries()

public WriteLogEntriesRequest.Builder clearEntries()

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
WriteLogEntriesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public WriteLogEntriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

clearLabels()

public WriteLogEntriesRequest.Builder clearLabels()
Returns
Type Description
WriteLogEntriesRequest.Builder

clearLogName()

public WriteLogEntriesRequest.Builder clearLogName()

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.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.

string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
WriteLogEntriesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteLogEntriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

clearPartialSuccess()

public WriteLogEntriesRequest.Builder clearPartialSuccess()

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
WriteLogEntriesRequest.Builder

This builder for chaining.

clearResource()

public WriteLogEntriesRequest.Builder clearResource()

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
WriteLogEntriesRequest.Builder

clone()

public WriteLogEntriesRequest.Builder clone()
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

containsLabels(String key)

public 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

getDefaultInstanceForType()

public WriteLogEntriesRequest getDefaultInstanceForType()
Returns
Type Description
WriteLogEntriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDryRun()

public 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 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

getEntriesBuilder(int index)

public LogEntry.Builder getEntriesBuilder(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.Builder

getEntriesBuilderList()

public List<LogEntry.Builder> getEntriesBuilderList()

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<Builder>

getEntriesCount()

public 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 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 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 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() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or 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 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.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or 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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getPartialSuccess()

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

getResourceBuilder()

public MonitoredResource.Builder getResourceBuilder()

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

getResourceOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WriteLogEntriesRequest other)

public WriteLogEntriesRequest.Builder mergeFrom(WriteLogEntriesRequest other)
Parameter
Name Description
other WriteLogEntriesRequest
Returns
Type Description
WriteLogEntriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteLogEntriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WriteLogEntriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

mergeResource(MonitoredResource value)

public WriteLogEntriesRequest.Builder mergeResource(MonitoredResource value)

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];

Parameter
Name Description
value com.google.api.MonitoredResource
Returns
Type Description
WriteLogEntriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteLogEntriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

public WriteLogEntriesRequest.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
WriteLogEntriesRequest.Builder

putLabels(String key, String value)

public WriteLogEntriesRequest.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
WriteLogEntriesRequest.Builder

removeEntries(int index)

public WriteLogEntriesRequest.Builder removeEntries(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
WriteLogEntriesRequest.Builder

removeLabels(String key)

public WriteLogEntriesRequest.Builder removeLabels(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
WriteLogEntriesRequest.Builder

setDryRun(boolean value)

public WriteLogEntriesRequest.Builder setDryRun(boolean value)

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];

Parameter
Name Description
value boolean

The dryRun to set.

Returns
Type Description
WriteLogEntriesRequest.Builder

This builder for chaining.

setEntries(int index, LogEntry value)

public WriteLogEntriesRequest.Builder setEntries(int index, LogEntry value)

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];

Parameters
Name Description
index int
value LogEntry
Returns
Type Description
WriteLogEntriesRequest.Builder

setEntries(int index, LogEntry.Builder builderForValue)

public WriteLogEntriesRequest.Builder setEntries(int index, LogEntry.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue LogEntry.Builder
Returns
Type Description
WriteLogEntriesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteLogEntriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

setLogName(String value)

public WriteLogEntriesRequest.Builder setLogName(String value)

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.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.

string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The logName to set.

Returns
Type Description
WriteLogEntriesRequest.Builder

This builder for chaining.

setLogNameBytes(ByteString value)

public WriteLogEntriesRequest.Builder setLogNameBytes(ByteString value)

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.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.

string log_name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for logName to set.

Returns
Type Description
WriteLogEntriesRequest.Builder

This builder for chaining.

setPartialSuccess(boolean value)

public WriteLogEntriesRequest.Builder setPartialSuccess(boolean value)

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];

Parameter
Name Description
value boolean

The partialSuccess to set.

Returns
Type Description
WriteLogEntriesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WriteLogEntriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides

setResource(MonitoredResource value)

public WriteLogEntriesRequest.Builder setResource(MonitoredResource value)

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];

Parameter
Name Description
value com.google.api.MonitoredResource
Returns
Type Description
WriteLogEntriesRequest.Builder

setResource(MonitoredResource.Builder builderForValue)

public WriteLogEntriesRequest.Builder setResource(MonitoredResource.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.api.MonitoredResource.Builder
Returns
Type Description
WriteLogEntriesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteLogEntriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteLogEntriesRequest.Builder
Overrides