Package io.temporal.api.activity.v1

Interface ActivityExecutionInfoOrBuilder

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

    • Method Detail

      • getActivityId

        java.lang.String getActivityId()
         Unique identifier of this activity within its namespace along with run ID (below).
        string activity_id = 1;
        Returns:
        The activityId.

      • getActivityIdBytes

        com.google.protobuf.ByteString getActivityIdBytes()
         Unique identifier of this activity within its namespace along with run ID (below).
        string activity_id = 1;
        Returns:
        The bytes for activityId.

      • getRunId

        java.lang.String getRunId()
        string run_id = 2;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
        string run_id = 2;
        Returns:
        The bytes for runId.

      • hasActivityType

        boolean hasActivityType()
         The type of the activity, a string that maps to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 3;
        Returns:
        Whether the activityType field is set.

      • getActivityType

        ActivityType getActivityType()
         The type of the activity, a string that maps to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 3;
        Returns:
        The activityType.

      • getActivityTypeOrBuilder

        ActivityTypeOrBuilder getActivityTypeOrBuilder()
         The type of the activity, a string that maps to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 3;

      • getStatusValue

        int getStatusValue()
         A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.
        .temporal.api.enums.v1.ActivityExecutionStatus status = 4;
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        ActivityExecutionStatus getStatus()
         A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.
        .temporal.api.enums.v1.ActivityExecutionStatus status = 4;
        Returns:
        The status.

      • getRunStateValue

        int getRunStateValue()
         More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
        .temporal.api.enums.v1.PendingActivityState run_state = 5;
        Returns:
        The enum numeric value on the wire for runState.

      • getRunState

        PendingActivityState getRunState()
         More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
        .temporal.api.enums.v1.PendingActivityState run_state = 5;
        Returns:
        The runState.

      • getTaskQueue

        java.lang.String getTaskQueue()
        string task_queue = 6;
        Returns:
        The taskQueue.

      • getTaskQueueBytes

        com.google.protobuf.ByteString getTaskQueueBytes()
        string task_queue = 6;
        Returns:
        The bytes for taskQueue.

      • hasScheduleToCloseTimeout

        boolean hasScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7;
        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.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7;
        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.

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

      • 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`.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8;
        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`.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8;
        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`.

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

      • hasStartToCloseTimeout

        boolean hasStartToCloseTimeout()
         Maximum time a single activity attempt is allowed to execute after being picked up by a worker. This
 timeout is always retryable.

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

      • getStartToCloseTimeout

        com.google.protobuf.Duration getStartToCloseTimeout()
         Maximum time a single activity attempt is allowed to execute after being picked up by a worker. This
 timeout is always retryable.

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

      • getStartToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
         Maximum time a single activity attempt is allowed to execute after being picked up by a worker. This
 timeout is always retryable.

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

      • hasHeartbeatTimeout

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

      • getHeartbeatTimeoutOrBuilder

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

      • hasRetryPolicy

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

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
         The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;

      • hasHeartbeatDetails

        boolean hasHeartbeatDetails()
         Details provided in the last recorded activity heartbeat.
        .temporal.api.common.v1.Payloads heartbeat_details = 12;
        Returns:
        Whether the heartbeatDetails field is set.

      • getHeartbeatDetails

        Payloads getHeartbeatDetails()
         Details provided in the last recorded activity heartbeat.
        .temporal.api.common.v1.Payloads heartbeat_details = 12;
        Returns:
        The heartbeatDetails.

      • getHeartbeatDetailsOrBuilder

        PayloadsOrBuilder getHeartbeatDetailsOrBuilder()
         Details provided in the last recorded activity heartbeat.
        .temporal.api.common.v1.Payloads heartbeat_details = 12;

      • hasLastHeartbeatTime

        boolean hasLastHeartbeatTime()
         Time the last heartbeat was recorded.
        .google.protobuf.Timestamp last_heartbeat_time = 13;
        Returns:
        Whether the lastHeartbeatTime field is set.

      • getLastHeartbeatTime

        com.google.protobuf.Timestamp getLastHeartbeatTime()
         Time the last heartbeat was recorded.
        .google.protobuf.Timestamp last_heartbeat_time = 13;
        Returns:
        The lastHeartbeatTime.

      • getLastHeartbeatTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getLastHeartbeatTimeOrBuilder()
         Time the last heartbeat was recorded.
        .google.protobuf.Timestamp last_heartbeat_time = 13;

      • hasLastStartedTime

        boolean hasLastStartedTime()
         Time the last attempt was started.
        .google.protobuf.Timestamp last_started_time = 14;
        Returns:
        Whether the lastStartedTime field is set.

      • getLastStartedTime

        com.google.protobuf.Timestamp getLastStartedTime()
         Time the last attempt was started.
        .google.protobuf.Timestamp last_started_time = 14;
        Returns:
        The lastStartedTime.

      • getLastStartedTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getLastStartedTimeOrBuilder()
         Time the last attempt was started.
        .google.protobuf.Timestamp last_started_time = 14;

      • getAttempt

        int getAttempt()
         The attempt this activity is currently on. Incremented each time a new attempt is scheduled.
        int32 attempt = 15;
        Returns:
        The attempt.

      • hasExecutionDuration

        boolean hasExecutionDuration()
         How long this activity has been running for, including all attempts and backoff between attempts.
        .google.protobuf.Duration execution_duration = 16;
        Returns:
        Whether the executionDuration field is set.

      • getExecutionDuration

        com.google.protobuf.Duration getExecutionDuration()
         How long this activity has been running for, including all attempts and backoff between attempts.
        .google.protobuf.Duration execution_duration = 16;
        Returns:
        The executionDuration.

      • getExecutionDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()
         How long this activity has been running for, including all attempts and backoff between attempts.
        .google.protobuf.Duration execution_duration = 16;

      • hasScheduleTime

        boolean hasScheduleTime()
         Time the activity was originally scheduled via a StartActivityExecution request.
        .google.protobuf.Timestamp schedule_time = 17;
        Returns:
        Whether the scheduleTime field is set.

      • getScheduleTime

        com.google.protobuf.Timestamp getScheduleTime()
         Time the activity was originally scheduled via a StartActivityExecution request.
        .google.protobuf.Timestamp schedule_time = 17;
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
         Time the activity was originally scheduled via a StartActivityExecution request.
        .google.protobuf.Timestamp schedule_time = 17;

      • hasExpirationTime

        boolean hasExpirationTime()
         Scheduled time + schedule to close timeout.
        .google.protobuf.Timestamp expiration_time = 18;
        Returns:
        Whether the expirationTime field is set.

      • getExpirationTime

        com.google.protobuf.Timestamp getExpirationTime()
         Scheduled time + schedule to close timeout.
        .google.protobuf.Timestamp expiration_time = 18;
        Returns:
        The expirationTime.

      • getExpirationTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()
         Scheduled time + schedule to close timeout.
        .google.protobuf.Timestamp expiration_time = 18;

      • hasCloseTime

        boolean hasCloseTime()
         Time when the activity transitioned to a closed state.
        .google.protobuf.Timestamp close_time = 19;
        Returns:
        Whether the closeTime field is set.

      • getCloseTime

        com.google.protobuf.Timestamp getCloseTime()
         Time when the activity transitioned to a closed state.
        .google.protobuf.Timestamp close_time = 19;
        Returns:
        The closeTime.

      • getCloseTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCloseTimeOrBuilder()
         Time when the activity transitioned to a closed state.
        .google.protobuf.Timestamp close_time = 19;

      • hasLastFailure

        boolean hasLastFailure()
         Failure details from the last failed attempt.
        .temporal.api.failure.v1.Failure last_failure = 20;
        Returns:
        Whether the lastFailure field is set.

      • getLastFailure

        Failure getLastFailure()
         Failure details from the last failed attempt.
        .temporal.api.failure.v1.Failure last_failure = 20;
        Returns:
        The lastFailure.

      • getLastFailureOrBuilder

        FailureOrBuilder getLastFailureOrBuilder()
         Failure details from the last failed attempt.
        .temporal.api.failure.v1.Failure last_failure = 20;

      • getLastWorkerIdentity

        java.lang.String getLastWorkerIdentity()
        string last_worker_identity = 21;
        Returns:
        The lastWorkerIdentity.

      • getLastWorkerIdentityBytes

        com.google.protobuf.ByteString getLastWorkerIdentityBytes()
        string last_worker_identity = 21;
        Returns:
        The bytes for lastWorkerIdentity.

      • hasCurrentRetryInterval

        boolean hasCurrentRetryInterval()
         Time from the last attempt failure to the next activity retry.
 If the activity is currently running, this represents the next retry interval in case the attempt fails.
 If activity is currently backing off between attempt, this represents the current retry interval.
 If there is no next retry allowed, this field will be null.
 This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
 with a retryable application failure specifying a retry delay.
        .google.protobuf.Duration current_retry_interval = 22;
        Returns:
        Whether the currentRetryInterval field is set.

      • getCurrentRetryInterval

        com.google.protobuf.Duration getCurrentRetryInterval()
         Time from the last attempt failure to the next activity retry.
 If the activity is currently running, this represents the next retry interval in case the attempt fails.
 If activity is currently backing off between attempt, this represents the current retry interval.
 If there is no next retry allowed, this field will be null.
 This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
 with a retryable application failure specifying a retry delay.
        .google.protobuf.Duration current_retry_interval = 22;
        Returns:
        The currentRetryInterval.

      • getCurrentRetryIntervalOrBuilder

        com.google.protobuf.DurationOrBuilder getCurrentRetryIntervalOrBuilder()
         Time from the last attempt failure to the next activity retry.
 If the activity is currently running, this represents the next retry interval in case the attempt fails.
 If activity is currently backing off between attempt, this represents the current retry interval.
 If there is no next retry allowed, this field will be null.
 This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
 with a retryable application failure specifying a retry delay.
        .google.protobuf.Duration current_retry_interval = 22;

      • hasLastAttemptCompleteTime

        boolean hasLastAttemptCompleteTime()
         The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
        .google.protobuf.Timestamp last_attempt_complete_time = 23;
        Returns:
        Whether the lastAttemptCompleteTime field is set.

      • getLastAttemptCompleteTime

        com.google.protobuf.Timestamp getLastAttemptCompleteTime()
         The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
        .google.protobuf.Timestamp last_attempt_complete_time = 23;
        Returns:
        The lastAttemptCompleteTime.

      • getLastAttemptCompleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getLastAttemptCompleteTimeOrBuilder()
         The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
        .google.protobuf.Timestamp last_attempt_complete_time = 23;

      • hasNextAttemptScheduleTime

        boolean hasNextAttemptScheduleTime()
         The time when the next activity attempt will be scheduled.
 If activity is currently scheduled or started, this field will be null.
        .google.protobuf.Timestamp next_attempt_schedule_time = 24;
        Returns:
        Whether the nextAttemptScheduleTime field is set.

      • getNextAttemptScheduleTime

        com.google.protobuf.Timestamp getNextAttemptScheduleTime()
         The time when the next activity attempt will be scheduled.
 If activity is currently scheduled or started, this field will be null.
        .google.protobuf.Timestamp next_attempt_schedule_time = 24;
        Returns:
        The nextAttemptScheduleTime.

      • getNextAttemptScheduleTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getNextAttemptScheduleTimeOrBuilder()
         The time when the next activity attempt will be scheduled.
 If activity is currently scheduled or started, this field will be null.
        .google.protobuf.Timestamp next_attempt_schedule_time = 24;

      • hasLastDeploymentVersion

        boolean hasLastDeploymentVersion()
         The Worker Deployment Version this activity was dispatched to most recently.
 If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.
        .temporal.api.deployment.v1.WorkerDeploymentVersion last_deployment_version = 25;
        Returns:
        Whether the lastDeploymentVersion field is set.

      • getLastDeploymentVersion

        WorkerDeploymentVersion getLastDeploymentVersion()
         The Worker Deployment Version this activity was dispatched to most recently.
 If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.
        .temporal.api.deployment.v1.WorkerDeploymentVersion last_deployment_version = 25;
        Returns:
        The lastDeploymentVersion.

      • getLastDeploymentVersionOrBuilder

        WorkerDeploymentVersionOrBuilder getLastDeploymentVersionOrBuilder()
         The Worker Deployment Version this activity was dispatched to most recently.
 If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.
        .temporal.api.deployment.v1.WorkerDeploymentVersion last_deployment_version = 25;

      • hasPriority

        boolean hasPriority()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 26;
        Returns:
        Whether the priority field is set.

      • getPriority

        Priority getPriority()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 26;
        Returns:
        The priority.

      • getPriorityOrBuilder

        PriorityOrBuilder getPriorityOrBuilder()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 26;

      • getStateTransitionCount

        long getStateTransitionCount()
         Incremented each time the activity's state is mutated in persistence.
        int64 state_transition_count = 27;
        Returns:
        The stateTransitionCount.

      • getStateSizeBytes

        long getStateSizeBytes()
         Updated once on scheduled and once on terminal status.
        int64 state_size_bytes = 28;
        Returns:
        The stateSizeBytes.

      • hasSearchAttributes

        boolean hasSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 29;
        Returns:
        Whether the searchAttributes field is set.

      • getSearchAttributes

        SearchAttributes getSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 29;
        Returns:
        The searchAttributes.

      • getSearchAttributesOrBuilder

        SearchAttributesOrBuilder getSearchAttributesOrBuilder()
        .temporal.api.common.v1.SearchAttributes search_attributes = 29;

      • hasHeader

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

      • getHeader

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

      • getHeaderOrBuilder

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

      • hasUserMetadata

        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 = 31;
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        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 = 31;
        Returns:
        The userMetadata.

      • getUserMetadataOrBuilder

        UserMetadataOrBuilder getUserMetadataOrBuilder()
         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 = 31;

      • getCanceledReason

        java.lang.String getCanceledReason()
         Set if activity cancelation was requested.
        string canceled_reason = 32;
        Returns:
        The canceledReason.

      • getCanceledReasonBytes

        com.google.protobuf.ByteString getCanceledReasonBytes()
         Set if activity cancelation was requested.
        string canceled_reason = 32;
        Returns:
        The bytes for canceledReason.