Struct googapis::google::logging::v2::LogSink [−][src]
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>,
}
Expand description
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.
Fields
name: 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.
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 the 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. This field is unused.
writer_identity: String
Output only. An IAM identity—a service account or group—under which Logging
writes the exported log entries to the sink’s destination. This field is
set 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.
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
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
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
Returns the enum value of output_version_format
, or the default if the field is set to an invalid enum value.
Sets output_version_format
to the provided enum value.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for LogSink
impl UnwindSafe for LogSink
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more