com.google.logging.v2

Interface WriteLogEntriesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WriteLogEntriesRequest, WriteLogEntriesRequest.Builder

public interface WriteLogEntriesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
boolean	getDryRun() Optional.
LogEntry	getEntries(int index) Required.
int	getEntriesCount() Required.
List<LogEntry>	getEntriesList() Required.
LogEntryOrBuilder	getEntriesOrBuilder(int index) Required.
List<? extends LogEntryOrBuilder>	getEntriesOrBuilderList() Required.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getLogName() Optional.
com.google.protobuf.ByteString	getLogNameBytes() Optional.
boolean	getPartialSuccess() Optional.
com.google.api.MonitoredResource	getResource() Optional.
com.google.api.MonitoredResourceOrBuilder	getResourceOrBuilder() Optional.
boolean	hasResource() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getLogName

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:

The logName.

getLogNameBytes

com.google.protobuf.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:

The bytes for logName.

hasResource

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.logging.v2.LogEntry].
 

.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the resource field is set.

getResource

com.google.api.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.logging.v2.LogEntry].
 

.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The resource.

getResourceOrBuilder

com.google.api.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.logging.v2.LogEntry].
 

.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];

getLabelsCount

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][google.logging.v2.LogEntry].
 

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

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][google.logging.v2.LogEntry].
 

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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][google.logging.v2.LogEntry].
 

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

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][google.logging.v2.LogEntry].
 

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

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][google.logging.v2.LogEntry].
 

map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];

getEntriesList

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][google.logging.v2.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](https://cloud.google.com/logging/quotas) 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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

 To improve throughput and to avoid exceeding the
 [quota limit](https://cloud.google.com/logging/quotas) 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];

getEntries

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][google.logging.v2.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](https://cloud.google.com/logging/quotas) 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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

 To improve throughput and to avoid exceeding the
 [quota limit](https://cloud.google.com/logging/quotas) 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];

getEntriesCount

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][google.logging.v2.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](https://cloud.google.com/logging/quotas) 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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

 To improve throughput and to avoid exceeding the
 [quota limit](https://cloud.google.com/logging/quotas) 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];

getEntriesOrBuilderList

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][google.logging.v2.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](https://cloud.google.com/logging/quotas) 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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

 To improve throughput and to avoid exceeding the
 [quota limit](https://cloud.google.com/logging/quotas) 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];

getEntriesOrBuilder

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][google.logging.v2.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](https://cloud.google.com/logging/quotas) 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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

 To improve throughput and to avoid exceeding the
 [quota limit](https://cloud.google.com/logging/quotas) 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];

getPartialSuccess

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:

The partialSuccess.

getDryRun

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:

The dryRun.