REST Resource: projects.locations.repositories.releaseConfigs

Resource: ReleaseConfig

Represents a Dataform release configuration.

JSON representation
{
  "name": string,
  "gitCommitish": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "cronSchedule": string,
  "timeZone": string,
  "recentScheduledReleaseRecords": [
    {
      object (ScheduledReleaseRecord)
    }
  ],
  "releaseCompilationResult": string
}
Fields
name

string

Output only. The release config's name.

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

codeCompilationConfig

object (CodeCompilationConfig)

Optional. If set, fields of codeCompilationConfig override the default compilation settings that are specified in dataform.json.

cronSchedule

string

Optional. Optional schedule (in cron format) for automatic creation of compilation results.

timeZone

string

Optional. Specifies the time zone to be used when interpreting cronSchedule. 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.

recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of releaseTime. Updated whenever automatic creation of a compilation result is triggered by cronSchedule.

releaseCompilationResult

string

Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, 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/*.

ScheduledReleaseRecord

A record of an attempt to create a compilation result for this release config.

JSON representation
{
  "releaseTime": string,

  // Union field result can be only one of the following:
  "compilationResult": string,
  "errorStatus": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Fields
releaseTime

string (Timestamp format)

The timestamp of this release attempt.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Union field result.

result can be only one of the following:

compilationResult

string

The name of the created compilation result, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.

errorStatus

object (Status)

The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.

Methods

create

Creates a new ReleaseConfig in a given Repository.

delete

Deletes a single ReleaseConfig.

get

Fetches a single ReleaseConfig.

list

Lists ReleaseConfigs in a given Repository.

patch

Updates a single ReleaseConfig.