Package io.temporal.api.sdk.v1

Interface WorkflowTaskCompletedMetadataOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getCoreUsedFlags​(int index)
      Internal flags used by the core SDK.
      int getCoreUsedFlagsCount()
      Internal flags used by the core SDK.
      java.util.List<java.lang.Integer> getCoreUsedFlagsList()
      Internal flags used by the core SDK.
      int getLangUsedFlags​(int index)
      Flags used by the SDK lang.
      int getLangUsedFlagsCount()
      Flags used by the SDK lang.
      java.util.List<java.lang.Integer> getLangUsedFlagsList()
      Flags used by the SDK lang.
      java.lang.String getSdkName()
      Name of the SDK that processed the task.
      com.google.protobuf.ByteString getSdkNameBytes()
      Name of the SDK that processed the task.
      java.lang.String getSdkVersion()
      Version of the SDK that processed the task.
      com.google.protobuf.ByteString getSdkVersionBytes()
      Version of the SDK that processed the task.

      • 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

      • getCoreUsedFlagsList

        java.util.List<java.lang.Integer> getCoreUsedFlagsList()
         Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:

 During replay:
 * If a flag is not recognized (value is too high or not defined), it must fail the workflow
   task.
 * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
   that flag during and after this WFT are allowed to assume that the flag is present.
 * If a code check for a flag does not find the flag in the set of used flags, it must take
   the branch corresponding to the absence of that flag.

 During non-replay execution of new WFTs:
 * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
   previously recorded) flags when completing the WFT.

 SDKs which are too old to even know about this field at all are considered to produce
 undefined behavior if they replay workflows which used this mechanism.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 core_used_flags = 1;
        Returns:
        A list containing the coreUsedFlags.

      • getCoreUsedFlagsCount

        int getCoreUsedFlagsCount()
         Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:

 During replay:
 * If a flag is not recognized (value is too high or not defined), it must fail the workflow
   task.
 * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
   that flag during and after this WFT are allowed to assume that the flag is present.
 * If a code check for a flag does not find the flag in the set of used flags, it must take
   the branch corresponding to the absence of that flag.

 During non-replay execution of new WFTs:
 * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
   previously recorded) flags when completing the WFT.

 SDKs which are too old to even know about this field at all are considered to produce
 undefined behavior if they replay workflows which used this mechanism.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 core_used_flags = 1;
        Returns:
        The count of coreUsedFlags.

      • getCoreUsedFlags

        int getCoreUsedFlags​(int index)
         Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:

 During replay:
 * If a flag is not recognized (value is too high or not defined), it must fail the workflow
   task.
 * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
   that flag during and after this WFT are allowed to assume that the flag is present.
 * If a code check for a flag does not find the flag in the set of used flags, it must take
   the branch corresponding to the absence of that flag.

 During non-replay execution of new WFTs:
 * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
   previously recorded) flags when completing the WFT.

 SDKs which are too old to even know about this field at all are considered to produce
 undefined behavior if they replay workflows which used this mechanism.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 core_used_flags = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The coreUsedFlags at the given index.

      • getLangUsedFlagsList

        java.util.List<java.lang.Integer> getLangUsedFlagsList()
         Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
 here as processing a workflow with a different language than the one which authored it is
 already undefined behavior. See `core_used_patches` for more.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 lang_used_flags = 2;
        Returns:
        A list containing the langUsedFlags.

      • getLangUsedFlagsCount

        int getLangUsedFlagsCount()
         Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
 here as processing a workflow with a different language than the one which authored it is
 already undefined behavior. See `core_used_patches` for more.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 lang_used_flags = 2;
        Returns:
        The count of langUsedFlags.

      • getLangUsedFlags

        int getLangUsedFlags​(int index)
         Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
 here as processing a workflow with a different language than the one which authored it is
 already undefined behavior. See `core_used_patches` for more.

 (-- api-linter: core::0141::forbidden-types=disabled
     aip.dev/not-precedent: These really shouldn't have negative values. --)
        repeated uint32 lang_used_flags = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The langUsedFlags at the given index.

      • getSdkName

        java.lang.String getSdkName()
         Name of the SDK that processed the task. This is usually something like "temporal-go" and is
 usually the same as client-name gRPC header. This should only be set if its value changed
 since the last time recorded on the workflow (or be set on the first task).

 (-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We're ok with a name suffix here. --)
        string sdk_name = 3;
        Returns:
        The sdkName.

      • getSdkNameBytes

        com.google.protobuf.ByteString getSdkNameBytes()
         Name of the SDK that processed the task. This is usually something like "temporal-go" and is
 usually the same as client-name gRPC header. This should only be set if its value changed
 since the last time recorded on the workflow (or be set on the first task).

 (-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We're ok with a name suffix here. --)
        string sdk_name = 3;
        Returns:
        The bytes for sdkName.

      • getSdkVersion

        java.lang.String getSdkVersion()
         Version of the SDK that processed the task. This is usually something like "1.20.0" and is
 usually the same as client-version gRPC header. This should only be set if its value changed
 since the last time recorded on the workflow (or be set on the first task).
        string sdk_version = 4;
        Returns:
        The sdkVersion.

      • getSdkVersionBytes

        com.google.protobuf.ByteString getSdkVersionBytes()
         Version of the SDK that processed the task. This is usually something like "1.20.0" and is
 usually the same as client-version gRPC header. This should only be set if its value changed
 since the last time recorded on the workflow (or be set on the first task).
        string sdk_version = 4;
        Returns:
        The bytes for sdkVersion.