Package com.google.logging.v2

Class WriteLogEntriesRequest

  • All Implemented Interfaces:
    WriteLogEntriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class WriteLogEntriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements WriteLogEntriesRequestOrBuilder
     The parameters to WriteLogEntries.
    Protobuf type google.logging.v2.WriteLogEntriesRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getLogName in interface WriteLogEntriesRequestOrBuilder
        Returns:
        The logName.

      • getLogNameBytes

        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) = { ... }
        Specified by:
        getLogNameBytes in interface WriteLogEntriesRequestOrBuilder
        Returns:
        The bytes for logName.

      • 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.logging.v2.LogEntry].
        .google.api.MonitoredResource resource = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasResource in interface WriteLogEntriesRequestOrBuilder
        Returns:
        Whether the resource field is set.

      • getResource

        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];
        Specified by:
        getResource in interface WriteLogEntriesRequestOrBuilder
        Returns:
        The resource.

      • getResourceOrBuilder

        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];
        Specified by:
        getResourceOrBuilder in interface WriteLogEntriesRequestOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: 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];
        Specified by:
        getLabelsCount in interface WriteLogEntriesRequestOrBuilder

      • containsLabels

        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];
        Specified by:
        containsLabels in interface WriteLogEntriesRequestOrBuilder

      • 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][google.logging.v2.LogEntry].
        map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface WriteLogEntriesRequestOrBuilder

      • getLabelsOrDefault

        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];
        Specified by:
        getLabelsOrDefault in interface WriteLogEntriesRequestOrBuilder

      • getLabelsOrThrow

        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];
        Specified by:
        getLabelsOrThrow in interface WriteLogEntriesRequestOrBuilder

      • 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][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];
        Specified by:
        getEntriesList in interface WriteLogEntriesRequestOrBuilder

      • 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][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];
        Specified by:
        getEntriesOrBuilderList in interface WriteLogEntriesRequestOrBuilder

      • 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][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];
        Specified by:
        getEntriesCount in interface WriteLogEntriesRequestOrBuilder

      • getEntries

        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];
        Specified by:
        getEntries in interface WriteLogEntriesRequestOrBuilder

      • getEntriesOrBuilder

        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];
        Specified by:
        getEntriesOrBuilder in interface WriteLogEntriesRequestOrBuilder

      • 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];
        Specified by:
        getPartialSuccess in interface WriteLogEntriesRequestOrBuilder
        Returns:
        The partialSuccess.

      • 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];
        Specified by:
        getDryRun in interface WriteLogEntriesRequestOrBuilder
        Returns:
        The dryRun.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WriteLogEntriesRequest parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public WriteLogEntriesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public WriteLogEntriesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected WriteLogEntriesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<WriteLogEntriesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public WriteLogEntriesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder