Add schedules API (#1776)

Add schedules API

Author: Quinn-With-Two-Ns

temporal-sdk/src/main/java/io/temporal/client/ListScheduleListDescriptionIterator.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client;
+
+import com.google.protobuf.ByteString;
+import io.temporal.api.schedule.v1.ScheduleListEntry;
+import io.temporal.api.workflowservice.v1.ListSchedulesRequest;
+import io.temporal.api.workflowservice.v1.ListSchedulesResponse;
+import io.temporal.internal.client.external.GenericWorkflowClient;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/** Eager iterator for listing schedules. */
+public final class ListScheduleListDescriptionIterator
+    extends EagerPaginator<ListSchedulesResponse, ScheduleListEntry> {
+  private final @Nonnull String namespace;
+  private final @Nullable Integer pageSize;
+  private final @Nonnull GenericWorkflowClient genericClient;
+
+  public ListScheduleListDescriptionIterator(
+      @Nonnull String namespace,
+      @Nullable Integer pageSize,
+      @Nonnull GenericWorkflowClient genericClient) {
+    this.namespace = namespace;
+    this.pageSize = pageSize;
+    this.genericClient = genericClient;
+  }
+
+  @Override
+  CompletableFuture<ListSchedulesResponse> performRequest(@Nonnull ByteString nextPageToken) {
+    ListSchedulesRequest.Builder request =
+        ListSchedulesRequest.newBuilder().setNamespace(namespace).setNextPageToken(nextPageToken);
+
+    if (pageSize != null) {
+      request.setMaximumPageSize(pageSize);
+    }
+
+    return genericClient.listSchedulesAsync(request.build());
+  }
+
+  @Override
+  ByteString getNextPageToken(ListSchedulesResponse response) {
+    return response.getNextPageToken();
+  }
+
+  @Override
+  List<ScheduleListEntry> toElements(ListSchedulesResponse response) {
+    return response.getSchedulesList();
+  }
+}

temporal-sdk/src/main/java/io/temporal/client/schedules/Schedule.java

@@ -0,0 +1,183 @@
+/*
+ * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client.schedules;
+
+import java.util.Objects;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/** A schedule for periodically running an action. */
+public final class Schedule {
+  public static Schedule.Builder newBuilder() {
+    return new Schedule.Builder();
+  }
+
+  public static Schedule.Builder newBuilder(Schedule options) {
+    return new Schedule.Builder(options);
+  }
+
+  public static final class Builder {
+    private ScheduleAction action;
+    private ScheduleSpec spec;
+    private SchedulePolicy policy;
+    private ScheduleState state;
+
+    private Builder() {}
+
+    private Builder(Schedule options) {
+      if (options == null) {
+        return;
+      }
+      action = options.action;
+      policy = options.policy;
+      state = options.state;
+      spec = options.spec;
+    }
+
+    /**
+     * Set the action for this schedule. Required to build.
+     *
+     * @see ScheduleAction
+     */
+    public Builder setAction(ScheduleAction action) {
+      this.action = action;
+      return this;
+    }
+
+    /**
+     * Set the spec for this schedule. Required to build.
+     *
+     * @see ScheduleSpec
+     */
+    public Builder setSpec(ScheduleSpec spec) {
+      this.spec = spec;
+      return this;
+    }
+
+    /**
+     * Set the spec for this schedule
+     *
+     * @see ScheduleSpec
+     */
+    public Builder setPolicy(SchedulePolicy policy) {
+      this.policy = policy;
+      return this;
+    }
+
+    /**
+     * Set the state for this schedule
+     *
+     * @see ScheduleState
+     */
+    public Builder setState(ScheduleState state) {
+      this.state = state;
+      return this;
+    }
+
+    public Schedule build() {
+      return new Schedule(
+          Objects.requireNonNull(action), Objects.requireNonNull(spec), policy, state);
+    }
+  }
+
+  private final ScheduleAction action;
+  private final SchedulePolicy policy;
+  private final ScheduleState state;
+  private final ScheduleSpec spec;
+
+  private Schedule(
+      ScheduleAction action, ScheduleSpec spec, SchedulePolicy policy, ScheduleState state) {
+    this.action = action;
+    this.spec = spec;
+    this.policy = policy;
+    this.state = state;
+  }
+
+  /**
+   * Gets the action for the schedule.
+   *
+   * @return action of the schedule
+   */
+  @Nonnull
+  public ScheduleAction getAction() {
+    return action;
+  }
+
+  /**
+   * Gets the spec for the schedule.
+   *
+   * @return spec of the schedule
+   */
+  @Nonnull
+  public ScheduleSpec getSpec() {
+    return spec;
+  }
+
+  /**
+   * Gets the policy for the schedule.
+   *
+   * @return policy of the schedule
+   */
+  @Nullable
+  public SchedulePolicy getPolicy() {
+    return policy;
+  }
+
+  /**
+   * Gets the state of the schedule.
+   *
+   * @return state of the schedule
+   */
+  @Nullable
+  public ScheduleState getState() {
+    return state;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    Schedule schedule = (Schedule) o;
+    return Objects.equals(action, schedule.action)
+        && Objects.equals(policy, schedule.policy)
+        && Objects.equals(state, schedule.state)
+        && Objects.equals(spec, schedule.spec);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(action, policy, state, spec);
+  }
+
+  @Override
+  public String toString() {
+    return "Schedule{"
+        + "action="
+        + action
+        + ", policy="
+        + policy
+        + ", state="
+        + state
+        + ", spec="
+        + spec
+        + '}';
+  }
+}

temporal-sdk/src/main/java/io/temporal/client/schedules/ScheduleAction.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client.schedules;
+
+/**
+ * Base class for an action a schedule can take. See ScheduleActionStartWorkflow for the most
+ * commonly used implementation.
+ *
+ * @see ScheduleActionStartWorkflow
+ */
+public abstract class ScheduleAction {
+  ScheduleAction() {}
+}

temporal-sdk/src/main/java/io/temporal/client/schedules/ScheduleActionExecution.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client.schedules;
+
+/**
+ * Base class for an action execution.
+ *
+ * @see ScheduleActionExecutionStartWorkflow
+ */
+public abstract class ScheduleActionExecution {
+  ScheduleActionExecution() {}
+}

temporal-sdk/src/main/java/io/temporal/client/schedules/ScheduleActionExecutionStartWorkflow.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client.schedules;
+
+import java.util.Objects;
+
+/** Action execution representing a scheduled workflow start. */
+public final class ScheduleActionExecutionStartWorkflow extends ScheduleActionExecution {
+  private final String workflowId;
+  private final String firstExecutionRunId;
+
+  public ScheduleActionExecutionStartWorkflow(String workflowId, String firstExecutionRunId) {
+    this.workflowId = workflowId;
+    this.firstExecutionRunId = firstExecutionRunId;
+  }
+
+  /**
+   * Get the workflow ID of the scheduled workflow.
+   *
+   * @return workflow ID
+   */
+  public String getWorkflowId() {
+    return workflowId;
+  }
+
+  /**
+   * Get the workflow run ID of the scheduled workflow.
+   *
+   * @return run ID
+   */
+  public String getFirstExecutionRunId() {
+    return firstExecutionRunId;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    ScheduleActionExecutionStartWorkflow that = (ScheduleActionExecutionStartWorkflow) o;
+    return Objects.equals(workflowId, that.workflowId)
+        && Objects.equals(firstExecutionRunId, that.firstExecutionRunId);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(workflowId, firstExecutionRunId);
+  }
+
+  @Override
+  public String toString() {
+    return "ScheduleActionExecutionStartWorkflow{"
+        + "workflowId='"
+        + workflowId
+        + '\''
+        + ", firstExecutionRunId='"
+        + firstExecutionRunId
+        + '\''
+        + '}';
+  }
+}