Interface WorkflowConfigOrBuilder (0.40.0)

public interface WorkflowConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCronSchedule()

public abstract String getCronSchedule()

Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

string cron_schedule = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cronSchedule.

getCronScheduleBytes()

public abstract ByteString getCronScheduleBytes()

Optional. Optional schedule (in cron format) for automatic execution of this workflow config.

string cron_schedule = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cronSchedule.

getInvocationConfig()

public abstract InvocationConfig getInvocationConfig()

Optional. If left unset, a default InvocationConfig will be used.

.google.cloud.dataform.v1beta1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InvocationConfig

The invocationConfig.

getInvocationConfigOrBuilder()

public abstract InvocationConfigOrBuilder getInvocationConfigOrBuilder()

Optional. If left unset, a default InvocationConfig will be used.

.google.cloud.dataform.v1beta1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InvocationConfigOrBuilder

getName()

public abstract String getName()

Output only. The workflow config's name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The workflow config's name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getRecentScheduledExecutionRecords(int index)

public abstract WorkflowConfig.ScheduledExecutionRecord getRecentScheduledExecutionRecords(int index)

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

repeated .google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
WorkflowConfig.ScheduledExecutionRecord

getRecentScheduledExecutionRecordsCount()

public abstract int getRecentScheduledExecutionRecordsCount()

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

repeated .google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getRecentScheduledExecutionRecordsList()

public abstract List<WorkflowConfig.ScheduledExecutionRecord> getRecentScheduledExecutionRecordsList()

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

repeated .google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ScheduledExecutionRecord>

getRecentScheduledExecutionRecordsOrBuilder(int index)

public abstract WorkflowConfig.ScheduledExecutionRecordOrBuilder getRecentScheduledExecutionRecordsOrBuilder(int index)

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

repeated .google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
WorkflowConfig.ScheduledExecutionRecordOrBuilder

getRecentScheduledExecutionRecordsOrBuilderList()

public abstract List<? extends WorkflowConfig.ScheduledExecutionRecordOrBuilder> getRecentScheduledExecutionRecordsOrBuilderList()

Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.

repeated .google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.dataform.v1beta1.WorkflowConfig.ScheduledExecutionRecordOrBuilder>

getReleaseConfig()

public abstract String getReleaseConfig()

Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

string release_config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The releaseConfig.

getReleaseConfigBytes()

public abstract ByteString getReleaseConfigBytes()

Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.

string release_config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for releaseConfig.

getTimeZone()

public abstract String 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.

string time_zone = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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.

string time_zone = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for timeZone.

hasInvocationConfig()

public abstract boolean hasInvocationConfig()

Optional. If left unset, a default InvocationConfig will be used.

.google.cloud.dataform.v1beta1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the invocationConfig field is set.