sinks

Creates, updates, deletes, gets or lists a sinks resource.

Overview

Name	`sinks`
Type	Resource
Id	`google.logging.sinks`

Fields

The following fields are returned by SELECT queries:

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Successful response

Name	Datatype	Description
`name`	`string`	Optional. 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.
`bigqueryOptions`	`object`	Optional. Options that affect sinks exporting data to BigQuery. (id: BigQueryOptions)
`createTime`	`string (google-datetime)`	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
`description`	`string`	Optional. A description of this sink.The maximum length of the description is 8000 characters.
`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]" "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`	`boolean`	Optional. If set to true, then this sink is disabled and it does not export any log entries.
`exclusions`	`array`	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 exclusions it will not be exported.
`filter`	`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
`includeChildren`	`boolean`	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
`interceptChildren`	`boolean`	Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
`outputVersionFormat`	`string`	Deprecated. This field is unused.
`resourceName`	`string`	Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME
`updateTime`	`string (google-datetime)`	Output only. The last update timestamp of the sink.This field may not be present for older sinks.
`writerIdentity`	`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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`sinks_list`	`select`	`parentType`, `parent`	`pageToken`, `pageSize`, `filter`	Lists sinks.
`projects_sinks_get`	`select`	`projectsId`, `sinksId`		Gets a sink.
`organizations_sinks_get`	`select`	`organizationsId`, `sinksId`		Gets a sink.
`folders_sinks_get`	`select`	`foldersId`, `sinksId`		Gets a sink.
`billing_accounts_sinks_get`	`select`	`billingAccountsId`, `sinksId`		Gets a sink.
`sinks_get`	`select`	`sinkName`		Gets a sink.
`projects_sinks_list`	`select`	`projectsId`	`pageToken`, `pageSize`, `filter`	Lists sinks.
`organizations_sinks_list`	`select`	`organizationsId`	`pageToken`, `pageSize`, `filter`	Lists sinks.
`folders_sinks_list`	`select`	`foldersId`	`pageToken`, `pageSize`, `filter`	Lists sinks.
`billing_accounts_sinks_list`	`select`	`billingAccountsId`	`pageToken`, `pageSize`, `filter`	Lists sinks.
`sinks_create`	`insert`	`parentType`, `parent`	`uniqueWriterIdentity`, `customWriterIdentity`	Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
`projects_sinks_create`	`insert`	`projectsId`	`uniqueWriterIdentity`, `customWriterIdentity`	Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
`organizations_sinks_create`	`insert`	`organizationsId`	`uniqueWriterIdentity`, `customWriterIdentity`	Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
`folders_sinks_create`	`insert`	`foldersId`	`uniqueWriterIdentity`, `customWriterIdentity`	Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
`billing_accounts_sinks_create`	`insert`	`billingAccountsId`	`uniqueWriterIdentity`, `customWriterIdentity`	Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
`projects_sinks_patch`	`update`	`projectsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`organizations_sinks_patch`	`update`	`organizationsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`folders_sinks_patch`	`update`	`foldersId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`billing_accounts_sinks_patch`	`update`	`billingAccountsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`projects_sinks_update`	`replace`	`projectsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`organizations_sinks_update`	`replace`	`organizationsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`folders_sinks_update`	`replace`	`foldersId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`billing_accounts_sinks_update`	`replace`	`billingAccountsId`, `sinksId`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`sinks_update`	`replace`	`sinkName`	`uniqueWriterIdentity`, `customWriterIdentity`, `updateMask`	Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.
`projects_sinks_delete`	`delete`	`projectsId`, `sinksId`		Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
`organizations_sinks_delete`	`delete`	`organizationsId`, `sinksId`		Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
`folders_sinks_delete`	`delete`	`foldersId`, `sinksId`		Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
`billing_accounts_sinks_delete`	`delete`	`billingAccountsId`, `sinksId`		Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
`sinks_delete`	`delete`	`sinkName`		Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`billingAccountsId`	`string`
`foldersId`	`string`
`organizationsId`	`string`
`parent`	`string`
`parentType`	`string`
`projectsId`	`string`
`sinkName`	`string`
`sinksId`	`string`
`customWriterIdentity`	`string`
`filter`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`uniqueWriterIdentity`	`boolean`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

Lists sinks.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE parentType = '{{ parentType }}' -- required
AND parent = '{{ parent }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

Gets a sink.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE projectsId = '{{ projectsId }}' -- required
AND sinksId = '{{ sinksId }}' -- required;

Gets a sink.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sinksId = '{{ sinksId }}' -- required;

Gets a sink.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE foldersId = '{{ foldersId }}' -- required
AND sinksId = '{{ sinksId }}' -- required;

Gets a sink.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE billingAccountsId = '{{ billingAccountsId }}' -- required
AND sinksId = '{{ sinksId }}' -- required;

Gets a sink.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE sinkName = '{{ sinkName }}' -- required;

Lists sinks.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

Lists sinks.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

Lists sinks.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

Lists sinks.

SELECT
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
FROM google.logging.sinks
WHERE billingAccountsId = '{{ billingAccountsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}';

`INSERT` examples

Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

INSERT INTO google.logging.sinks (
data__name,
data__destination,
data__filter,
data__description,
data__disabled,
data__exclusions,
data__outputVersionFormat,
data__includeChildren,
data__interceptChildren,
data__bigqueryOptions,
parentType,
parent,
uniqueWriterIdentity,
customWriterIdentity
)
SELECT 
'{{ name }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}',
'{{ parentType }}',
'{{ parent }}',
'{{ uniqueWriterIdentity }}',
'{{ customWriterIdentity }}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
;

INSERT INTO google.logging.sinks (
data__name,
data__destination,
data__filter,
data__description,
data__disabled,
data__exclusions,
data__outputVersionFormat,
data__includeChildren,
data__interceptChildren,
data__bigqueryOptions,
projectsId,
uniqueWriterIdentity,
customWriterIdentity
)
SELECT 
'{{ name }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}',
'{{ projectsId }}',
'{{ uniqueWriterIdentity }}',
'{{ customWriterIdentity }}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
;

INSERT INTO google.logging.sinks (
data__name,
data__destination,
data__filter,
data__description,
data__disabled,
data__exclusions,
data__outputVersionFormat,
data__includeChildren,
data__interceptChildren,
data__bigqueryOptions,
organizationsId,
uniqueWriterIdentity,
customWriterIdentity
)
SELECT 
'{{ name }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}',
'{{ organizationsId }}',
'{{ uniqueWriterIdentity }}',
'{{ customWriterIdentity }}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
;

INSERT INTO google.logging.sinks (
data__name,
data__destination,
data__filter,
data__description,
data__disabled,
data__exclusions,
data__outputVersionFormat,
data__includeChildren,
data__interceptChildren,
data__bigqueryOptions,
foldersId,
uniqueWriterIdentity,
customWriterIdentity
)
SELECT 
'{{ name }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}',
'{{ foldersId }}',
'{{ uniqueWriterIdentity }}',
'{{ customWriterIdentity }}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
;

INSERT INTO google.logging.sinks (
data__name,
data__destination,
data__filter,
data__description,
data__disabled,
data__exclusions,
data__outputVersionFormat,
data__includeChildren,
data__interceptChildren,
data__bigqueryOptions,
billingAccountsId,
uniqueWriterIdentity,
customWriterIdentity
)
SELECT 
'{{ name }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}',
'{{ billingAccountsId }}',
'{{ uniqueWriterIdentity }}',
'{{ customWriterIdentity }}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity
;

# Description fields are for documentation purposes
- name: sinks
  props:
    - name: parentType
      value: string
      description: Required parameter for the sinks resource.
    - name: parent
      value: string
      description: Required parameter for the sinks resource.
    - name: projectsId
      value: string
      description: Required parameter for the sinks resource.
    - name: organizationsId
      value: string
      description: Required parameter for the sinks resource.
    - name: foldersId
      value: string
      description: Required parameter for the sinks resource.
    - name: billingAccountsId
      value: string
      description: Required parameter for the sinks resource.
    - name: name
      value: string
      description: >
        Optional. 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.
        
    - name: destination
      value: string
      description: >
        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).
        
    - name: filter
      value: string
      description: >
        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
        
    - name: description
      value: string
      description: >
        Optional. A description of this sink.The maximum length of the description is 8000 characters.
        
    - name: disabled
      value: boolean
      description: >
        Optional. If set to true, then this sink is disabled and it does not export any log entries.
        
    - name: exclusions
      value: array
      description: >
        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 exclusions it will not be exported.
        
    - name: outputVersionFormat
      value: string
      description: >
        Deprecated. This field is unused.
        
      valid_values: ['VERSION_FORMAT_UNSPECIFIED', 'V2', 'V1']
    - name: includeChildren
      value: boolean
      description: >
        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: interceptChildren
      value: boolean
      description: >
        Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'.
        
    - name: bigqueryOptions
      value: object
      description: >
        Optional. Options that affect sinks exporting data to BigQuery.
        
    - name: uniqueWriterIdentity
      value: boolean
    - name: customWriterIdentity
      value: string

`UPDATE` examples

projects_sinks_patch
organizations_sinks_patch
folders_sinks_patch
billing_accounts_sinks_patch

Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field.

UPDATE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

UPDATE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

UPDATE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

UPDATE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
billingAccountsId = '{{ billingAccountsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

`REPLACE` examples

projects_sinks_update
organizations_sinks_update
folders_sinks_update
billing_accounts_sinks_update
sinks_update

REPLACE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

REPLACE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

REPLACE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

REPLACE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
billingAccountsId = '{{ billingAccountsId }}' --required
AND sinksId = '{{ sinksId }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;

REPLACE google.logging.sinks
SET 
data__name = '{{ name }}',
data__destination = '{{ destination }}',
data__filter = '{{ filter }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__exclusions = '{{ exclusions }}',
data__outputVersionFormat = '{{ outputVersionFormat }}',
data__includeChildren = {{ includeChildren }},
data__interceptChildren = {{ interceptChildren }},
data__bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
sinkName = '{{ sinkName }}' --required
AND uniqueWriterIdentity = {{ uniqueWriterIdentity}}
AND customWriterIdentity = '{{ customWriterIdentity}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bigqueryOptions,
createTime,
description,
destination,
disabled,
exclusions,
filter,
includeChildren,
interceptChildren,
outputVersionFormat,
resourceName,
updateTime,
writerIdentity;