public final class WorkflowConfig extends GeneratedMessageV3 implements WorkflowConfigOrBuilder
Represents a Dataform workflow configuration.
Protobuf type google.cloud.dataform.v1beta1.WorkflowConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CRON_SCHEDULE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISABLED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INTERNAL_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INVOCATION_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RECENT_SCHEDULED_EXECUTION_RECORDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RELEASE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TIME_ZONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static WorkflowConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static WorkflowConfig.Builder newBuilder()
public static WorkflowConfig.Builder newBuilder(WorkflowConfig prototype)
public static WorkflowConfig parseDelimitedFrom(InputStream input)
public static WorkflowConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static WorkflowConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkflowConfig parseFrom(ByteString data)
public static WorkflowConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkflowConfig parseFrom(CodedInputStream input)
public static WorkflowConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowConfig parseFrom(InputStream input)
public static WorkflowConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkflowConfig parseFrom(ByteBuffer data)
public static WorkflowConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<WorkflowConfig> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Timestamp getCreateTime()
Output only. The timestamp of when the WorkflowConfig was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp of when the WorkflowConfig was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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.
|
public WorkflowConfig getDefaultInstanceForType()
public boolean getDisabled()
Optional. Disables automatic creation of workflow invocations.
bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The disabled.
|
public String 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.
optional string internal_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The internalMetadata.
|
public ByteString getInternalMetadataBytes()
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.
optional string internal_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for internalMetadata.
|
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];
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];
Identifier. The workflow config's name.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The workflow config's name.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<WorkflowConfig> getParserForType()
Overrides
public WorkflowConfig.ScheduledExecutionRecord getRecentScheduledExecutionRecords(int index)
Output only. Records of the 10 most recent scheduled execution attempts,
ordered 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
|
public int getRecentScheduledExecutionRecordsCount()
Output only. Records of the 10 most recent scheduled execution attempts,
ordered 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 |
|
public List<WorkflowConfig.ScheduledExecutionRecord> getRecentScheduledExecutionRecordsList()
Output only. Records of the 10 most recent scheduled execution attempts,
ordered 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];
public WorkflowConfig.ScheduledExecutionRecordOrBuilder getRecentScheduledExecutionRecordsOrBuilder(int index)
Output only. Records of the 10 most recent scheduled execution attempts,
ordered 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
|
public List<? extends WorkflowConfig.ScheduledExecutionRecordOrBuilder> getRecentScheduledExecutionRecordsOrBuilderList()
Output only. Records of the 10 most recent scheduled execution attempts,
ordered 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> |
|
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.
|
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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public String getTimeZone()
| Returns |
| Type |
Description |
String |
The timeZone.
|
public ByteString getTimeZoneBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for timeZone.
|
public Timestamp getUpdateTime()
Output only. The timestamp of when the WorkflowConfig was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp of when the WorkflowConfig was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. The timestamp of when the WorkflowConfig was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasInternalMetadata()
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.
optional string internal_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the internalMetadata field is set.
|
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.
|
public boolean hasUpdateTime()
Output only. The timestamp of when the WorkflowConfig was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public WorkflowConfig.Builder newBuilderForType()
protected WorkflowConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public WorkflowConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
