Interface ScheduleNexusOperationCommandAttributesOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ScheduleNexusOperationCommandAttributes,ScheduleNexusOperationCommandAttributes.Builder
@Generated(value="protoc",
comments="annotations:ScheduleNexusOperationCommandAttributesOrBuilder.java.pb.meta")
public interface ScheduleNexusOperationCommandAttributesOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanHeader to attach to the Nexus request.Endpoint name, must exist in the endpoint registry or this command will fail.com.google.protobuf.ByteStringEndpoint name, must exist in the endpoint registry or this command will fail.getInput()Input for the operation.Input for the operation.Deprecated.intHeader to attach to the Nexus request.Header to attach to the Nexus request.getNexusHeaderOrDefault(String key, String defaultValue) Header to attach to the Nexus request.Header to attach to the Nexus request.Operation name.com.google.protobuf.ByteStringOperation name.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.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.booleanhasInput()Input for the operation.booleanSchedule-to-close timeout for this operation.booleanSchedule-to-start timeout for this operation.booleanStart-to-close timeout for this 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
-
getEndpoint
String getEndpoint()Endpoint name, must exist in the endpoint registry or this command will fail.
string endpoint = 1;- Returns:
- The endpoint.
-
getEndpointBytes
com.google.protobuf.ByteString getEndpointBytes()Endpoint name, must exist in the endpoint registry or this command will fail.
string endpoint = 1;- Returns:
- The bytes for endpoint.
-
getService
-
getServiceBytes
com.google.protobuf.ByteString getServiceBytes()Service name.
string service = 2;- Returns:
- The bytes for service.
-
getOperation
-
getOperationBytes
com.google.protobuf.ByteString getOperationBytes()Operation name.
string operation = 3;- Returns:
- The bytes for operation.
-
hasInput
boolean hasInput()Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload sent in this command.
.temporal.api.common.v1.Payload input = 4;- Returns:
- Whether the input field is set.
-
getInput
Payload getInput()Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload sent in this command.
.temporal.api.common.v1.Payload input = 4;- Returns:
- The input.
-
getInputOrBuilder
PayloadOrBuilder getInputOrBuilder()Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload sent in this command.
.temporal.api.common.v1.Payload input = 4; -
hasScheduleToCloseTimeout
boolean hasScheduleToCloseTimeout()Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 5;- Returns:
- Whether the scheduleToCloseTimeout field is set.
-
getScheduleToCloseTimeout
com.google.protobuf.Duration getScheduleToCloseTimeout()Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 5;- Returns:
- The scheduleToCloseTimeout.
-
getScheduleToCloseTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --).google.protobuf.Duration schedule_to_close_timeout = 5; -
getNexusHeaderCount
int getNexusHeaderCount()Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
map<string, string> nexus_header = 6; -
containsNexusHeader
Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
map<string, string> nexus_header = 6; -
getNexusHeader
-
getNexusHeaderMap
Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
map<string, string> nexus_header = 6; -
getNexusHeaderOrDefault
Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
map<string, string> nexus_header = 6; -
getNexusHeaderOrThrow
Header to attach to the Nexus request. Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and transmitted to external services as-is. This is useful for propagating tracing information. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
map<string, string> nexus_header = 6; -
hasScheduleToStartTimeout
boolean hasScheduleToStartTimeout()Schedule-to-start timeout for this operation. Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration schedule_to_start_timeout = 7;- Returns:
- Whether the scheduleToStartTimeout field is set.
-
getScheduleToStartTimeout
com.google.protobuf.Duration getScheduleToStartTimeout()Schedule-to-start timeout for this operation. Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration schedule_to_start_timeout = 7;- Returns:
- The scheduleToStartTimeout.
-
getScheduleToStartTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()Schedule-to-start timeout for this operation. Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration schedule_to_start_timeout = 7; -
hasStartToCloseTimeout
boolean hasStartToCloseTimeout()Start-to-close timeout for this operation. Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration start_to_close_timeout = 8;- Returns:
- Whether the startToCloseTimeout field is set.
-
getStartToCloseTimeout
com.google.protobuf.Duration getStartToCloseTimeout()Start-to-close timeout for this operation. Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration start_to_close_timeout = 8;- Returns:
- The startToCloseTimeout.
-
getStartToCloseTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()Start-to-close timeout for this operation. Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) Requires server version 1.31.0 or later..google.protobuf.Duration start_to_close_timeout = 8;
-