templates

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

Overview

Name	templates
Type	Resource
Id	google.parametermanager.templates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the Template in the format projects/*/locations/*/templates/*.
createTime	string (google-datetime)	Output only. Create time stamp
format	string	Optional. Specifies the format of a Template. (TEMPLATE_FORMAT_UNSPECIFIED, TEMPLATE_FORMAT_YAML, TEMPLATE_FORMAT_JSON)
labels	object	Optional. Labels as key value pairs
updateTime	string (google-datetime)	Output only. Update time stamp

list

Name	Datatype	Description
name	string	Identifier. The resource name of the Template in the format projects/*/locations/*/templates/*.
createTime	string (google-datetime)	Output only. Create time stamp
format	string	Optional. Specifies the format of a Template. (TEMPLATE_FORMAT_UNSPECIFIED, TEMPLATE_FORMAT_YAML, TEMPLATE_FORMAT_JSON)
labels	object	Optional. Labels as key value pairs
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, templatesId		Gets details of a single Template.
list	select	projectsId, locationsId	filter, orderBy, pageSize, pageToken	Lists Templates in a given project and location.
create	insert	projectsId, locationsId	requestId, templateId	Creates a new Template in a given project and location.
patch	update	projectsId, locationsId, templatesId	requestId, updateMask	Updates a single Template.
delete	delete	projectsId, locationsId, templatesId	requestId	Deletes a single Template.

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
locationsId	string
projectsId	string
templatesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
templateId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Template.

SELECT
name,
createTime,
format,
labels,
updateTime
FROM google.parametermanager.templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND templatesId = '{{ templatesId }}' -- required
;

list

Lists Templates in a given project and location.

SELECT
name,
createTime,
format,
labels,
updateTime
FROM google.parametermanager.templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new Template in a given project and location.

INSERT INTO google.parametermanager.templates (
data__format,
data__labels,
data__name,
projectsId,
locationsId,
requestId,
templateId
)
SELECT 
'{{ format }}',
'{{ labels }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ templateId }}'
RETURNING
name,
createTime,
format,
labels,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: templates
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the templates resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the templates resource.
  - name: format
    value: "{{ format }}"
    description: |
      Optional. Specifies the format of a Template.
    valid_values: ['TEMPLATE_FORMAT_UNSPECIFIED', 'TEMPLATE_FORMAT_YAML', 'TEMPLATE_FORMAT_JSON']
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels as key value pairs
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
  - name: requestId
    value: "{{ requestId }}"
  - name: templateId
    value: "{{ templateId }}"

UPDATE examples

patch

Updates a single Template.

UPDATE google.parametermanager.templates
SET 
data__format = '{{ format }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND templatesId = '{{ templatesId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
format,
labels,
updateTime;

DELETE examples

delete

Deletes a single Template.

DELETE FROM google.parametermanager.templates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND templatesId = '{{ templatesId }}' --required
AND requestId = '{{ requestId }}'
;