Package io.temporal.api.sdk.v1

Class WorkflowTaskCompletedMetadata

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WorkflowTaskCompletedMetadataOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:WorkflowTaskCompletedMetadata.java.pb.meta")
public final class WorkflowTaskCompletedMetadata
extends com.google.protobuf.GeneratedMessageV3
implements WorkflowTaskCompletedMetadataOrBuilder
    Protobuf type temporal.api.sdk.v1.WorkflowTaskCompletedMetadata
    See Also:
    Serialized Form

    • Field Detail

      • CORE_USED_FLAGS_FIELD_NUMBER

        public static final int CORE_USED_FLAGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LANG_USED_FLAGS_FIELD_NUMBER

        public static final int LANG_USED_FLAGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SDK_VERSION_FIELD_NUMBER

        public static final int SDK_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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()

      • internalGetFieldAccessorTable

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

      • getCoreUsedFlagsList

        public 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;
        Specified by:
        getCoreUsedFlagsList in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        A list containing the coreUsedFlags.

      • getCoreUsedFlagsCount

        public 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;
        Specified by:
        getCoreUsedFlagsCount in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The count of coreUsedFlags.

      • getCoreUsedFlags

        public 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;
        Specified by:
        getCoreUsedFlags in interface WorkflowTaskCompletedMetadataOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The coreUsedFlags at the given index.

      • getLangUsedFlagsList

        public 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;
        Specified by:
        getLangUsedFlagsList in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        A list containing the langUsedFlags.

      • getLangUsedFlagsCount

        public 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;
        Specified by:
        getLangUsedFlagsCount in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The count of langUsedFlags.

      • getLangUsedFlags

        public 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;
        Specified by:
        getLangUsedFlags in interface WorkflowTaskCompletedMetadataOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The langUsedFlags at the given index.

      • getSdkName

        public 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;
        Specified by:
        getSdkName in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The sdkName.

      • getSdkNameBytes

        public 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;
        Specified by:
        getSdkNameBytes in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The bytes for sdkName.

      • getSdkVersion

        public 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;
        Specified by:
        getSdkVersion in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The sdkVersion.

      • getSdkVersionBytes

        public 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;
        Specified by:
        getSdkVersionBytes in interface WorkflowTaskCompletedMetadataOrBuilder
        Returns:
        The bytes for sdkVersion.

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

      • parseFrom

        public static WorkflowTaskCompletedMetadata parseFrom​(java.nio.ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static WorkflowTaskCompletedMetadata parseFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static WorkflowTaskCompletedMetadata parseFrom​(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static WorkflowTaskCompletedMetadata parseDelimitedFrom​(java.io.InputStream input)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static WorkflowTaskCompletedMetadata parseDelimitedFrom​(java.io.InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static WorkflowTaskCompletedMetadata parseFrom​(com.google.protobuf.CodedInputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static WorkflowTaskCompletedMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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