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(java.lang.String key) Optional.
LogEntry	getEntries(int index) Required.
int	getEntriesCount() Required.
java.util.List<LogEntry>	getEntriesList() Required.
LogEntryOrBuilder	getEntriesOrBuilder(int index) Required.
java.util.List<? extends LogEntryOrBuilder>	getEntriesOrBuilderList() Required.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Optional.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Optional.
java.lang.String	getLabelsOrThrow(java.lang.String key) Optional.
java.lang.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

java.lang.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"` or
 `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
 For more information about log names, see
 [LogEntry][google.logging.v2.LogEntry].
 

string log_name = 1;

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"` or
 `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
 For more information about log names, see
 [LogEntry][google.logging.v2.LogEntry].
 

string log_name = 1;

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;

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;

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;

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;

containsLabels

boolean containsLabels(java.lang.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;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.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;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.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;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.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;

getEntriesList

java.util.List<LogEntry> getEntriesList()

 Required.  The log entries to write. Values supplied for the fields
 `log_name`, `resource`, and `labels` in this `entries.write` request are
 inserted into those log entries in this list that do not provide their own
 values.
 Stackdriver Logging also creates and inserts values for `timestamp` and
 `insert_id` if the entries do not provide them. The created `insert_id` for
 the N'th entry in this list will be greater than earlier entries and less
 than later entries.  Otherwise, the order of log entries in this list does
 not matter.
 To improve throughput and to avoid exceeding the
 [quota limit](/logging/quota-policy) for calls to `entries.write`,
 you should write multiple log entries at once rather than
 calling this method for each individual log entry.
 

repeated .google.logging.v2.LogEntry entries = 4;

getEntries

LogEntry getEntries(int index)

 Required.  The log entries to write. Values supplied for the fields
 `log_name`, `resource`, and `labels` in this `entries.write` request are
 inserted into those log entries in this list that do not provide their own
 values.
 Stackdriver Logging also creates and inserts values for `timestamp` and
 `insert_id` if the entries do not provide them. The created `insert_id` for
 the N'th entry in this list will be greater than earlier entries and less
 than later entries.  Otherwise, the order of log entries in this list does
 not matter.
 To improve throughput and to avoid exceeding the
 [quota limit](/logging/quota-policy) for calls to `entries.write`,
 you should write multiple log entries at once rather than
 calling this method for each individual log entry.
 

repeated .google.logging.v2.LogEntry entries = 4;

getEntriesCount

int getEntriesCount()

 Required.  The log entries to write. Values supplied for the fields
 `log_name`, `resource`, and `labels` in this `entries.write` request are
 inserted into those log entries in this list that do not provide their own
 values.
 Stackdriver Logging also creates and inserts values for `timestamp` and
 `insert_id` if the entries do not provide them. The created `insert_id` for
 the N'th entry in this list will be greater than earlier entries and less
 than later entries.  Otherwise, the order of log entries in this list does
 not matter.
 To improve throughput and to avoid exceeding the
 [quota limit](/logging/quota-policy) for calls to `entries.write`,
 you should write multiple log entries at once rather than
 calling this method for each individual log entry.
 

repeated .google.logging.v2.LogEntry entries = 4;

getEntriesOrBuilderList

java.util.List<? extends LogEntryOrBuilder> getEntriesOrBuilderList()

 Required.  The log entries to write. Values supplied for the fields
 `log_name`, `resource`, and `labels` in this `entries.write` request are
 inserted into those log entries in this list that do not provide their own
 values.
 Stackdriver Logging also creates and inserts values for `timestamp` and
 `insert_id` if the entries do not provide them. The created `insert_id` for
 the N'th entry in this list will be greater than earlier entries and less
 than later entries.  Otherwise, the order of log entries in this list does
 not matter.
 To improve throughput and to avoid exceeding the
 [quota limit](/logging/quota-policy) for calls to `entries.write`,
 you should write multiple log entries at once rather than
 calling this method for each individual log entry.
 

repeated .google.logging.v2.LogEntry entries = 4;

getEntriesOrBuilder

LogEntryOrBuilder getEntriesOrBuilder(int index)

 Required.  The log entries to write. Values supplied for the fields
 `log_name`, `resource`, and `labels` in this `entries.write` request are
 inserted into those log entries in this list that do not provide their own
 values.
 Stackdriver Logging also creates and inserts values for `timestamp` and
 `insert_id` if the entries do not provide them. The created `insert_id` for
 the N'th entry in this list will be greater than earlier entries and less
 than later entries.  Otherwise, the order of log entries in this list does
 not matter.
 To improve throughput and to avoid exceeding the
 [quota limit](/logging/quota-policy) for calls to `entries.write`,
 you should write multiple log entries at once rather than
 calling this method for each individual log entry.
 

repeated .google.logging.v2.LogEntry entries = 4;

getPartialSuccess

boolean getPartialSuccess()

 Optional. Whether valid entries should be written even if some other
 entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
 entry is not written, then the response status is the error associated
 with one of the failed entries and the response includes error details
 keyed by the entries' zero-based index in the `entries.write` method.
 

bool partial_success = 5;