Struct google_logging2::api::WriteLogEntriesRequest

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

The parameters to WriteLogEntries.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• write entries (request)

Fields

dry_run: Option<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.

entries: Option<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 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.

labels: Option<HashMap<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.

log_name: Option<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.

partial_success: Option<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.

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.

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() -> WriteLogEntriesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WriteLogEntriesRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WriteLogEntriesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for WriteLogEntriesRequest