Struct LogSink 

#[non_exhaustive]
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: VersionFormat,
    pub writer_identity: String,
    pub include_children: bool,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub options: Option<Options>,
    /* private fields */
}

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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: VersionFormat

👎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 and sinks.update 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 new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_destination<T: Into<String>>(self, v: T) -> Self

Sets the value of destination.

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_disabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of disabled.

pub fn set_exclusions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<LogExclusion>,

Sets the value of exclusions.

pub fn set_output_version_format<T: Into<VersionFormat>>(self, v: T) -> Self

👎Deprecated

Sets the value of output_version_format.

pub fn set_writer_identity<T: Into<String>>(self, v: T) -> Self

Sets the value of writer_identity.

pub fn set_include_children<T: Into<bool>>(self, v: T) -> Self

Sets the value of include_children.

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

pub fn set_options<T: Into<Option<Options>>>(self, v: T) -> Self

Sets the value of options.

Note that all the setters affecting options are mutually exclusive.

pub fn bigquery_options(&self) -> Option<&Box<BigQueryOptions>>

The value of options if it holds a BigqueryOptions, None if the field is not set or holds a different branch.

pub fn set_bigquery_options<T: Into<Box<BigQueryOptions>>>(self, v: T) -> Self

Sets the value of options to hold a BigqueryOptions.

Note that all the setters affecting options are mutually exclusive.

Trait Implementations

impl Clone for LogSink

fn clone(&self) -> LogSink

Returns a duplicate 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 Message for LogSink

fn typename() -> &'static str

The typename of this message.

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