links

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

Overview

Name	links
Type	Resource
Id	google.observability.links

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
createTime	string (google-datetime)	Output only. Create timestamp.
description	string	Optional. Description of the link.
displayName	string	Optional. A user friendly display name.

list

Name	Datatype	Description
name	string	Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
createTime	string (google-datetime)	Output only. Create timestamp.
description	string	Optional. Description of the link.
displayName	string	Optional. A user friendly display name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, bucketsId, datasetsId, linksId		Get a link.
list	select	projectsId, locationsId, bucketsId, datasetsId	pageSize, pageToken	List links of a dataset.
create	insert	projectsId, locationsId, bucketsId, datasetsId	linkId	Create a new link.
patch	update	projectsId, locationsId, bucketsId, datasetsId, linksId	updateMask	Update a link.
delete	delete	projectsId, locationsId, bucketsId, datasetsId, linksId		Delete a link.

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
bucketsId	string
datasetsId	string
linksId	string
locationsId	string
projectsId	string
linkId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get a link.

SELECT
name,
createTime,
description,
displayName
FROM google.observability.links
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND linksId = '{{ linksId }}' -- required
;

list

List links of a dataset.

SELECT
name,
createTime,
description,
displayName
FROM google.observability.links
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bucketsId = '{{ bucketsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Create a new link.

INSERT INTO google.observability.links (
data__name,
data__displayName,
data__description,
projectsId,
locationsId,
bucketsId,
datasetsId,
linkId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ bucketsId }}',
'{{ datasetsId }}',
'{{ linkId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: links
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the links resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the links resource.
  - name: bucketsId
    value: "{{ bucketsId }}"
    description: Required parameter for the links resource.
  - name: datasetsId
    value: "{{ datasetsId }}"
    description: Required parameter for the links resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. A user friendly display name.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. Description of the link.
  - name: linkId
    value: "{{ linkId }}"

UPDATE examples

patch

Update a link.

UPDATE google.observability.links
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bucketsId = '{{ bucketsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND linksId = '{{ linksId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a link.

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