Package io.temporal.api.command.v1

Interface ScheduleActivityTaskCommandAttributesOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      string activity_id = 1;
      com.google.protobuf.ByteString getActivityIdBytes()
      string activity_id = 1;
      ActivityType getActivityType()
      .temporal.api.common.v1.ActivityType activity_type = 2;
      ActivityTypeOrBuilder getActivityTypeOrBuilder()
      .temporal.api.common.v1.ActivityType activity_type = 2;
      Header getHeader()
      .temporal.api.common.v1.Header header = 5;
      HeaderOrBuilder getHeaderOrBuilder()
      .temporal.api.common.v1.Header header = 5;
      com.google.protobuf.Duration getHeartbeatTimeout()
      Maximum permitted time between successful worker heartbeats.
      com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
      Maximum permitted time between successful worker heartbeats.
      Payloads getInput()
      .temporal.api.common.v1.Payloads input = 6;
      PayloadsOrBuilder getInputOrBuilder()
      .temporal.api.common.v1.Payloads input = 6;
      boolean getRequestEagerExecution()
      Request to start the activity directly bypassing matching service and worker polling The slot for executing the activity should be reserved when setting this field to true.
      RetryPolicy getRetryPolicy()
      Activities are provided by a default retry policy which is controlled through the service's dynamic configuration.
      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
      Activities are provided by a default retry policy which is controlled through the service's dynamic configuration.
      com.google.protobuf.Duration getScheduleToCloseTimeout()
      Indicates how long the caller is willing to wait for activity completion.
      com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
      Indicates how long the caller is willing to wait for activity completion.
      com.google.protobuf.Duration getScheduleToStartTimeout()
      Limits the time an activity task can stay in a task queue before a worker picks it up.
      com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
      Limits the 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 = 4;
      TaskQueueOrBuilder getTaskQueueOrBuilder()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
      boolean getUseCompatibleVersion()
      If this is set, the workflow executing this command wishes to start the activity using a version compatible with the version that this workflow most recently ran on, if such behavior is possible.
      boolean hasActivityType()
      .temporal.api.common.v1.ActivityType activity_type = 2;
      boolean hasHeader()
      .temporal.api.common.v1.Header header = 5;
      boolean hasHeartbeatTimeout()
      Maximum permitted time between successful worker heartbeats.
      boolean hasInput()
      .temporal.api.common.v1.Payloads input = 6;
      boolean hasRetryPolicy()
      Activities are provided by a default retry policy which is controlled through the service's dynamic configuration.
      boolean hasScheduleToCloseTimeout()
      Indicates how long the caller is willing to wait for activity completion.
      boolean hasScheduleToStartTimeout()
      Limits the 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 = 4;

      • 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

      • getActivityId

        java.lang.String getActivityId()
        string activity_id = 1;
        Returns:
        The activityId.

      • getActivityIdBytes

        com.google.protobuf.ByteString getActivityIdBytes()
        string activity_id = 1;
        Returns:
        The bytes for activityId.

      • hasActivityType

        boolean hasActivityType()
        .temporal.api.common.v1.ActivityType activity_type = 2;
        Returns:
        Whether the activityType field is set.

      • getActivityType

        ActivityType getActivityType()
        .temporal.api.common.v1.ActivityType activity_type = 2;
        Returns:
        The activityType.

      • getActivityTypeOrBuilder

        ActivityTypeOrBuilder getActivityTypeOrBuilder()
        .temporal.api.common.v1.ActivityType activity_type = 2;

      • hasTaskQueue

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

      • getTaskQueue

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

      • getTaskQueueOrBuilder

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

      • hasHeader

        boolean hasHeader()
        .temporal.api.common.v1.Header header = 5;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
        .temporal.api.common.v1.Header header = 5;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
        .temporal.api.common.v1.Header header = 5;

      • hasInput

        boolean hasInput()
        .temporal.api.common.v1.Payloads input = 6;
        Returns:
        Whether the input field is set.

      • getInput

        Payloads getInput()
        .temporal.api.common.v1.Payloads input = 6;
        Returns:
        The input.

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
        .temporal.api.common.v1.Payloads input = 6;

      • hasScheduleToCloseTimeout

        boolean hasScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for activity completion. The "schedule" time
 is when the activity is initially scheduled, not when the most recent retry is scheduled.
 Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be
 specified. When not specified, defaults to the workflow execution timeout.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7 [(.gogoproto.stdduration) = true];
        Returns:
        Whether the scheduleToCloseTimeout field is set.

      • getScheduleToCloseTimeout

        com.google.protobuf.Duration getScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for activity completion. The "schedule" time
 is when the activity is initially scheduled, not when the most recent retry is scheduled.
 Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be
 specified. When not specified, defaults to the workflow execution timeout.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7 [(.gogoproto.stdduration) = true];
        Returns:
        The scheduleToCloseTimeout.

      • getScheduleToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
         Indicates how long the caller is willing to wait for activity completion. The "schedule" time
 is when the activity is initially scheduled, not when the most recent retry is scheduled.
 Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be
 specified. When not specified, defaults to the workflow execution timeout.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7 [(.gogoproto.stdduration) = true];

      • hasScheduleToStartTimeout

        boolean hasScheduleToStartTimeout()
         Limits the time an activity task can stay in a task queue before a worker picks it up. The
 "schedule" time is when the most recent retry is scheduled. This timeout should usually not
 be set: it's useful in specific scenarios like worker-specific task queues. 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 that is not
 specified. More info:
 https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8 [(.gogoproto.stdduration) = true];
        Returns:
        Whether the scheduleToStartTimeout field is set.

      • getScheduleToStartTimeout

        com.google.protobuf.Duration getScheduleToStartTimeout()
         Limits the time an activity task can stay in a task queue before a worker picks it up. The
 "schedule" time is when the most recent retry is scheduled. This timeout should usually not
 be set: it's useful in specific scenarios like worker-specific task queues. 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 that is not
 specified. More info:
 https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8 [(.gogoproto.stdduration) = true];
        Returns:
        The scheduleToStartTimeout.

      • getScheduleToStartTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
         Limits the time an activity task can stay in a task queue before a worker picks it up. The
 "schedule" time is when the most recent retry is scheduled. This timeout should usually not
 be set: it's useful in specific scenarios like worker-specific task queues. 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 that is not
 specified. More info:
 https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8 [(.gogoproto.stdduration) = true];

      • 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 = 9 [(.gogoproto.stdduration) = true];
        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 = 9 [(.gogoproto.stdduration) = true];
        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 = 9 [(.gogoproto.stdduration) = true];

      • hasHeartbeatTimeout

        boolean hasHeartbeatTimeout()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 10 [(.gogoproto.stdduration) = true];
        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 = 10 [(.gogoproto.stdduration) = true];
        Returns:
        The heartbeatTimeout.

      • getHeartbeatTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 10 [(.gogoproto.stdduration) = true];

      • hasRetryPolicy

        boolean hasRetryPolicy()
         Activities are provided by a default retry policy which is controlled through the service's
 dynamic configuration. Retries will be attempted until `schedule_to_close_timeout` has
 elapsed. To disable retries set retry_policy.maximum_attempts to 1.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
         Activities are provided by a default retry policy which is controlled through the service's
 dynamic configuration. Retries will be attempted until `schedule_to_close_timeout` has
 elapsed. To disable retries set retry_policy.maximum_attempts to 1.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         Activities are provided by a default retry policy which is controlled through the service's
 dynamic configuration. Retries will be attempted until `schedule_to_close_timeout` has
 elapsed. To disable retries set retry_policy.maximum_attempts to 1.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;

      • getRequestEagerExecution

        boolean getRequestEagerExecution()
         Request to start the activity directly bypassing matching service and worker polling
 The slot for executing the activity should be reserved when setting this field to true.
        bool request_eager_execution = 12;
        Returns:
        The requestEagerExecution.

      • getUseCompatibleVersion

        boolean getUseCompatibleVersion()
         If this is set, the workflow executing this command wishes to start the activity using
 a version compatible with the version that this workflow most recently ran on, if such
 behavior is possible.
        bool use_compatible_version = 13;
        Returns:
        The useCompatibleVersion.