links

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

Overview

Name	links
Type	Resource
Id	google.logging.links

Fields

The following fields are returned by SELECT queries:

projects_locations_buckets_links_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

organizations_locations_buckets_links_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

folders_locations_buckets_links_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

billing_accounts_locations_buckets_links_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

projects_locations_buckets_links_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

organizations_locations_buckets_links_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

folders_locations_buckets_links_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

billing_accounts_locations_buckets_links_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

locations_buckets_links_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
bigqueryDataset	object	Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. (id: BigQueryDataset)
createTime	string (google-datetime)	Output only. The creation timestamp of the link.
description	string	Optional. Describes this link.The maximum length of the description is 8000 characters.
lifecycleState	string	Output only. The resource lifecycle state.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_buckets_links_get	select	projectsId, locationsId, bucketsId, linksId		Gets a link.
organizations_locations_buckets_links_get	select	organizationsId, locationsId, bucketsId, linksId		Gets a link.
folders_locations_buckets_links_get	select	foldersId, locationsId, bucketsId, linksId		Gets a link.
billing_accounts_locations_buckets_links_get	select	billingAccountsId, locationsId, bucketsId, linksId		Gets a link.
projects_locations_buckets_links_list	select	projectsId, locationsId, bucketsId	pageToken, pageSize	Lists links.
organizations_locations_buckets_links_list	select	organizationsId, locationsId, bucketsId	pageToken, pageSize	Lists links.
folders_locations_buckets_links_list	select	foldersId, locationsId, bucketsId	pageToken, pageSize	Lists links.
billing_accounts_locations_buckets_links_list	select	billingAccountsId, locationsId, bucketsId	pageToken, pageSize	Lists links.
locations_buckets_links_list	select	parentType, parent	pageToken, pageSize	Lists links.
projects_locations_buckets_links_create	insert	projectsId, locationsId, bucketsId	linkId	Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
organizations_locations_buckets_links_create	insert	organizationsId, locationsId, bucketsId	linkId	Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
folders_locations_buckets_links_create	insert	foldersId, locationsId, bucketsId	linkId	Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
billing_accounts_locations_buckets_links_create	insert	billingAccountsId, locationsId, bucketsId	linkId	Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
locations_buckets_links_create	insert	parentType, parent	linkId	Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
projects_locations_buckets_links_delete	delete	projectsId, locationsId, bucketsId, linksId		Deletes a link. This will also delete the corresponding BigQuery linked dataset.
organizations_locations_buckets_links_delete	delete	organizationsId, locationsId, bucketsId, linksId		Deletes a link. This will also delete the corresponding BigQuery linked dataset.
folders_locations_buckets_links_delete	delete	foldersId, locationsId, bucketsId, linksId		Deletes a link. This will also delete the corresponding BigQuery linked dataset.
billing_accounts_locations_buckets_links_delete	delete	billingAccountsId, locationsId, bucketsId, linksId		Deletes a link. This will also delete the corresponding BigQuery linked dataset.

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
bucketsId	string
foldersId	string
linksId	string
locationsId	string
organizationsId	string
parent	string
parentType	string
projectsId	string
linkId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_buckets_links_get

Gets a link.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND linksId = '{{ linksId }}' -- required;

organizations_locations_buckets_links_get

Gets a link.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND linksId = '{{ linksId }}' -- required;

folders_locations_buckets_links_get

Gets a link.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND linksId = '{{ linksId }}' -- required;

billing_accounts_locations_buckets_links_get

Gets a link.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE billingAccountsId = '{{ billingAccountsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND linksId = '{{ linksId }}' -- required;

projects_locations_buckets_links_list

Lists links.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_locations_buckets_links_list

Lists links.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

folders_locations_buckets_links_list

Lists links.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

billing_accounts_locations_buckets_links_list

Lists links.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE billingAccountsId = '{{ billingAccountsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

locations_buckets_links_list

Lists links.

SELECT
name,
bigqueryDataset,
createTime,
description,
lifecycleState
FROM google.logging.links
WHERE parentType = '{{ parentType }}' -- required
AND parent = '{{ parent }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

projects_locations_buckets_links_create

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

INSERT INTO google.logging.links (
data__description,
data__bigqueryDataset,
projectsId,
locationsId,
bucketsId,
linkId
)
SELECT 
'{{ description }}',
'{{ bigqueryDataset }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ bucketsId }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

organizations_locations_buckets_links_create

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

INSERT INTO google.logging.links (
data__description,
data__bigqueryDataset,
organizationsId,
locationsId,
bucketsId,
linkId
)
SELECT 
'{{ description }}',
'{{ bigqueryDataset }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ bucketsId }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

folders_locations_buckets_links_create

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

INSERT INTO google.logging.links (
data__description,
data__bigqueryDataset,
foldersId,
locationsId,
bucketsId,
linkId
)
SELECT 
'{{ description }}',
'{{ bigqueryDataset }}',
'{{ foldersId }}',
'{{ locationsId }}',
'{{ bucketsId }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

billing_accounts_locations_buckets_links_create

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

INSERT INTO google.logging.links (
data__description,
data__bigqueryDataset,
billingAccountsId,
locationsId,
bucketsId,
linkId
)
SELECT 
'{{ description }}',
'{{ bigqueryDataset }}',
'{{ billingAccountsId }}',
'{{ locationsId }}',
'{{ bucketsId }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

locations_buckets_links_create

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

INSERT INTO google.logging.links (
data__description,
data__bigqueryDataset,
parentType,
parent,
linkId
)
SELECT 
'{{ description }}',
'{{ bigqueryDataset }}',
'{{ parentType }}',
'{{ parent }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: links
  props:
    - name: projectsId
      value: string
      description: Required parameter for the links resource.
    - name: locationsId
      value: string
      description: Required parameter for the links resource.
    - name: bucketsId
      value: string
      description: Required parameter for the links resource.
    - name: organizationsId
      value: string
      description: Required parameter for the links resource.
    - name: foldersId
      value: string
      description: Required parameter for the links resource.
    - name: billingAccountsId
      value: string
      description: Required parameter for the links resource.
    - name: parentType
      value: string
      description: Required parameter for the links resource.
    - name: parent
      value: string
      description: Required parameter for the links resource.
    - name: description
      value: string
      description: >
        Optional. Describes this link.The maximum length of the description is 8000 characters.
        
    - name: bigqueryDataset
      value: object
      description: >
        Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket.
        
    - name: linkId
      value: string

DELETE examples

projects_locations_buckets_links_delete

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

DELETE FROM google.logging.links
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bucketsId = '{{ bucketsId }}' --required
AND linksId = '{{ linksId }}' --required;

organizations_locations_buckets_links_delete

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

DELETE FROM google.logging.links
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bucketsId = '{{ bucketsId }}' --required
AND linksId = '{{ linksId }}' --required;

folders_locations_buckets_links_delete

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

DELETE FROM google.logging.links
WHERE foldersId = '{{ foldersId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bucketsId = '{{ bucketsId }}' --required
AND linksId = '{{ linksId }}' --required;

billing_accounts_locations_buckets_links_delete

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

DELETE FROM google.logging.links
WHERE billingAccountsId = '{{ billingAccountsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bucketsId = '{{ bucketsId }}' --required
AND linksId = '{{ linksId }}' --required;