Package io.temporal.api.workflowservice.v1

Class StartActivityExecutionRequest

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

    • Field Detail

      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • 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

      • ID_REUSE_POLICY_FIELD_NUMBER

        public static final int ID_REUSE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ID_CONFLICT_POLICY_FIELD_NUMBER

        public static final int ID_CONFLICT_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEARCH_ATTRIBUTES_FIELD_NUMBER

        public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_METADATA_FIELD_NUMBER

        public static final int USER_METADATA_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

      • 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

      • getIdentityBytes

        public com.google.protobuf.ByteString getIdentityBytes()
         The identity of the client who initiated this request
        string identity = 2;
        Specified by:
        getIdentityBytes in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The bytes for identity.

      • getRequestIdBytes

        public com.google.protobuf.ByteString getRequestIdBytes()
         A unique identifier for this start request. Typically UUIDv4.
        string request_id = 3;
        Specified by:
        getRequestIdBytes in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The bytes for requestId.

      • getActivityId

        public java.lang.String getActivityId()
         Identifier for this activity. Required. This identifier should be meaningful in the user's
 own system. It must be unique among activities in the same namespace, subject to the rules
 imposed by id_reuse_policy and id_conflict_policy.
        string activity_id = 4;
        Specified by:
        getActivityId in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The activityId.

      • getActivityIdBytes

        public com.google.protobuf.ByteString getActivityIdBytes()
         Identifier for this activity. Required. This identifier should be meaningful in the user's
 own system. It must be unique among activities in the same namespace, subject to the rules
 imposed by id_reuse_policy and id_conflict_policy.
        string activity_id = 4;
        Specified by:
        getActivityIdBytes in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The bytes for activityId.

      • hasActivityType

        public boolean hasActivityType()
         The type of the activity, a string that corresponds to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 5;
        Specified by:
        hasActivityType in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the activityType field is set.

      • hasTaskQueue

        public boolean hasTaskQueue()
         Task queue to schedule this activity on.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 6;
        Specified by:
        hasTaskQueue in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the taskQueue field is set.

      • 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 = 7;
        Specified by:
        hasScheduleToCloseTimeout in interface StartActivityExecutionRequestOrBuilder
        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 = 7;
        Specified by:
        getScheduleToCloseTimeout in interface StartActivityExecutionRequestOrBuilder
        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 = 7;
        Specified by:
        getScheduleToCloseTimeoutOrBuilder in interface StartActivityExecutionRequestOrBuilder

      • 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` 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 = 8;
        Specified by:
        hasScheduleToStartTimeout in interface StartActivityExecutionRequestOrBuilder
        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` 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 = 8;
        Specified by:
        getScheduleToStartTimeout in interface StartActivityExecutionRequestOrBuilder
        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` 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 = 8;
        Specified by:
        getScheduleToStartTimeoutOrBuilder in interface StartActivityExecutionRequestOrBuilder

      • 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;
        Specified by:
        hasStartToCloseTimeout in interface StartActivityExecutionRequestOrBuilder
        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;
        Specified by:
        getStartToCloseTimeout in interface StartActivityExecutionRequestOrBuilder
        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;
        Specified by:
        getStartToCloseTimeoutOrBuilder in interface StartActivityExecutionRequestOrBuilder

      • hasHeartbeatTimeout

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

      • hasRetryPolicy

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

      • hasInput

        public boolean hasInput()
         Serialized arguments to the activity. These are passed as arguments to the activity function.
        .temporal.api.common.v1.Payloads input = 12;
        Specified by:
        hasInput in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the input field is set.

      • getInput

        public Payloads getInput()
         Serialized arguments to the activity. These are passed as arguments to the activity function.
        .temporal.api.common.v1.Payloads input = 12;
        Specified by:
        getInput in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The input.

      • getIdReusePolicyValue

        public int getIdReusePolicyValue()
         Defines whether to allow re-using the activity id from a previously *closed* activity.
 The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 13;
        Specified by:
        getIdReusePolicyValue in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The enum numeric value on the wire for idReusePolicy.

      • getIdReusePolicy

        public ActivityIdReusePolicy getIdReusePolicy()
         Defines whether to allow re-using the activity id from a previously *closed* activity.
 The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 13;
        Specified by:
        getIdReusePolicy in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The idReusePolicy.

      • getIdConflictPolicyValue

        public int getIdConflictPolicyValue()
         Defines how to resolve an activity id conflict with a *running* activity.
 The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
        .temporal.api.enums.v1.ActivityIdConflictPolicy id_conflict_policy = 14;
        Specified by:
        getIdConflictPolicyValue in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The enum numeric value on the wire for idConflictPolicy.

      • hasSearchAttributes

        public boolean hasSearchAttributes()
         Search attributes for indexing.
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;
        Specified by:
        hasSearchAttributes in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the searchAttributes field is set.

      • hasHeader

        public boolean hasHeader()
         Header for context propagation and tracing purposes.
        .temporal.api.common.v1.Header header = 16;
        Specified by:
        hasHeader in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the header field is set.

      • hasUserMetadata

        public boolean hasUserMetadata()
         Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 17;
        Specified by:
        hasUserMetadata in interface StartActivityExecutionRequestOrBuilder
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        public UserMetadata getUserMetadata()
         Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 17;
        Specified by:
        getUserMetadata in interface StartActivityExecutionRequestOrBuilder
        Returns:
        The userMetadata.

      • 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 StartActivityExecutionRequest parseFrom​(java.nio.ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static StartActivityExecutionRequest parseFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static StartActivityExecutionRequest parseDelimitedFrom​(java.io.InputStream input)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

        public static StartActivityExecutionRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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