Class ActivityOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.activity.v1.ActivityOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ActivityOptionsOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:ActivityOptions.java.pb.meta") public final class ActivityOptions extends com.google.protobuf.GeneratedMessageV3 implements ActivityOptionsOrBuilder
Protobuf type temporal.api.activity.v1.ActivityOptions
See Also:

  • Field Details

    • TASK_QUEUE_FIELD_NUMBER

      public static final int TASK_QUEUE_FIELD_NUMBER
      See Also:

    • SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER

      public static final int SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER
      See Also:

    • SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER

      public static final int SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER
      See Also:

    • START_TO_CLOSE_TIMEOUT_FIELD_NUMBER

      public static final int START_TO_CLOSE_TIMEOUT_FIELD_NUMBER
      See Also:

    • HEARTBEAT_TIMEOUT_FIELD_NUMBER

      public static final int HEARTBEAT_TIMEOUT_FIELD_NUMBER
      See Also:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasTaskQueue

      public boolean hasTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
      Specified by:
      hasTaskQueue in interface ActivityOptionsOrBuilder
      Returns:
      Whether the taskQueue field is set.

    • getTaskQueue

      public TaskQueue getTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
      Specified by:
      getTaskQueue in interface ActivityOptionsOrBuilder
      Returns:
      The taskQueue.

    • getTaskQueueOrBuilder

      public TaskQueueOrBuilder getTaskQueueOrBuilder()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 1;
      Specified by:
      getTaskQueueOrBuilder in interface ActivityOptionsOrBuilder

    • hasScheduleToCloseTimeout

      public 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;
      Specified by:
      hasScheduleToCloseTimeout in interface ActivityOptionsOrBuilder
      Returns:
      Whether the scheduleToCloseTimeout field is set.

    • getScheduleToCloseTimeout

      public 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;
      Specified by:
      getScheduleToCloseTimeout in interface ActivityOptionsOrBuilder
      Returns:
      The scheduleToCloseTimeout.

    • getScheduleToCloseTimeoutOrBuilder

      public 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;
      Specified by:
      getScheduleToCloseTimeoutOrBuilder in interface ActivityOptionsOrBuilder

    • hasScheduleToStartTimeout

      public 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;
      Specified by:
      hasScheduleToStartTimeout in interface ActivityOptionsOrBuilder
      Returns:
      Whether the scheduleToStartTimeout field is set.

    • getScheduleToStartTimeout

      public 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;
      Specified by:
      getScheduleToStartTimeout in interface ActivityOptionsOrBuilder
      Returns:
      The scheduleToStartTimeout.

    • getScheduleToStartTimeoutOrBuilder

      public 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;
      Specified by:
      getScheduleToStartTimeoutOrBuilder in interface ActivityOptionsOrBuilder

    • hasStartToCloseTimeout

      public 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;
      Specified by:
      hasStartToCloseTimeout in interface ActivityOptionsOrBuilder
      Returns:
      Whether the startToCloseTimeout field is set.

    • getStartToCloseTimeout

      public 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;
      Specified by:
      getStartToCloseTimeout in interface ActivityOptionsOrBuilder
      Returns:
      The startToCloseTimeout.

    • getStartToCloseTimeoutOrBuilder

      public 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;
      Specified by:
      getStartToCloseTimeoutOrBuilder in interface ActivityOptionsOrBuilder

    • hasHeartbeatTimeout

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

    • getHeartbeatTimeout

      public com.google.protobuf.Duration getHeartbeatTimeout()
       Maximum permitted time between successful worker heartbeats.
      .google.protobuf.Duration heartbeat_timeout = 5;
      Specified by:
      getHeartbeatTimeout in interface ActivityOptionsOrBuilder
      Returns:
      The heartbeatTimeout.

    • getHeartbeatTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
       Maximum permitted time between successful worker heartbeats.
      .google.protobuf.Duration heartbeat_timeout = 5;
      Specified by:
      getHeartbeatTimeoutOrBuilder in interface ActivityOptionsOrBuilder

    • hasRetryPolicy

      public boolean hasRetryPolicy()
       The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      Specified by:
      hasRetryPolicy in interface ActivityOptionsOrBuilder
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      public RetryPolicy getRetryPolicy()
       The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      Specified by:
      getRetryPolicy in interface ActivityOptionsOrBuilder
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
      .temporal.api.common.v1.RetryPolicy retry_policy = 6;
      Specified by:
      getRetryPolicyOrBuilder in interface ActivityOptionsOrBuilder

    • hasPriority

      public boolean hasPriority()
       Priority metadata. If this message is not present, or any fields are not
 present, they inherit the values from the workflow.
      .temporal.api.common.v1.Priority priority = 7;
      Specified by:
      hasPriority in interface ActivityOptionsOrBuilder
      Returns:
      Whether the priority field is set.

    • getPriority

      public Priority getPriority()
       Priority metadata. If this message is not present, or any fields are not
 present, they inherit the values from the workflow.
      .temporal.api.common.v1.Priority priority = 7;
      Specified by:
      getPriority in interface ActivityOptionsOrBuilder
      Returns:
      The priority.

    • getPriorityOrBuilder

      public PriorityOrBuilder getPriorityOrBuilder()
       Priority metadata. If this message is not present, or any fields are not
 present, they inherit the values from the workflow.
      .temporal.api.common.v1.Priority priority = 7;
      Specified by:
      getPriorityOrBuilder in interface ActivityOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ActivityOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ActivityOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ActivityOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ActivityOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ActivityOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ActivityOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ActivityOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ActivityOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ActivityOptions.Builder newBuilder()

    • newBuilder

      public static ActivityOptions.Builder newBuilder(ActivityOptions prototype)

    • toBuilder

      public ActivityOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ActivityOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ActivityOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ActivityOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<ActivityOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ActivityOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder