Struct google_logging2::LogSink

pub struct LogSink {
    pub output_version_format: Option<String>,
    pub name: Option<String>,
    pub destination: Option<String>,
    pub filter: Option<String>,
    pub start_time: Option<String>,
    pub end_time: Option<String>,
    pub writer_identity: Option<String>,
    pub include_children: Option<bool>,
}

Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.

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

• sinks update projects (request|response)
• sinks get billing accounts (response)
• sinks create billing accounts (request|response)
• sinks create folders (request|response)
• sinks create organizations (request|response)
• sinks update organizations (request|response)
• sinks update billing accounts (request|response)
• sinks get organizations (response)
• sinks create projects (request|response)
• sinks update folders (request|response)
• sinks get projects (response)
• sinks get folders (response)

Fields

output_version_format: Option<String>

Optional. The log entry format to use for this sink’s exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.

name: Option<String>

Required. The client-assigned sink identifier, unique within the project. Example: “my-syslog-errors-to-pubsub”. Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.

destination: Option<String>

Required. The export destination: “storage.googleapis.com/[GCS_BUCKET]” “bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]” “pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]” The sink’s writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.

filter: Option<String>

Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format: logName=“projects/[PROJECT_ID]/logs/[LOG_ID]” AND severity>=ERROR

start_time: Option<String>

Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.

end_time: Option<String>

Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.

writer_identity: Option<String>

Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink’s destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service’s documentation to determine the appropriate IAM roles to assign to the identity.

include_children: Option<bool>

Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink’s parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink’s parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink’s filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink’s parent. To only export entries from certain child projects, filter on the project part of the log name: logName:(“projects/test-project1/” OR “projects/test-project2/”) AND resource.type=gce_instance

Trait Implementations

impl Clone for LogSink

fn clone(&self) -> LogSink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogSink

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

Formats the value using the given formatter.

impl Default for LogSink

fn default() -> LogSink

Returns the “default value” for a type.

impl Deserialize for LogSink

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

where __D: Deserializer,

Deserialize this value from the given Serde deserializer.

impl Serialize for LogSink

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 LogSink

impl ResponseResult for LogSink