io.temporal.api.schedule.v1.ScheduleInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of temporal-serviceclient Show documentation
Temporal Workflow Java SDK
There is a newer version: 1.27.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: temporal/api/schedule/v1/message.proto

package io.temporal.api.schedule.v1;

@javax.annotation.Generated(value="protoc", comments="annotations:ScheduleInfoOrBuilder.java.pb.meta")
public interface ScheduleInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:temporal.api.schedule.v1.ScheduleInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Number of actions taken so far.
   * 
   *
   * int64 action_count = 1;
   * @return The actionCount.
   */
  long getActionCount();

  /**
   *    * Number of times a scheduled action was skipped due to missing the catchup window.
   * 
   *
   * int64 missed_catchup_window = 2;
   * @return The missedCatchupWindow.
   */
  long getMissedCatchupWindow();

  /**
   *    * Number of skipped actions due to overlap.
   * 
   *
   * int64 overlap_skipped = 3;
   * @return The overlapSkipped.
   */
  long getOverlapSkipped();

  /**
   *    * Currently-running workflows started by this schedule. (There might be
   * more than one if the overlap policy allows overlaps.)
   * Note that the run_ids in here are the original execution run ids as
   * started by the schedule. If the workflows retried, did continue-as-new,
   * or were reset, they might still be running but with a different run_id.
   * 
   *
   * repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;
   */
  java.util.List 
      getRunningWorkflowsList();
  /**
   *    * Currently-running workflows started by this schedule. (There might be
   * more than one if the overlap policy allows overlaps.)
   * Note that the run_ids in here are the original execution run ids as
   * started by the schedule. If the workflows retried, did continue-as-new,
   * or were reset, they might still be running but with a different run_id.
   * 
   *
   * repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;
   */
  io.temporal.api.common.v1.WorkflowExecution getRunningWorkflows(int index);
  /**
   *    * Currently-running workflows started by this schedule. (There might be
   * more than one if the overlap policy allows overlaps.)
   * Note that the run_ids in here are the original execution run ids as
   * started by the schedule. If the workflows retried, did continue-as-new,
   * or were reset, they might still be running but with a different run_id.
   * 
   *
   * repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;
   */
  int getRunningWorkflowsCount();
  /**
   *    * Currently-running workflows started by this schedule. (There might be
   * more than one if the overlap policy allows overlaps.)
   * Note that the run_ids in here are the original execution run ids as
   * started by the schedule. If the workflows retried, did continue-as-new,
   * or were reset, they might still be running but with a different run_id.
   * 
   *
   * repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;
   */
  java.util.List 
      getRunningWorkflowsOrBuilderList();
  /**
   *    * Currently-running workflows started by this schedule. (There might be
   * more than one if the overlap policy allows overlaps.)
   * Note that the run_ids in here are the original execution run ids as
   * started by the schedule. If the workflows retried, did continue-as-new,
   * or were reset, they might still be running but with a different run_id.
   * 
   *
   * repeated .temporal.api.common.v1.WorkflowExecution running_workflows = 9;
   */
  io.temporal.api.common.v1.WorkflowExecutionOrBuilder getRunningWorkflowsOrBuilder(
      int index);

  /**
   *    * Most recent ten actual action times (including manual triggers).
   * 
   *
   * repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
   */
  java.util.List 
      getRecentActionsList();
  /**
   *    * Most recent ten actual action times (including manual triggers).
   * 
   *
   * repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
   */
  io.temporal.api.schedule.v1.ScheduleActionResult getRecentActions(int index);
  /**
   *    * Most recent ten actual action times (including manual triggers).
   * 
   *
   * repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
   */
  int getRecentActionsCount();
  /**
   *    * Most recent ten actual action times (including manual triggers).
   * 
   *
   * repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
   */
  java.util.List 
      getRecentActionsOrBuilderList();
  /**
   *    * Most recent ten actual action times (including manual triggers).
   * 
   *
   * repeated .temporal.api.schedule.v1.ScheduleActionResult recent_actions = 4;
   */
  io.temporal.api.schedule.v1.ScheduleActionResultOrBuilder getRecentActionsOrBuilder(
      int index);

  /**
   *    * Next ten scheduled action times.
   * 
   *
   * repeated .google.protobuf.Timestamp future_action_times = 5 [(.gogoproto.stdtime) = true];
   */
  java.util.List 
      getFutureActionTimesList();
  /**
   *    * Next ten scheduled action times.
   * 
   *
   * repeated .google.protobuf.Timestamp future_action_times = 5 [(.gogoproto.stdtime) = true];
   */
  com.google.protobuf.Timestamp getFutureActionTimes(int index);
  /**
   *    * Next ten scheduled action times.
   * 
   *
   * repeated .google.protobuf.Timestamp future_action_times = 5 [(.gogoproto.stdtime) = true];
   */
  int getFutureActionTimesCount();
  /**
   *    * Next ten scheduled action times.
   * 
   *
   * repeated .google.protobuf.Timestamp future_action_times = 5 [(.gogoproto.stdtime) = true];
   */
  java.util.List 
      getFutureActionTimesOrBuilderList();
  /**
   *    * Next ten scheduled action times.
   * 
   *
   * repeated .google.protobuf.Timestamp future_action_times = 5 [(.gogoproto.stdtime) = true];
   */
  com.google.protobuf.TimestampOrBuilder getFutureActionTimesOrBuilder(
      int index);

  /**
   *    * Timestamps of schedule creation and last update.
   * 
   *
   * .google.protobuf.Timestamp create_time = 6 [(.gogoproto.stdtime) = true];
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *    * Timestamps of schedule creation and last update.
   * 
   *
   * .google.protobuf.Timestamp create_time = 6 [(.gogoproto.stdtime) = true];
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *    * Timestamps of schedule creation and last update.
   * 
   *
   * .google.protobuf.Timestamp create_time = 6 [(.gogoproto.stdtime) = true];
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   * .google.protobuf.Timestamp update_time = 7 [(.gogoproto.stdtime) = true];
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   * .google.protobuf.Timestamp update_time = 7 [(.gogoproto.stdtime) = true];
   * @return The updateTime.
   */
  com.google.protobuf.Timestamp getUpdateTime();
  /**
   * .google.protobuf.Timestamp update_time = 7 [(.gogoproto.stdtime) = true];
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   * string invalid_schedule_error = 8 [deprecated = true];
   * @return The invalidScheduleError.
   */
  @java.lang.Deprecated java.lang.String getInvalidScheduleError();
  /**
   * string invalid_schedule_error = 8 [deprecated = true];
   * @return The bytes for invalidScheduleError.
   */
  @java.lang.Deprecated com.google.protobuf.ByteString
      getInvalidScheduleErrorBytes();
}