Interface NexusOperationExecutionInfoOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
NexusOperationExecutionInfo,NexusOperationExecutionInfo.Builder
@Generated(value="protoc",
comments="annotations:NexusOperationExecutionInfoOrBuilder.java.pb.meta")
public interface NexusOperationExecutionInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanHeader for context propagation and tracing purposes.intThe number of attempts made to deliver the start operation request.If the state is BLOCKED, blocked reason provides additional information.com.google.protobuf.ByteStringIf the state is BLOCKED, blocked reason provides additional information..temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19;.temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19;com.google.protobuf.TimestampTime when the operation transitioned to a closed state.com.google.protobuf.TimestampOrBuilderTime when the operation transitioned to a closed state.Endpoint name, resolved to a URL via the cluster's endpoint registry.com.google.protobuf.ByteStringEndpoint name, resolved to a URL via the cluster's endpoint registry.com.google.protobuf.DurationElapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.com.google.protobuf.DurationOrBuilderElapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.com.google.protobuf.TimestampScheduled time + schedule to close timeout.com.google.protobuf.TimestampOrBuilderScheduled time + schedule to close timeout.The identity of the client who started this operation.com.google.protobuf.ByteStringThe identity of the client who started this operation.com.google.protobuf.TimestampThe time when the last attempt completed.com.google.protobuf.TimestampOrBuilderThe time when the last attempt completed.The last attempt's failure, if any.The last attempt's failure, if any.getLinks(int index) Links attached by the handler of this operation on start or completion.intLinks attached by the handler of this operation on start or completion.Links attached by the handler of this operation on start or completion.getLinksOrBuilder(int index) Links attached by the handler of this operation on start or completion.List<? extends LinkOrBuilder> Links attached by the handler of this operation on start or completion.com.google.protobuf.TimestampThe time when the next attempt is scheduled.com.google.protobuf.TimestampOrBuilderThe time when the next attempt is scheduled.Deprecated.intHeader for context propagation and tracing purposes.Header for context propagation and tracing purposes.getNexusHeaderOrDefault(String key, String defaultValue) Header for context propagation and tracing purposes.Header for context propagation and tracing purposes.Operation name.com.google.protobuf.ByteStringOperation name.Unique identifier of this Nexus operation within its namespace along with run ID (below).com.google.protobuf.ByteStringUnique identifier of this Nexus operation within its namespace along with run ID (below).Operation token.com.google.protobuf.ByteStringOperation token.Server-generated request ID used as an idempotency token when submitting start requests to the handler.com.google.protobuf.ByteStringServer-generated request ID used as an idempotency token when submitting start requests to the handler.getRunId()string run_id = 2;com.google.protobuf.ByteStringstring run_id = 2;com.google.protobuf.TimestampTime the operation was originally scheduled via a StartNexusOperation request.com.google.protobuf.TimestampOrBuilderTime the operation was originally scheduled via a StartNexusOperation request.com.google.protobuf.DurationSchedule-to-close timeout for this operation.com.google.protobuf.DurationOrBuilderSchedule-to-close timeout for this operation.com.google.protobuf.DurationSchedule-to-start timeout for this operation.com.google.protobuf.DurationOrBuilderSchedule-to-start timeout for this operation..temporal.api.common.v1.SearchAttributes search_attributes = 24;.temporal.api.common.v1.SearchAttributes search_attributes = 24;Service name.com.google.protobuf.ByteStringService name.com.google.protobuf.DurationStart-to-close timeout for this operation.com.google.protobuf.DurationOrBuilderStart-to-close timeout for this operation.getState()More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.longUpdated once on scheduled and once on terminal status.longIncremented each time the operation's state is mutated in persistence.intMore detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.A general status for this operation, indicates whether it is currently running or in one of the terminal statuses.intA general status for this operation, indicates whether it is currently running or in one of the terminal statuses.Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.boolean.temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19;booleanTime when the operation transitioned to a closed state.booleanElapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.booleanScheduled time + schedule to close timeout.booleanThe time when the last attempt completed.booleanThe last attempt's failure, if any.booleanThe time when the next attempt is scheduled.booleanTime the operation was originally scheduled via a StartNexusOperation request.booleanSchedule-to-close timeout for this operation.booleanSchedule-to-start timeout for this operation.boolean.temporal.api.common.v1.SearchAttributes search_attributes = 24;booleanStart-to-close timeout for this operation.booleanMetadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getOperationId
String getOperationId()Unique identifier of this Nexus operation within its namespace along with run ID (below).
string operation_id = 1;- Returns:
- The operationId.
-
getOperationIdBytes
com.google.protobuf.ByteString getOperationIdBytes()Unique identifier of this Nexus operation within its namespace along with run ID (below).
string operation_id = 1;- Returns:
- The bytes for operationId.
-
getRunId
-
getRunIdBytes
com.google.protobuf.ByteString getRunIdBytes()string run_id = 2;- Returns:
- The bytes for runId.
-
getEndpoint
String getEndpoint()Endpoint name, resolved to a URL via the cluster's endpoint registry.
string endpoint = 3;- Returns:
- The endpoint.
-
getEndpointBytes
com.google.protobuf.ByteString getEndpointBytes()Endpoint name, resolved to a URL via the cluster's endpoint registry.
string endpoint = 3;- Returns:
- The bytes for endpoint.
-
getService
-
getServiceBytes
com.google.protobuf.ByteString getServiceBytes()Service name.
string service = 4;- Returns:
- The bytes for service.
-
getOperation
-
getOperationBytes
com.google.protobuf.ByteString getOperationBytes()Operation name.
string operation = 5;- Returns:
- The bytes for operation.
-
getStatusValue
int getStatusValue()A general status for this operation, indicates whether it is currently running or in one of the terminal statuses. Updated once when the operation is originally scheduled, and again when it reaches a terminal status.
.temporal.api.enums.v1.NexusOperationExecutionStatus status = 6;- Returns:
- The enum numeric value on the wire for status.
-
getStatus
NexusOperationExecutionStatus getStatus()A general status for this operation, indicates whether it is currently running or in one of the terminal statuses. Updated once when the operation is originally scheduled, and again when it reaches a terminal status.
.temporal.api.enums.v1.NexusOperationExecutionStatus status = 6;- Returns:
- The status.
-
getStateValue
int getStateValue()More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.
.temporal.api.enums.v1.PendingNexusOperationState state = 7;- Returns:
- The enum numeric value on the wire for state.
-
getState
PendingNexusOperationState getState()More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.
.temporal.api.enums.v1.PendingNexusOperationState state = 7;- Returns:
- The state.
-
hasScheduleToCloseTimeout
boolean hasScheduleToCloseTimeout()Schedule-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 8;- Returns:
- Whether the scheduleToCloseTimeout field is set.
-
getScheduleToCloseTimeout
com.google.protobuf.Duration getScheduleToCloseTimeout()Schedule-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 8;- Returns:
- The scheduleToCloseTimeout.
-
getScheduleToCloseTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()Schedule-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 8; -
hasScheduleToStartTimeout
boolean hasScheduleToStartTimeout()Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_start_timeout = 9;- Returns:
- Whether the scheduleToStartTimeout field is set.
-
getScheduleToStartTimeout
com.google.protobuf.Duration getScheduleToStartTimeout()Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_start_timeout = 9;- Returns:
- The scheduleToStartTimeout.
-
getScheduleToStartTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_start_timeout = 9; -
hasStartToCloseTimeout
boolean hasStartToCloseTimeout()Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration start_to_close_timeout = 10;- Returns:
- Whether the startToCloseTimeout field is set.
-
getStartToCloseTimeout
com.google.protobuf.Duration getStartToCloseTimeout()Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration start_to_close_timeout = 10;- Returns:
- The startToCloseTimeout.
-
getStartToCloseTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration start_to_close_timeout = 10; -
getAttempt
int getAttempt()The number of attempts made to deliver the start operation request. This number is approximate, it is incremented when a task is added to the history queue. In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task was never executed.
int32 attempt = 11;- Returns:
- The attempt.
-
hasScheduleTime
boolean hasScheduleTime()Time the operation was originally scheduled via a StartNexusOperation request.
.google.protobuf.Timestamp schedule_time = 12;- Returns:
- Whether the scheduleTime field is set.
-
getScheduleTime
com.google.protobuf.Timestamp getScheduleTime()Time the operation was originally scheduled via a StartNexusOperation request.
.google.protobuf.Timestamp schedule_time = 12;- Returns:
- The scheduleTime.
-
getScheduleTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()Time the operation was originally scheduled via a StartNexusOperation request.
.google.protobuf.Timestamp schedule_time = 12; -
hasExpirationTime
boolean hasExpirationTime()Scheduled time + schedule to close timeout.
.google.protobuf.Timestamp expiration_time = 13;- Returns:
- Whether the expirationTime field is set.
-
getExpirationTime
com.google.protobuf.Timestamp getExpirationTime()Scheduled time + schedule to close timeout.
.google.protobuf.Timestamp expiration_time = 13;- Returns:
- The expirationTime.
-
getExpirationTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()Scheduled time + schedule to close timeout.
.google.protobuf.Timestamp expiration_time = 13; -
hasCloseTime
boolean hasCloseTime()Time when the operation transitioned to a closed state.
.google.protobuf.Timestamp close_time = 14;- Returns:
- Whether the closeTime field is set.
-
getCloseTime
com.google.protobuf.Timestamp getCloseTime()Time when the operation transitioned to a closed state.
.google.protobuf.Timestamp close_time = 14;- Returns:
- The closeTime.
-
getCloseTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCloseTimeOrBuilder()Time when the operation transitioned to a closed state.
.google.protobuf.Timestamp close_time = 14; -
hasLastAttemptCompleteTime
boolean hasLastAttemptCompleteTime()The time when the last attempt completed.
.google.protobuf.Timestamp last_attempt_complete_time = 15;- Returns:
- Whether the lastAttemptCompleteTime field is set.
-
getLastAttemptCompleteTime
com.google.protobuf.Timestamp getLastAttemptCompleteTime()The time when the last attempt completed.
.google.protobuf.Timestamp last_attempt_complete_time = 15;- Returns:
- The lastAttemptCompleteTime.
-
getLastAttemptCompleteTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getLastAttemptCompleteTimeOrBuilder()The time when the last attempt completed.
.google.protobuf.Timestamp last_attempt_complete_time = 15; -
hasLastAttemptFailure
boolean hasLastAttemptFailure()The last attempt's failure, if any.
.temporal.api.failure.v1.Failure last_attempt_failure = 16;- Returns:
- Whether the lastAttemptFailure field is set.
-
getLastAttemptFailure
Failure getLastAttemptFailure()The last attempt's failure, if any.
.temporal.api.failure.v1.Failure last_attempt_failure = 16;- Returns:
- The lastAttemptFailure.
-
getLastAttemptFailureOrBuilder
FailureOrBuilder getLastAttemptFailureOrBuilder()The last attempt's failure, if any.
.temporal.api.failure.v1.Failure last_attempt_failure = 16; -
hasNextAttemptScheduleTime
boolean hasNextAttemptScheduleTime()The time when the next attempt is scheduled.
.google.protobuf.Timestamp next_attempt_schedule_time = 17;- Returns:
- Whether the nextAttemptScheduleTime field is set.
-
getNextAttemptScheduleTime
com.google.protobuf.Timestamp getNextAttemptScheduleTime()The time when the next attempt is scheduled.
.google.protobuf.Timestamp next_attempt_schedule_time = 17;- Returns:
- The nextAttemptScheduleTime.
-
getNextAttemptScheduleTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getNextAttemptScheduleTimeOrBuilder()The time when the next attempt is scheduled.
.google.protobuf.Timestamp next_attempt_schedule_time = 17; -
hasExecutionDuration
boolean hasExecutionDuration()Elapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.
.google.protobuf.Duration execution_duration = 18;- Returns:
- Whether the executionDuration field is set.
-
getExecutionDuration
com.google.protobuf.Duration getExecutionDuration()Elapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.
.google.protobuf.Duration execution_duration = 18;- Returns:
- The executionDuration.
-
getExecutionDurationOrBuilder
com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()Elapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.
.google.protobuf.Duration execution_duration = 18; -
hasCancellationInfo
boolean hasCancellationInfo().temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19;- Returns:
- Whether the cancellationInfo field is set.
-
getCancellationInfo
NexusOperationExecutionCancellationInfo getCancellationInfo().temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19;- Returns:
- The cancellationInfo.
-
getCancellationInfoOrBuilder
NexusOperationExecutionCancellationInfoOrBuilder getCancellationInfoOrBuilder().temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo cancellation_info = 19; -
getBlockedReason
String getBlockedReason()If the state is BLOCKED, blocked reason provides additional information.
string blocked_reason = 20;- Returns:
- The blockedReason.
-
getBlockedReasonBytes
com.google.protobuf.ByteString getBlockedReasonBytes()If the state is BLOCKED, blocked reason provides additional information.
string blocked_reason = 20;- Returns:
- The bytes for blockedReason.
-
getRequestId
String getRequestId()Server-generated request ID used as an idempotency token when submitting start requests to the handler. Distinct from the request_id in StartNexusOperationRequest, which is the caller-side idempotency key for the StartNexusOperation RPC itself.
string request_id = 21;- Returns:
- The requestId.
-
getRequestIdBytes
com.google.protobuf.ByteString getRequestIdBytes()Server-generated request ID used as an idempotency token when submitting start requests to the handler. Distinct from the request_id in StartNexusOperationRequest, which is the caller-side idempotency key for the StartNexusOperation RPC itself.
string request_id = 21;- Returns:
- The bytes for requestId.
-
getOperationToken
String getOperationToken()Operation token. Only set for asynchronous operations after a successful StartOperation call.
string operation_token = 22;- Returns:
- The operationToken.
-
getOperationTokenBytes
com.google.protobuf.ByteString getOperationTokenBytes()Operation token. Only set for asynchronous operations after a successful StartOperation call.
string operation_token = 22;- Returns:
- The bytes for operationToken.
-
getStateTransitionCount
long getStateTransitionCount()Incremented each time the operation's state is mutated in persistence.
int64 state_transition_count = 23;- Returns:
- The stateTransitionCount.
-
hasSearchAttributes
boolean hasSearchAttributes().temporal.api.common.v1.SearchAttributes search_attributes = 24;- Returns:
- Whether the searchAttributes field is set.
-
getSearchAttributes
SearchAttributes getSearchAttributes().temporal.api.common.v1.SearchAttributes search_attributes = 24;- Returns:
- The searchAttributes.
-
getSearchAttributesOrBuilder
SearchAttributesOrBuilder getSearchAttributesOrBuilder().temporal.api.common.v1.SearchAttributes search_attributes = 24; -
getNexusHeaderCount
int getNexusHeaderCount()Header for context propagation and tracing purposes.
map<string, string> nexus_header = 25; -
containsNexusHeader
Header for context propagation and tracing purposes.
map<string, string> nexus_header = 25; -
getNexusHeader
-
getNexusHeaderMap
-
getNexusHeaderOrDefault
-
getNexusHeaderOrThrow
-
hasUserMetadata
boolean hasUserMetadata()Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.
.temporal.api.sdk.v1.UserMetadata user_metadata = 26;- 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 operation.
.temporal.api.sdk.v1.UserMetadata user_metadata = 26;- Returns:
- The userMetadata.
-
getUserMetadataOrBuilder
UserMetadataOrBuilder getUserMetadataOrBuilder()Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.
.temporal.api.sdk.v1.UserMetadata user_metadata = 26; -
getLinksList
-
getLinks
Links attached by the handler of this operation on start or completion.
repeated .temporal.api.common.v1.Link links = 27; -
getLinksCount
int getLinksCount()Links attached by the handler of this operation on start or completion.
repeated .temporal.api.common.v1.Link links = 27; -
getLinksOrBuilderList
List<? extends LinkOrBuilder> getLinksOrBuilderList()Links attached by the handler of this operation on start or completion.
repeated .temporal.api.common.v1.Link links = 27; -
getLinksOrBuilder
Links attached by the handler of this operation on start or completion.
repeated .temporal.api.common.v1.Link links = 27; -
getIdentity
String getIdentity()The identity of the client who started this operation.
string identity = 28;- Returns:
- The identity.
-
getIdentityBytes
com.google.protobuf.ByteString getIdentityBytes()The identity of the client who started this operation.
string identity = 28;- Returns:
- The bytes for identity.
-
getStateSizeBytes
long getStateSizeBytes()Updated once on scheduled and once on terminal status.
int64 state_size_bytes = 29;- Returns:
- The stateSizeBytes.
-