Class WorkflowConfig (0.42.0)

public final class WorkflowConfig extends GeneratedMessageV3 implements WorkflowConfigOrBuilder

Represents a Dataform workflow configuration.

Protobuf type google.cloud.dataform.v1beta1.WorkflowConfig

Static Fields

CRON_SCHEDULE_FIELD_NUMBER

public static final int CRON_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

INVOCATION_CONFIG_FIELD_NUMBER

public static final int INVOCATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RECENT_SCHEDULED_EXECUTION_RECORDS_FIELD_NUMBER

public static final int RECENT_SCHEDULED_EXECUTION_RECORDS_FIELD_NUMBER
Field Value
Type Description
int

RELEASE_CONFIG_FIELD_NUMBER

public static final int RELEASE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkflowConfig getDefaultInstance()
Returns
Type Description
WorkflowConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WorkflowConfig.Builder newBuilder()
Returns
Type Description
WorkflowConfig.Builder

newBuilder(WorkflowConfig prototype)

public static WorkflowConfig.Builder newBuilder(WorkflowConfig prototype)
Parameter
Name Description
prototype WorkflowConfig
Returns
Type Description
WorkflowConfig.Builder

parseDelimitedFrom(InputStream input)

public static WorkflowConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WorkflowConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkflowConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkflowConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WorkflowConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WorkflowConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkflowConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkflowConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WorkflowConfig> parser()
Returns
Type Description
Parser<WorkflowConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCronSchedule()

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

getDefaultInstanceForType()

public WorkflowConfig getDefaultInstanceForType()
Returns
Type Description
WorkflowConfig

getInvocationConfig()

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

getParserForType()

public Parser<WorkflowConfig> getParserForType()
Returns
Type Description
Parser<WorkflowConfig>
Overrides

getRecentScheduledExecutionRecords(int index)

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeZone()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WorkflowConfig.Builder newBuilderForType()
Returns
Type Description
WorkflowConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkflowConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WorkflowConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WorkflowConfig.Builder toBuilder()
Returns
Type Description
WorkflowConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException