sinks

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

Overview

Name	sinks
Type	Resource
Id	google.logging.sinks

Fields

Name	Datatype	Description
name	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.
description	string	Optional. A description of this sink.The maximum length of the description is 8000 characters.
bigqueryOptions	object	Options that change functionality of a sink exporting data to BigQuery.
createTime	string	Output only. The creation timestamp of the sink.This field may not be present for older sinks.
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 exclusion_filters 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	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

Name	Accessible by	Required Params	Description
billing_accounts_sinks_get	SELECT	billingAccountsId, sinksId	Gets a sink.
billing_accounts_sinks_list	SELECT	billingAccountsId	Lists sinks.
folders_sinks_get	SELECT	foldersId, sinksId	Gets a sink.
folders_sinks_list	SELECT	foldersId	Lists sinks.
organizations_sinks_get	SELECT	organizationsId, sinksId	Gets a sink.
organizations_sinks_list	SELECT	organizationsId	Lists sinks.
projects_sinks_get	SELECT	projectsId, sinksId	Gets a sink.
projects_sinks_list	SELECT	projectsId	Lists sinks.
sinks_get	SELECT	sinkName	Gets a sink.
sinks_list	SELECT	parent, parentType	Lists sinks.
billing_accounts_sinks_create	INSERT	billingAccountsId	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	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	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	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.
sinks_create	INSERT	parent, parentType	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_delete	DELETE	billingAccountsId, 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.
organizations_sinks_delete	DELETE	organizationsId, sinksId	Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.
projects_sinks_delete	DELETE	projectsId, 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.
billing_accounts_sinks_patch	UPDATE	billingAccountsId, sinksId	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	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	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_patch	UPDATE	projectsId, sinksId	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	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	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	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	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	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.

SELECT examples

Gets a sink.

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

INSERT example

Use the following StackQL query and manifest file to create a new sinks resource.

All Properties

/*+ create */
INSERT INTO google.logging.sinks (
foldersId,
destination,
filter,
description,
disabled,
exclusions,
outputVersionFormat,
includeChildren,
interceptChildren,
bigqueryOptions
)
SELECT 
'{{ foldersId }}',
'{{ destination }}',
'{{ filter }}',
'{{ description }}',
{{ disabled }},
'{{ exclusions }}',
'{{ outputVersionFormat }}',
{{ includeChildren }},
{{ interceptChildren }},
'{{ bigqueryOptions }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: resourceName
      value: string
    - name: destination
      value: string
    - name: filter
      value: string
    - name: description
      value: string
    - name: disabled
      value: boolean
    - name: exclusions
      value:
        - - name: name
            value: string
          - name: description
            value: string
          - name: filter
            value: string
          - name: disabled
            value: boolean
          - name: createTime
            value: string
          - name: updateTime
            value: string
    - name: outputVersionFormat
      value: string
    - name: writerIdentity
      value: string
    - name: includeChildren
      value: boolean
    - name: interceptChildren
      value: boolean
    - name: bigqueryOptions
      value:
        - name: usePartitionedTables
          value: boolean
        - name: usesTimestampColumnPartitioning
          value: boolean
    - name: createTime
      value: string
    - name: updateTime
      value: string

UPDATE example

Updates a sinks resource.

/*+ update */
UPDATE google.logging.sinks
SET 
destination = '{{ destination }}',
filter = '{{ filter }}',
description = '{{ description }}',
disabled = true|false,
exclusions = '{{ exclusions }}',
outputVersionFormat = '{{ outputVersionFormat }}',
includeChildren = true|false,
interceptChildren = true|false,
bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
foldersId = '{{ foldersId }}'
AND sinksId = '{{ sinksId }}';

REPLACE example

Replaces all fields in the specified sinks resource.

/*+ update */
REPLACE google.logging.sinks
SET 
destination = '{{ destination }}',
filter = '{{ filter }}',
description = '{{ description }}',
disabled = true|false,
exclusions = '{{ exclusions }}',
outputVersionFormat = '{{ outputVersionFormat }}',
includeChildren = true|false,
interceptChildren = true|false,
bigqueryOptions = '{{ bigqueryOptions }}'
WHERE 
sinkName = '{{ sinkName }}';

DELETE example

Deletes the specified sinks resource.

/*+ delete */
DELETE FROM google.logging.sinks
WHERE sinkName = '{{ sinkName }}';