Package com.google.cloud.dataform.v1

Interface WorkflowConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WorkflowConfig, WorkflowConfig.Builder
@Generated public interface WorkflowConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

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

    • getReleaseConfig

      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:
      The releaseConfig.

    • getReleaseConfigBytes

      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) = { ... }
      Returns:
      The bytes for releaseConfig.

    • hasInvocationConfig

      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];
      Returns:
      Whether the invocationConfig field is set.

    • getInvocationConfig

      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];
      Returns:
      The invocationConfig.

    • getInvocationConfigOrBuilder

      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];

    • getCronSchedule

      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:
      The cronSchedule.

    • getCronScheduleBytes

      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];
      Returns:
      The bytes for cronSchedule.

    • getTimeZone

      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:
      The timeZone.

    • getTimeZoneBytes

      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];
      Returns:
      The bytes for timeZone.

    • getRecentScheduledExecutionRecordsList

      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];

    • getRecentScheduledExecutionRecords

      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];

    • getRecentScheduledExecutionRecordsCount

      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];

    • getRecentScheduledExecutionRecordsOrBuilderList

      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];

    • getRecentScheduledExecutionRecordsOrBuilder

      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];

    • getDisabled

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

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasInternalMetadata

      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:
      Whether the internalMetadata field is set.

    • getInternalMetadata

      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:
      The internalMetadata.

    • getInternalMetadataBytes

      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];
      Returns:
      The bytes for internalMetadata.