Struct google_api_proto::google::logging::v2::WriteLogEntriesRequest

pub struct WriteLogEntriesRequest {
    pub log_name: String,
    pub resource: Option<MonitoredResource>,
    pub labels: BTreeMap<String, String>,
    pub entries: Vec<LogEntry>,
    pub partial_success: bool,
    pub dry_run: bool,
}

The parameters to WriteLogEntries.

Fields

log_name: String

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.

resource: Option<MonitoredResource>

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].

labels: BTreeMap<String, String>

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].

entries: Vec<LogEntry>

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 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.

partial_success: bool

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.

dry_run: bool

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.

Trait Implementations

impl Clone for WriteLogEntriesRequest

fn clone(&self) -> WriteLogEntriesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteLogEntriesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WriteLogEntriesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for WriteLogEntriesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for WriteLogEntriesRequest

fn eq(&self, other: &WriteLogEntriesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WriteLogEntriesRequest