Struct google_logging2::api::LogSink
source · pub struct LogSink {
pub bigquery_options: Option<BigQueryOptions>,
pub create_time: Option<DateTime<Utc>>,
pub description: Option<String>,
pub destination: Option<String>,
pub disabled: Option<bool>,
pub exclusions: Option<Vec<LogExclusion>>,
pub filter: Option<String>,
pub include_children: Option<bool>,
pub name: Option<String>,
pub output_version_format: Option<String>,
pub update_time: Option<DateTime<Utc>>,
pub writer_identity: Option<String>,
}Expand description
Describes a sink used to export log entries to one of the following destinations: a Cloud Logging log bucket, a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic, a Cloud project.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 create billing accounts (request|response)
- sinks get billing accounts (response)
- sinks patch billing accounts (request|response)
- sinks update billing accounts (request|response)
- sinks create folders (request|response)
- sinks get folders (response)
- sinks patch folders (request|response)
- sinks update folders (request|response)
- sinks create organizations (request|response)
- sinks get organizations (response)
- sinks patch organizations (request|response)
- sinks update organizations (request|response)
- sinks create projects (request|response)
- sinks get projects (response)
- sinks patch projects (request|response)
- sinks update projects (request|response)
- create sinks (request|response)
- get sinks (response)
- update sinks (request|response)
Fields§
§bigquery_options: Option<BigQueryOptions>Optional. Options that affect sinks exporting data to BigQuery.
create_time: Option<DateTime<Utc>>Output only. The creation timestamp of the sink.This field may not be present for older sinks.
description: Option<String>Optional. A description of this sink.The maximum length of the description is 8000 characters.
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]” “logging.googleapis.com/projects/[PROJECT_ID]” “logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_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 (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
disabled: Option<bool>Optional. If set to true, then this sink is disabled and it does not export any log entries.
exclusions: Option<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.
filter: Option<String>Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). 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
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 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
name: Option<String>Output only. 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, periods.First character has to be alphanumeric.
output_version_format: Option<String>Deprecated. This field is unused.
update_time: Option<DateTime<Utc>>Output only. The last update timestamp of the sink.This field may not be present for older sinks.
writer_identity: Option<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 (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_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.