annotations

Creates, updates, deletes, gets or lists an annotations resource.

Overview

Name	annotations
Type	Resource
Id	google.rapidmigrationassessment.annotations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	name of resource.
createTime	string (google-datetime)	Output only. Create time stamp.
labels	object	Labels as key value pairs.
type	string	Type of an annotation.
updateTime	string (google-datetime)	Output only. Update time stamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, annotationsId		Gets details of a single Annotation.
create	insert	projectsId, locationsId	requestId	Creates an Annotation

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
annotationsId	string
locationsId	string
projectsId	string
requestId	string

SELECT examples

get

Gets details of a single Annotation.

SELECT
name,
createTime,
labels,
type,
updateTime
FROM google.rapidmigrationassessment.annotations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND annotationsId = '{{ annotationsId }}' -- required;

INSERT examples

create

Creates an Annotation

INSERT INTO google.rapidmigrationassessment.annotations (
data__name,
data__labels,
data__type,
projectsId,
locationsId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ type }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: annotations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the annotations resource.
    - name: locationsId
      value: string
      description: Required parameter for the annotations resource.
    - name: name
      value: string
      description: >
        name of resource.
        
    - name: labels
      value: object
      description: >
        Labels as key value pairs.
        
    - name: type
      value: string
      description: >
        Type of an annotation.
        
      valid_values: ['TYPE_UNSPECIFIED', 'TYPE_LEGACY_EXPORT_CONSENT', 'TYPE_QWIKLAB']
    - name: requestId
      value: string