Package io.temporal.api.activity.v1

Interface ActivityOptionsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ActivityOptions, ActivityOptions.Builder
    @Generated(value="protoc",
           comments="annotations:ActivityOptionsOrBuilder.java.pb.meta")
public interface ActivityOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getHeartbeatTimeout()
      Maximum permitted time between successful worker heartbeats.
      com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
      Maximum permitted time between successful worker heartbeats.
      RetryPolicy getRetryPolicy()
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      com.google.protobuf.Duration getScheduleToCloseTimeout()
      Indicates how long the caller is willing to wait for an activity completion.
      com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
      Indicates how long the caller is willing to wait for an activity completion.
      com.google.protobuf.Duration getScheduleToStartTimeout()
      Limits time an activity task can stay in a task queue before a worker picks it up.
      com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
      Limits time an activity task can stay in a task queue before a worker picks it up.
      com.google.protobuf.Duration getStartToCloseTimeout()
      Maximum time an activity is allowed to execute after being picked up by a worker.
      com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
      Maximum time an activity is allowed to execute after being picked up by a worker.
      TaskQueue getTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
      TaskQueueOrBuilder getTaskQueueOrBuilder()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
      boolean hasHeartbeatTimeout()
      Maximum permitted time between successful worker heartbeats.
      boolean hasRetryPolicy()
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      boolean hasScheduleToCloseTimeout()
      Indicates how long the caller is willing to wait for an activity completion.
      boolean hasScheduleToStartTimeout()
      Limits time an activity task can stay in a task queue before a worker picks it up.
      boolean hasStartToCloseTimeout()
      Maximum time an activity is allowed to execute after being picked up by a worker.
      boolean hasTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasTaskQueue

        boolean hasTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
        Returns:
        Whether the taskQueue field is set.

      • getTaskQueue

        TaskQueue getTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

        TaskQueueOrBuilder getTaskQueueOrBuilder()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;

      • hasScheduleToCloseTimeout

        boolean hasScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 2;
        Returns:
        Whether the scheduleToCloseTimeout field is set.

      • getScheduleToCloseTimeout

        com.google.protobuf.Duration getScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 2;
        Returns:
        The scheduleToCloseTimeout.

      • getScheduleToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 2;

      • hasScheduleToStartTimeout

        boolean hasScheduleToStartTimeout()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 3;
        Returns:
        Whether the scheduleToStartTimeout field is set.

      • getScheduleToStartTimeout

        com.google.protobuf.Duration getScheduleToStartTimeout()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 3;
        Returns:
        The scheduleToStartTimeout.

      • getScheduleToStartTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 3;

      • hasStartToCloseTimeout

        boolean hasStartToCloseTimeout()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 4;
        Returns:
        Whether the startToCloseTimeout field is set.

      • getStartToCloseTimeout

        com.google.protobuf.Duration getStartToCloseTimeout()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 4;
        Returns:
        The startToCloseTimeout.

      • getStartToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 4;

      • hasHeartbeatTimeout

        boolean hasHeartbeatTimeout()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 5;
        Returns:
        Whether the heartbeatTimeout field is set.

      • getHeartbeatTimeout

        com.google.protobuf.Duration getHeartbeatTimeout()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 5;
        Returns:
        The heartbeatTimeout.

      • getHeartbeatTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 5;

      • hasRetryPolicy

        boolean hasRetryPolicy()
        .temporal.api.common.v1.RetryPolicy retry_policy = 6;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
        .temporal.api.common.v1.RetryPolicy retry_policy = 6;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
        .temporal.api.common.v1.RetryPolicy retry_policy = 6;