Package io.temporal.api.history.v1

Interface NexusOperationScheduledEventAttributesOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsNexusHeader​(java.lang.String key)
      Header to attach to the Nexus request.
      java.lang.String getEndpoint()
      Endpoint name, must exist in the endpoint registry.
      com.google.protobuf.ByteString getEndpointBytes()
      Endpoint name, must exist in the endpoint registry.
      java.lang.String getEndpointId()
      Endpoint ID as resolved in the endpoint registry at the time this event was generated.
      com.google.protobuf.ByteString getEndpointIdBytes()
      Endpoint ID as resolved in the endpoint registry at the time this event was generated.
      Payload getInput()
      Input for the operation.
      PayloadOrBuilder getInputOrBuilder()
      Input for the operation.
      java.util.Map<java.lang.String,​java.lang.String> getNexusHeader()
      Deprecated.
      int getNexusHeaderCount()
      Header to attach to the Nexus request.
      java.util.Map<java.lang.String,​java.lang.String> getNexusHeaderMap()
      Header to attach to the Nexus request.
      java.lang.String getNexusHeaderOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Header to attach to the Nexus request.
      java.lang.String getNexusHeaderOrThrow​(java.lang.String key)
      Header to attach to the Nexus request.
      java.lang.String getOperation()
      Operation name.
      com.google.protobuf.ByteString getOperationBytes()
      Operation name.
      java.lang.String getRequestId()
      A unique ID generated by the history service upon creation of this event.
      com.google.protobuf.ByteString getRequestIdBytes()
      A unique ID generated by the history service upon creation of this event.
      com.google.protobuf.Duration getScheduleToCloseTimeout()
      Schedule-to-close timeout for this operation.
      com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
      Schedule-to-close timeout for this operation.
      java.lang.String getService()
      Service name.
      com.google.protobuf.ByteString getServiceBytes()
      Service name.
      long getWorkflowTaskCompletedEventId()
      The `WORKFLOW_TASK_COMPLETED` event that the corresponding ScheduleNexusOperation command was reported with.
      boolean hasInput()
      Input for the operation.
      boolean hasScheduleToCloseTimeout()
      Schedule-to-close timeout for this operation.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getEndpoint

        java.lang.String getEndpoint()
         Endpoint name, must exist in the endpoint registry.
        string endpoint = 1;
        Returns:
        The endpoint.

      • getEndpointBytes

        com.google.protobuf.ByteString getEndpointBytes()
         Endpoint name, must exist in the endpoint registry.
        string endpoint = 1;
        Returns:
        The bytes for endpoint.

      • getService

        java.lang.String getService()
         Service name.
        string service = 2;
        Returns:
        The service.

      • getServiceBytes

        com.google.protobuf.ByteString getServiceBytes()
         Service name.
        string service = 2;
        Returns:
        The bytes for service.

      • getOperation

        java.lang.String getOperation()
         Operation name.
        string operation = 3;
        Returns:
        The operation.

      • 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 stored in this event.
        .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 stored in this event.
        .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 stored in this event.
        .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. 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

        boolean containsNexusHeader​(java.lang.String key)
         Header to attach to the Nexus request. 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

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getNexusHeader()
        Deprecated.
        Use getNexusHeaderMap() instead.

      • getNexusHeaderMap

        java.util.Map<java.lang.String,​java.lang.String> getNexusHeaderMap()
         Header to attach to the Nexus request. 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

        java.lang.String getNexusHeaderOrDefault​(java.lang.String key,
                                         java.lang.String defaultValue)
         Header to attach to the Nexus request. 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

        java.lang.String getNexusHeaderOrThrow​(java.lang.String key)
         Header to attach to the Nexus request. 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;

      • getWorkflowTaskCompletedEventId

        long getWorkflowTaskCompletedEventId()
         The `WORKFLOW_TASK_COMPLETED` event that the corresponding ScheduleNexusOperation command was reported with.
        int64 workflow_task_completed_event_id = 7;
        Returns:
        The workflowTaskCompletedEventId.

      • getRequestId

        java.lang.String getRequestId()
         A unique ID generated by the history service upon creation of this event.
 The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.
        string request_id = 8;
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         A unique ID generated by the history service upon creation of this event.
 The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.
        string request_id = 8;
        Returns:
        The bytes for requestId.

      • getEndpointId

        java.lang.String getEndpointId()
         Endpoint ID as resolved in the endpoint registry at the time this event was generated.
 This is stored on the event and used internally by the server in case the endpoint is renamed from the time the
 event was originally scheduled.
        string endpoint_id = 9;
        Returns:
        The endpointId.

      • getEndpointIdBytes

        com.google.protobuf.ByteString getEndpointIdBytes()
         Endpoint ID as resolved in the endpoint registry at the time this event was generated.
 This is stored on the event and used internally by the server in case the endpoint is renamed from the time the
 event was originally scheduled.
        string endpoint_id = 9;
        Returns:
        The bytes for endpointId.