public final class WriteLogEntriesRequest extends com.google.protobuf.GeneratedMessageV3 implements WriteLogEntriesRequestOrBuilder
The parameters to WriteLogEntries.Protobuf type
google.logging.v2.WriteLogEntriesRequest
Modifier and Type | Class and Description |
---|---|
static class |
WriteLogEntriesRequest.Builder
The parameters to WriteLogEntries.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
DRY_RUN_FIELD_NUMBER |
static int |
ENTRIES_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
LOG_NAME_FIELD_NUMBER |
static int |
PARTIAL_SUCCESS_FIELD_NUMBER |
static int |
RESOURCE_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
containsLabels(String key)
Optional.
|
boolean |
equals(Object obj) |
static WriteLogEntriesRequest |
getDefaultInstance() |
WriteLogEntriesRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<WriteLogEntriesRequest> |
getParserForType() |
boolean |
getPartialSuccess()
Optional.
|
com.google.api.MonitoredResource |
getResource()
Optional.
|
com.google.api.MonitoredResourceOrBuilder |
getResourceOrBuilder()
Optional.
|
int |
getSerializedSize() |
int |
hashCode() |
boolean |
hasResource()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static WriteLogEntriesRequest.Builder |
newBuilder() |
static WriteLogEntriesRequest.Builder |
newBuilder(WriteLogEntriesRequest prototype) |
WriteLogEntriesRequest.Builder |
newBuilderForType() |
protected WriteLogEntriesRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static WriteLogEntriesRequest |
parseDelimitedFrom(InputStream input) |
static WriteLogEntriesRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WriteLogEntriesRequest |
parseFrom(byte[] data) |
static WriteLogEntriesRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WriteLogEntriesRequest |
parseFrom(ByteBuffer data) |
static WriteLogEntriesRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WriteLogEntriesRequest |
parseFrom(com.google.protobuf.ByteString data) |
static WriteLogEntriesRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WriteLogEntriesRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static WriteLogEntriesRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static WriteLogEntriesRequest |
parseFrom(InputStream input) |
static WriteLogEntriesRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<WriteLogEntriesRequest> |
parser() |
WriteLogEntriesRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int LOG_NAME_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ENTRIES_FIELD_NUMBER
public static final int PARTIAL_SUCCESS_FIELD_NUMBER
public static final int DRY_RUN_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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) = { ... }
getLogName
in interface WriteLogEntriesRequestOrBuilder
public 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) = { ... }
getLogNameBytes
in interface WriteLogEntriesRequestOrBuilder
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.logging.v2.LogEntry].
.google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
hasResource
in interface WriteLogEntriesRequestOrBuilder
public 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];
getResource
in interface WriteLogEntriesRequestOrBuilder
public 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];
getResourceOrBuilder
in interface WriteLogEntriesRequestOrBuilder
public int getLabelsCount()
WriteLogEntriesRequestOrBuilder
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];
getLabelsCount
in interface WriteLogEntriesRequestOrBuilder
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][google.logging.v2.LogEntry].
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
containsLabels
in interface WriteLogEntriesRequestOrBuilder
@Deprecated public Map<String,String> getLabels()
getLabelsMap()
instead.getLabels
in interface WriteLogEntriesRequestOrBuilder
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][google.logging.v2.LogEntry].
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap
in interface WriteLogEntriesRequestOrBuilder
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][google.logging.v2.LogEntry].
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault
in interface WriteLogEntriesRequestOrBuilder
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][google.logging.v2.LogEntry].
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow
in interface WriteLogEntriesRequestOrBuilder
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][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];
getEntriesList
in interface WriteLogEntriesRequestOrBuilder
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][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
in interface WriteLogEntriesRequestOrBuilder
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][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
in interface WriteLogEntriesRequestOrBuilder
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][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
in interface WriteLogEntriesRequestOrBuilder
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][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
in interface WriteLogEntriesRequestOrBuilder
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];
getPartialSuccess
in interface WriteLogEntriesRequestOrBuilder
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];
getDryRun
in interface WriteLogEntriesRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static WriteLogEntriesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static WriteLogEntriesRequest parseFrom(InputStream input) throws IOException
IOException
public static WriteLogEntriesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static WriteLogEntriesRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static WriteLogEntriesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static WriteLogEntriesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static WriteLogEntriesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public WriteLogEntriesRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static WriteLogEntriesRequest.Builder newBuilder()
public static WriteLogEntriesRequest.Builder newBuilder(WriteLogEntriesRequest prototype)
public WriteLogEntriesRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected WriteLogEntriesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static WriteLogEntriesRequest getDefaultInstance()
public static com.google.protobuf.Parser<WriteLogEntriesRequest> parser()
public com.google.protobuf.Parser<WriteLogEntriesRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public WriteLogEntriesRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.