Package com.google.cloud.dataform.v1

Class WorkflowConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataform.v1.WorkflowConfig
All Implemented Interfaces:
WorkflowConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class WorkflowConfig extends com.google.protobuf.GeneratedMessage implements WorkflowConfigOrBuilder
 Represents a Dataform workflow configuration.
Protobuf type google.cloud.dataform.v1.WorkflowConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • RELEASE_CONFIG_FIELD_NUMBER

      public static final int RELEASE_CONFIG_FIELD_NUMBER
      See Also:

    • INVOCATION_CONFIG_FIELD_NUMBER

      public static final int INVOCATION_CONFIG_FIELD_NUMBER
      See Also:

    • CRON_SCHEDULE_FIELD_NUMBER

      public static final int CRON_SCHEDULE_FIELD_NUMBER
      See Also:

    • TIME_ZONE_FIELD_NUMBER

      public static final int TIME_ZONE_FIELD_NUMBER
      See Also:

    • RECENT_SCHEDULED_EXECUTION_RECORDS_FIELD_NUMBER

      public static final int RECENT_SCHEDULED_EXECUTION_RECORDS_FIELD_NUMBER
      See Also:

    • DISABLED_FIELD_NUMBER

      public static final int DISABLED_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • INTERNAL_METADATA_FIELD_NUMBER

      public static final int INTERNAL_METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Identifier. The workflow config's name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface WorkflowConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The workflow config's name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface WorkflowConfigOrBuilder
      Returns:
      The bytes for name.

    • 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) = { ... }
      Specified by:
      getReleaseConfig in interface WorkflowConfigOrBuilder
      Returns:
      The releaseConfig.

    • getReleaseConfigBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getReleaseConfigBytes in interface WorkflowConfigOrBuilder
      Returns:
      The bytes for releaseConfig.

    • hasInvocationConfig

      public boolean hasInvocationConfig()
       Optional. If left unset, a default InvocationConfig will be used.
      .google.cloud.dataform.v1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInvocationConfig in interface WorkflowConfigOrBuilder
      Returns:
      Whether the invocationConfig field is set.

    • getInvocationConfig

      public InvocationConfig getInvocationConfig()
       Optional. If left unset, a default InvocationConfig will be used.
      .google.cloud.dataform.v1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInvocationConfig in interface WorkflowConfigOrBuilder
      Returns:
      The invocationConfig.

    • getInvocationConfigOrBuilder

      public InvocationConfigOrBuilder getInvocationConfigOrBuilder()
       Optional. If left unset, a default InvocationConfig will be used.
      .google.cloud.dataform.v1.InvocationConfig invocation_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInvocationConfigOrBuilder in interface WorkflowConfigOrBuilder

    • 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];
      Specified by:
      getCronSchedule in interface WorkflowConfigOrBuilder
      Returns:
      The cronSchedule.

    • getCronScheduleBytes

      public com.google.protobuf.ByteString getCronScheduleBytes()
       Optional. Optional schedule (in cron format) for automatic execution of
 this workflow config.
      string cron_schedule = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCronScheduleBytes in interface WorkflowConfigOrBuilder
      Returns:
      The bytes for cronSchedule.

    • 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];
      Specified by:
      getTimeZone in interface WorkflowConfigOrBuilder
      Returns:
      The timeZone.

    • getTimeZoneBytes

      public com.google.protobuf.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];
      Specified by:
      getTimeZoneBytes in interface WorkflowConfigOrBuilder
      Returns:
      The bytes for timeZone.

    • getRecentScheduledExecutionRecordsList

      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.v1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecentScheduledExecutionRecordsList in interface WorkflowConfigOrBuilder

    • getRecentScheduledExecutionRecordsOrBuilderList

      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.v1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecentScheduledExecutionRecordsOrBuilderList in interface WorkflowConfigOrBuilder

    • getRecentScheduledExecutionRecordsCount

      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.v1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecentScheduledExecutionRecordsCount in interface WorkflowConfigOrBuilder

    • getRecentScheduledExecutionRecords

      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.v1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecentScheduledExecutionRecords in interface WorkflowConfigOrBuilder

    • getRecentScheduledExecutionRecordsOrBuilder

      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.v1.WorkflowConfig.ScheduledExecutionRecord recent_scheduled_execution_records = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRecentScheduledExecutionRecordsOrBuilder in interface WorkflowConfigOrBuilder

    • getDisabled

      public boolean getDisabled()
       Optional. Disables automatic creation of workflow invocations.
      bool disabled = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisabled in interface WorkflowConfigOrBuilder
      Returns:
      The disabled.

    • hasCreateTime

      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];
      Specified by:
      hasCreateTime in interface WorkflowConfigOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp of when the WorkflowConfig was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface WorkflowConfigOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp of when the WorkflowConfig was created.
      .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface WorkflowConfigOrBuilder

    • hasUpdateTime

      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];
      Specified by:
      hasUpdateTime in interface WorkflowConfigOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.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];
      Specified by:
      getUpdateTime in interface WorkflowConfigOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getUpdateTimeOrBuilder in interface WorkflowConfigOrBuilder

    • hasInternalMetadata

      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];
      Specified by:
      hasInternalMetadata in interface WorkflowConfigOrBuilder
      Returns:
      Whether the internalMetadata field is set.

    • getInternalMetadata

      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];
      Specified by:
      getInternalMetadata in interface WorkflowConfigOrBuilder
      Returns:
      The internalMetadata.

    • getInternalMetadataBytes

      public com.google.protobuf.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];
      Specified by:
      getInternalMetadataBytes in interface WorkflowConfigOrBuilder
      Returns:
      The bytes for internalMetadata.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static WorkflowConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkflowConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkflowConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkflowConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkflowConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkflowConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkflowConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public WorkflowConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static WorkflowConfig.Builder newBuilder()

    • newBuilder

      public static WorkflowConfig.Builder newBuilder(WorkflowConfig prototype)

    • toBuilder

      public WorkflowConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected WorkflowConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static WorkflowConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<WorkflowConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<WorkflowConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public WorkflowConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder