Class NexusOperationScheduledEventAttributes

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.history.v1.NexusOperationScheduledEventAttributes
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NexusOperationScheduledEventAttributesOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:NexusOperationScheduledEventAttributes.java.pb.meta") public final class NexusOperationScheduledEventAttributes extends com.google.protobuf.GeneratedMessageV3 implements NexusOperationScheduledEventAttributesOrBuilder
 Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.
Protobuf type temporal.api.history.v1.NexusOperationScheduledEventAttributes
See Also:

  • Field Details

    • ENDPOINT_FIELD_NUMBER

      public static final int ENDPOINT_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

    • OPERATION_FIELD_NUMBER

      public static final int OPERATION_FIELD_NUMBER
      See Also:

    • INPUT_FIELD_NUMBER

      public static final int INPUT_FIELD_NUMBER
      See Also:

    • SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER

      public static final int SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER
      See Also:

    • NEXUS_HEADER_FIELD_NUMBER

      public static final int NEXUS_HEADER_FIELD_NUMBER
      See Also:

    • WORKFLOW_TASK_COMPLETED_EVENT_ID_FIELD_NUMBER

      public static final int WORKFLOW_TASK_COMPLETED_EVENT_ID_FIELD_NUMBER
      See Also:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:

    • ENDPOINT_ID_FIELD_NUMBER

      public static final int ENDPOINT_ID_FIELD_NUMBER
      See Also:

    • SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER

      public static final int SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER
      See Also:

    • START_TO_CLOSE_TIMEOUT_FIELD_NUMBER

      public static final int START_TO_CLOSE_TIMEOUT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getEndpoint

      public String getEndpoint()
       Endpoint name, must exist in the endpoint registry.
      string endpoint = 1;
      Specified by:
      getEndpoint in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The endpoint.

    • getEndpointBytes

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

    • getService

      public String getService()
       Service name.
      string service = 2;
      Specified by:
      getService in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The service.

    • getServiceBytes

      public com.google.protobuf.ByteString getServiceBytes()
       Service name.
      string service = 2;
      Specified by:
      getServiceBytes in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The bytes for service.

    • getOperation

      public String getOperation()
       Operation name.
      string operation = 3;
      Specified by:
      getOperation in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The operation.

    • getOperationBytes

      public com.google.protobuf.ByteString getOperationBytes()
       Operation name.
      string operation = 3;
      Specified by:
      getOperationBytes in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The bytes for operation.

    • hasInput

      public 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;
      Specified by:
      hasInput in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      Whether the input field is set.

    • getInput

      public 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;
      Specified by:
      getInput in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The input.

    • getInputOrBuilder

      public 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;
      Specified by:
      getInputOrBuilder in interface NexusOperationScheduledEventAttributesOrBuilder

    • hasScheduleToCloseTimeout

      public 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. --)
 (-- api-linter: core::0142::time-field-names=disabled
     aip.dev/not-precedent: "timeout" is an acceptable suffix for duration fields in this API. --)
      .google.protobuf.Duration schedule_to_close_timeout = 5;
      Specified by:
      hasScheduleToCloseTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      Whether the scheduleToCloseTimeout field is set.

    • getScheduleToCloseTimeout

      public 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. --)
 (-- api-linter: core::0142::time-field-names=disabled
     aip.dev/not-precedent: "timeout" is an acceptable suffix for duration fields in this API. --)
      .google.protobuf.Duration schedule_to_close_timeout = 5;
      Specified by:
      getScheduleToCloseTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The scheduleToCloseTimeout.

    • getScheduleToCloseTimeoutOrBuilder

      public 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. --)
 (-- api-linter: core::0142::time-field-names=disabled
     aip.dev/not-precedent: "timeout" is an acceptable suffix for duration fields in this API. --)
      .google.protobuf.Duration schedule_to_close_timeout = 5;
      Specified by:
      getScheduleToCloseTimeoutOrBuilder in interface NexusOperationScheduledEventAttributesOrBuilder

    • getNexusHeaderCount

      public int getNexusHeaderCount()
      Description copied from interface: NexusOperationScheduledEventAttributesOrBuilder
       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;
      Specified by:
      getNexusHeaderCount in interface NexusOperationScheduledEventAttributesOrBuilder

    • containsNexusHeader

      public boolean containsNexusHeader(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;
      Specified by:
      containsNexusHeader in interface NexusOperationScheduledEventAttributesOrBuilder

    • getNexusHeader

      @Deprecated public Map<String,String> getNexusHeader()
      Deprecated.
      Use getNexusHeaderMap() instead.
      Specified by:
      getNexusHeader in interface NexusOperationScheduledEventAttributesOrBuilder

    • getNexusHeaderMap

      public Map<String,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;
      Specified by:
      getNexusHeaderMap in interface NexusOperationScheduledEventAttributesOrBuilder

    • getNexusHeaderOrDefault

      public String getNexusHeaderOrDefault(String key, 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;
      Specified by:
      getNexusHeaderOrDefault in interface NexusOperationScheduledEventAttributesOrBuilder

    • getNexusHeaderOrThrow

      public String getNexusHeaderOrThrow(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;
      Specified by:
      getNexusHeaderOrThrow in interface NexusOperationScheduledEventAttributesOrBuilder

    • getWorkflowTaskCompletedEventId

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

    • getRequestId

      public 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;
      Specified by:
      getRequestId in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The requestId.

    • getRequestIdBytes

      public 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;
      Specified by:
      getRequestIdBytes in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The bytes for requestId.

    • getEndpointId

      public 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;
      Specified by:
      getEndpointId in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The endpointId.

    • getEndpointIdBytes

      public 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;
      Specified by:
      getEndpointIdBytes in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The bytes for endpointId.

    • hasScheduleToStartTimeout

      public boolean hasScheduleToStartTimeout()
       Schedule-to-start timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.schedule_to_start_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 10;
      Specified by:
      hasScheduleToStartTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      Whether the scheduleToStartTimeout field is set.

    • getScheduleToStartTimeout

      public com.google.protobuf.Duration getScheduleToStartTimeout()
       Schedule-to-start timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.schedule_to_start_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 10;
      Specified by:
      getScheduleToStartTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The scheduleToStartTimeout.

    • getScheduleToStartTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
       Schedule-to-start timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.schedule_to_start_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 10;
      Specified by:
      getScheduleToStartTimeoutOrBuilder in interface NexusOperationScheduledEventAttributesOrBuilder

    • hasStartToCloseTimeout

      public boolean hasStartToCloseTimeout()
       Start-to-close timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.start_to_close_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 11;
      Specified by:
      hasStartToCloseTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      Whether the startToCloseTimeout field is set.

    • getStartToCloseTimeout

      public com.google.protobuf.Duration getStartToCloseTimeout()
       Start-to-close timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.start_to_close_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 11;
      Specified by:
      getStartToCloseTimeout in interface NexusOperationScheduledEventAttributesOrBuilder
      Returns:
      The startToCloseTimeout.

    • getStartToCloseTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
       Start-to-close timeout for this operation.
 See ScheduleNexusOperationCommandAttributes.start_to_close_timeout for details.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 11;
      Specified by:
      getStartToCloseTimeoutOrBuilder in interface NexusOperationScheduledEventAttributesOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 NexusOperationScheduledEventAttributes parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NexusOperationScheduledEventAttributes parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static NexusOperationScheduledEventAttributes parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NexusOperationScheduledEventAttributes parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NexusOperationScheduledEventAttributes parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NexusOperationScheduledEventAttributes parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NexusOperationScheduledEventAttributes parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NexusOperationScheduledEventAttributes parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static NexusOperationScheduledEventAttributes.Builder newBuilder()

    • newBuilder

      public static NexusOperationScheduledEventAttributes.Builder newBuilder(NexusOperationScheduledEventAttributes prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static NexusOperationScheduledEventAttributes getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NexusOperationScheduledEventAttributes> parser()

    • getParserForType

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