Struct LogSink

pub struct LogSink {
    pub name: String,
    pub destination: String,
    pub filter: String,
    pub description: String,
    pub disabled: bool,
    pub exclusions: Vec<LogExclusion>,
    pub output_version_format: i32,
    pub writer_identity: String,
    pub include_children: bool,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub options: Option<Options>,
}

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

Fields

name: String

Required. The client-assigned sink identifier, unique within the project.

For 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. First character has to be alphanumeric.

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

For example:

logName="projects/\[PROJECT_ID\]/logs/\[LOG_ID\]" AND severity>=ERROR

description: String

Optional. A description of this sink.

The maximum length of the description is 8000 characters.

disabled: bool

Optional. If set to true, then this sink is disabled and it does not export any log entries.

exclusions: Vec<LogExclusion>

Optional. Log entries that match any of these exclusion filters will not be exported.

If a log entry is matched by both filter and one of exclusion_filters it will not be exported.

output_version_format: i32

👎Deprecated

Deprecated. This field is unused.

writer_identity: String

Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink’s destination. This field is either set by specifying custom_writer_identity or set automatically by [sinks.create][google.logging.v2.ConfigServiceV2.CreateSink] and [sinks.update][google.logging.v2.ConfigServiceV2.UpdateSink] based on the value 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.

Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required.

include_children: 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 log entries 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

create_time: Option<Timestamp>

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

update_time: Option<Timestamp>

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

options: Option<Options>

Destination dependent options.

Implementations

impl LogSink

pub fn output_version_format(&self) -> VersionFormat

Returns the enum value of output_version_format, or the default if the field is set to an invalid enum value.

pub fn set_output_version_format(&mut self, value: VersionFormat)

Sets output_version_format to the provided enum value.

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

Returns the “default value” for a type.

impl Message for LogSink

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 LogSink

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for LogSink