Google Cloud Dataform V1beta1 Client - Class ReleaseConfig (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.5.1
• 0.4.7
• 0.3.0
• 0.2.3
• 0.1.6

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class ReleaseConfig.

Represents a Dataform release configuration.

Generated from protobuf message google.cloud.dataform.v1beta1.ReleaseConfig

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The release config's name.
↳ git_commitish	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
↳ code_compilation_config	CodeCompilationConfig Optional. If set, fields of code_compilation_config override the default compilation settings that are specified in dataform.json.
↳ cron_schedule	string Optional. Optional schedule (in cron format) for automatic creation of compilation results.
↳ time_zone	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.
↳ recent_scheduled_release_records	array<ReleaseConfig\ScheduledReleaseRecord> 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.
↳ release_compilation_result	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/*.
↳ disabled	bool Optional. Disables automatic creation of compilation results.
↳ internal_metadata	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.

getName

Identifier. The release config's name.

Returns
Type	Description
string

setName

Identifier. The release config's name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGitCommitish

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

Returns
Type	Description
string

setGitCommitish

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCodeCompilationConfig

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

Returns
Type	Description
CodeCompilationConfig|null

hasCodeCompilationConfig

clearCodeCompilationConfig

setCodeCompilationConfig

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

Parameter
Name	Description
var	CodeCompilationConfig

Returns
Type	Description
$this

getCronSchedule

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

Returns
Type	Description
string

setCronSchedule

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTimeZone

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.

Returns
Type	Description
string

setTimeZone

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRecentScheduledReleaseRecords

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRecentScheduledReleaseRecords

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.

Parameter
Name	Description
var	array<ReleaseConfig\ScheduledReleaseRecord>

Returns
Type	Description
$this

getReleaseCompilationResult

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/*.

Returns
Type	Description
string

setReleaseCompilationResult

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/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisabled

Optional. Disables automatic creation of compilation results.

Returns
Type	Description
bool

setDisabled

Optional. Disables automatic creation of compilation results.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInternalMetadata

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.

Returns
Type	Description
string

hasInternalMetadata

clearInternalMetadata

setInternalMetadata

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this