public final class WriteLogEntriesRequest extends GeneratedMessageV3 implements WriteLogEntriesRequestOrBuilder
The parameters to WriteLogEntries.
Protobuf type google.logging.v2.WriteLogEntriesRequest
Static Fields
DRY_RUN_FIELD_NUMBER
public static final int DRY_RUN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTRIES_FIELD_NUMBER
public static final int ENTRIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOG_NAME_FIELD_NUMBER
public static final int LOG_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARTIAL_SUCCESS_FIELD_NUMBER
public static final int PARTIAL_SUCCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static WriteLogEntriesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WriteLogEntriesRequest.Builder newBuilder()
newBuilder(WriteLogEntriesRequest prototype)
public static WriteLogEntriesRequest.Builder newBuilder(WriteLogEntriesRequest prototype)
public static WriteLogEntriesRequest parseDelimitedFrom(InputStream input)
public static WriteLogEntriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WriteLogEntriesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WriteLogEntriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WriteLogEntriesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WriteLogEntriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WriteLogEntriesRequest parseFrom(CodedInputStream input)
public static WriteLogEntriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WriteLogEntriesRequest parseFrom(InputStream input)
public static WriteLogEntriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WriteLogEntriesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WriteLogEntriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WriteLogEntriesRequest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public WriteLogEntriesRequest getDefaultInstanceForType()
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
|
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];
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
|
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()
public Map<String,String> getLabels()
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];
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];
| 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.
|
getParserForType()
public Parser<WriteLogEntriesRequest> getParserForType()
Overrides
getPartialSuccess()
public 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 [(.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.
|
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 |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WriteLogEntriesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WriteLogEntriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public WriteLogEntriesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
