Package io.temporal.api.command.v1

Class ScheduleActivityTaskCommandAttributes

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScheduleActivityTaskCommandAttributesOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:ScheduleActivityTaskCommandAttributes.java.pb.meta")
public final class ScheduleActivityTaskCommandAttributes
extends com.google.protobuf.GeneratedMessageV3
implements ScheduleActivityTaskCommandAttributesOrBuilder
    Protobuf type temporal.api.command.v1.ScheduleActivityTaskCommandAttributes
    See Also:
    Serialized Form

    • Field Detail

      • ACTIVITY_ID_FIELD_NUMBER

        public static final int ACTIVITY_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVITY_TYPE_FIELD_NUMBER

        public static final int ACTIVITY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER

        public static final int SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER

        public static final int SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TO_CLOSE_TIMEOUT_FIELD_NUMBER

        public static final int START_TO_CLOSE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEARTBEAT_TIMEOUT_FIELD_NUMBER

        public static final int HEARTBEAT_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RETRY_POLICY_FIELD_NUMBER

        public static final int RETRY_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_EAGER_EXECUTION_FIELD_NUMBER

        public static final int REQUEST_EAGER_EXECUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_COMPATIBLE_VERSION_FIELD_NUMBER

        public static final int USE_COMPATIBLE_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasScheduleToCloseTimeout

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

      • getScheduleToCloseTimeout

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

      • getScheduleToCloseTimeoutOrBuilder

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

      • hasScheduleToStartTimeout

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

      • getScheduleToStartTimeout

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

      • getScheduleToStartTimeoutOrBuilder

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

      • 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 = 9 [(.gogoproto.stdduration) = true];
        Specified by:
        hasStartToCloseTimeout in interface ScheduleActivityTaskCommandAttributesOrBuilder
        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 = 9 [(.gogoproto.stdduration) = true];
        Specified by:
        getStartToCloseTimeout in interface ScheduleActivityTaskCommandAttributesOrBuilder
        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 = 9 [(.gogoproto.stdduration) = true];
        Specified by:
        getStartToCloseTimeoutOrBuilder in interface ScheduleActivityTaskCommandAttributesOrBuilder

      • hasHeartbeatTimeout

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

      • hasRetryPolicy

        public 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;
        Specified by:
        hasRetryPolicy in interface ScheduleActivityTaskCommandAttributesOrBuilder
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        public 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;
        Specified by:
        getRetryPolicy in interface ScheduleActivityTaskCommandAttributesOrBuilder
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        public 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;
        Specified by:
        getRetryPolicyOrBuilder in interface ScheduleActivityTaskCommandAttributesOrBuilder

      • getRequestEagerExecution

        public 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;
        Specified by:
        getRequestEagerExecution in interface ScheduleActivityTaskCommandAttributesOrBuilder
        Returns:
        The requestEagerExecution.

      • getUseCompatibleVersion

        public 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;
        Specified by:
        getUseCompatibleVersion in interface ScheduleActivityTaskCommandAttributesOrBuilder
        Returns:
        The useCompatibleVersion.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 ScheduleActivityTaskCommandAttributes parseFrom​(java.nio.ByteBuffer data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ScheduleActivityTaskCommandAttributes parseFrom​(java.nio.ByteBuffer data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static ScheduleActivityTaskCommandAttributes parseFrom​(java.io.InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ScheduleActivityTaskCommandAttributes parseDelimitedFrom​(java.io.InputStream input,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ScheduleActivityTaskCommandAttributes parseFrom​(com.google.protobuf.CodedInputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ScheduleActivityTaskCommandAttributes> 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 ScheduleActivityTaskCommandAttributes getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder