job_templates

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

Overview

Name	job_templates
Type	Resource
Id	google.transcoder.job_templates

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The resource name of the job template. Format: projects/{project_number}/locations/{location}/jobTemplates/{job_template}
config	object	The configuration for this template. (id: JobConfig)
labels	object	The labels associated with this job template. You can use these to organize and group your job templates.

list

Successful response

Name	Datatype	Description
name	string	The resource name of the job template. Format: projects/{project_number}/locations/{location}/jobTemplates/{job_template}
config	object	The configuration for this template. (id: JobConfig)
labels	object	The labels associated with this job template. You can use these to organize and group your job templates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, jobTemplatesId		Returns the job template data.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists job templates in the specified region.
create	insert	projectsId, locationsId	jobTemplateId	Creates a job template in the specified region.
delete	delete	projectsId, locationsId, jobTemplatesId	allowMissing	Deletes a job 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
jobTemplatesId	string
locationsId	string
projectsId	string
allowMissing	boolean
filter	string
jobTemplateId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Returns the job template data.

SELECT
name,
config,
labels
FROM google.transcoder.job_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobTemplatesId = '{{ jobTemplatesId }}' -- required;

list

Lists job templates in the specified region.

SELECT
name,
config,
labels
FROM google.transcoder.job_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a job template in the specified region.

INSERT INTO google.transcoder.job_templates (
data__name,
data__config,
data__labels,
projectsId,
locationsId,
jobTemplateId
)
SELECT 
'{{ name }}',
'{{ config }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ jobTemplateId }}'
RETURNING
name,
config,
labels
;

Manifest

# Description fields are for documentation purposes
- name: job_templates
  props:
    - name: projectsId
      value: string
      description: Required parameter for the job_templates resource.
    - name: locationsId
      value: string
      description: Required parameter for the job_templates resource.
    - name: name
      value: string
      description: >
        The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`
        
    - name: config
      value: object
      description: >
        The configuration for this template.
        
    - name: labels
      value: object
      description: >
        The labels associated with this job template. You can use these to organize and group your job templates.
        
    - name: jobTemplateId
      value: string

DELETE examples

delete

Deletes a job template.

DELETE FROM google.transcoder.job_templates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND jobTemplatesId = '{{ jobTemplatesId }}' --required
AND allowMissing = '{{ allowMissing }}';