release_configs

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

Overview

Name	release_configs
Type	Resource
Id	google.dataform.release_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The release config's name.
codeCompilationConfig	object	Optional. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json. (id: CodeCompilationConfig)
cronSchedule	string	Optional. Optional schedule (in cron format) for automatic creation of compilation results.
disabled	boolean	Optional. Disables automatic creation of compilation results.
gitCommitish	string	Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: 12ade345 - a tag: tag1 - a branch name: branch1
internalMetadata	string	Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
recentScheduledReleaseRecords	array	Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of release_time. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
releaseCompilationResult	string	Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
timeZone	string	Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

list

Name	Datatype	Description
name	string	Identifier. The release config's name.
codeCompilationConfig	object	Optional. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json. (id: CodeCompilationConfig)
cronSchedule	string	Optional. Optional schedule (in cron format) for automatic creation of compilation results.
disabled	boolean	Optional. Disables automatic creation of compilation results.
gitCommitish	string	Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: 12ade345 - a tag: tag1 - a branch name: branch1
internalMetadata	string	Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
recentScheduledReleaseRecords	array	Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of release_time. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
releaseCompilationResult	string	Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
timeZone	string	Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, repositoriesId, releaseConfigsId		Fetches a single ReleaseConfig.
list	select	projectsId, locationsId, repositoriesId	pageSize, pageToken	Lists ReleaseConfigs in a given Repository.
create	insert	projectsId, locationsId, repositoriesId	releaseConfigId	Creates a new ReleaseConfig in a given Repository.
patch	update	projectsId, locationsId, repositoriesId, releaseConfigsId	updateMask	Updates a single ReleaseConfig. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.
delete	delete	projectsId, locationsId, repositoriesId, releaseConfigsId		Deletes a single ReleaseConfig.

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
releaseConfigsId	string
repositoriesId	string
pageSize	integer (int32)
pageToken	string
releaseConfigId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Fetches a single ReleaseConfig.

SELECT
name,
codeCompilationConfig,
cronSchedule,
disabled,
gitCommitish,
internalMetadata,
recentScheduledReleaseRecords,
releaseCompilationResult,
timeZone
FROM google.dataform.release_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND releaseConfigsId = '{{ releaseConfigsId }}' -- required
;

list

Lists ReleaseConfigs in a given Repository.

SELECT
name,
codeCompilationConfig,
cronSchedule,
disabled,
gitCommitish,
internalMetadata,
recentScheduledReleaseRecords,
releaseCompilationResult,
timeZone
FROM google.dataform.release_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new ReleaseConfig in a given Repository.

INSERT INTO google.dataform.release_configs (
data__name,
data__releaseCompilationResult,
data__gitCommitish,
data__cronSchedule,
data__disabled,
data__codeCompilationConfig,
data__timeZone,
projectsId,
locationsId,
repositoriesId,
releaseConfigId
)
SELECT 
'{{ name }}',
'{{ releaseCompilationResult }}',
'{{ gitCommitish }}',
'{{ cronSchedule }}',
{{ disabled }},
'{{ codeCompilationConfig }}',
'{{ timeZone }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ repositoriesId }}',
'{{ releaseConfigId }}'
RETURNING
name,
codeCompilationConfig,
cronSchedule,
disabled,
gitCommitish,
internalMetadata,
recentScheduledReleaseRecords,
releaseCompilationResult,
timeZone
;

Manifest

# Description fields are for documentation purposes
- name: release_configs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the release_configs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the release_configs resource.
  - name: repositoriesId
    value: "{{ repositoriesId }}"
    description: Required parameter for the release_configs resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The release config's name.
  - name: releaseCompilationResult
    value: "{{ releaseCompilationResult }}"
    description: |
      Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
  - name: gitCommitish
    value: "{{ gitCommitish }}"
    description: |
      Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
  - name: cronSchedule
    value: "{{ cronSchedule }}"
    description: |
      Optional. Optional schedule (in cron format) for automatic creation of compilation results.
  - name: disabled
    value: {{ disabled }}
    description: |
      Optional. Disables automatic creation of compilation results.
  - name: codeCompilationConfig
    description: |
      Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
    value:
      assertionSchema: "{{ assertionSchema }}"
      defaultLocation: "{{ defaultLocation }}"
      defaultDatabase: "{{ defaultDatabase }}"
      vars: "{{ vars }}"
      defaultNotebookRuntimeOptions:
        aiPlatformNotebookRuntimeTemplate: "{{ aiPlatformNotebookRuntimeTemplate }}"
        gcsOutputBucket: "{{ gcsOutputBucket }}"
      schemaSuffix: "{{ schemaSuffix }}"
      tablePrefix: "{{ tablePrefix }}"
      databaseSuffix: "{{ databaseSuffix }}"
      defaultSchema: "{{ defaultSchema }}"
      builtinAssertionNamePrefix: "{{ builtinAssertionNamePrefix }}"
  - name: timeZone
    value: "{{ timeZone }}"
    description: |
      Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
  - name: releaseConfigId
    value: "{{ releaseConfigId }}"

UPDATE examples

patch

Updates a single ReleaseConfig. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

UPDATE google.dataform.release_configs
SET 
data__name = '{{ name }}',
data__releaseCompilationResult = '{{ releaseCompilationResult }}',
data__gitCommitish = '{{ gitCommitish }}',
data__cronSchedule = '{{ cronSchedule }}',
data__disabled = {{ disabled }},
data__codeCompilationConfig = '{{ codeCompilationConfig }}',
data__timeZone = '{{ timeZone }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND releaseConfigsId = '{{ releaseConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
codeCompilationConfig,
cronSchedule,
disabled,
gitCommitish,
internalMetadata,
recentScheduledReleaseRecords,
releaseCompilationResult,
timeZone;

DELETE examples

delete

Deletes a single ReleaseConfig.

DELETE FROM google.dataform.release_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND releaseConfigsId = '{{ releaseConfigsId }}' --required
;