Package io.temporal.api.rules.v1

Class WorkflowRuleSpec

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  WorkflowRuleSpec.ActivityStartingTrigger
      Activity trigger will be triggered when an activity is about to start.
      static interface  WorkflowRuleSpec.ActivityStartingTriggerOrBuilder  
      static class  WorkflowRuleSpec.Builder
      Protobuf type temporal.api.rules.v1.WorkflowRuleSpec
      static class  WorkflowRuleSpec.TriggerCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

      • getId

        public java.lang.String getId()
         The id of the new workflow rule. Must be unique within the namespace.
 Can be set by the user, and can have business meaning.
        string id = 1;
        Specified by:
        getId in interface WorkflowRuleSpecOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         The id of the new workflow rule. Must be unique within the namespace.
 Can be set by the user, and can have business meaning.
        string id = 1;
        Specified by:
        getIdBytes in interface WorkflowRuleSpecOrBuilder
        Returns:
        The bytes for id.

      • hasActivityStart

        public boolean hasActivityStart()
        .temporal.api.rules.v1.WorkflowRuleSpec.ActivityStartingTrigger activity_start = 2;
        Specified by:
        hasActivityStart in interface WorkflowRuleSpecOrBuilder
        Returns:
        Whether the activityStart field is set.

      • getVisibilityQuery

        public java.lang.String getVisibilityQuery()
         Restricted Visibility query.
 This query is used to filter workflows in this namespace to which this rule should apply.
 It is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated.
 The following workflow attributes are supported:
 - WorkflowType
 - WorkflowId
 - StartTime
 - ExecutionStatus
        string visibility_query = 3;
        Specified by:
        getVisibilityQuery in interface WorkflowRuleSpecOrBuilder
        Returns:
        The visibilityQuery.

      • getVisibilityQueryBytes

        public com.google.protobuf.ByteString getVisibilityQueryBytes()
         Restricted Visibility query.
 This query is used to filter workflows in this namespace to which this rule should apply.
 It is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated.
 The following workflow attributes are supported:
 - WorkflowType
 - WorkflowId
 - StartTime
 - ExecutionStatus
        string visibility_query = 3;
        Specified by:
        getVisibilityQueryBytes in interface WorkflowRuleSpecOrBuilder
        Returns:
        The bytes for visibilityQuery.

      • getActionsList

        public java.util.List<WorkflowRuleAction> getActionsList()
         WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.
        repeated .temporal.api.rules.v1.WorkflowRuleAction actions = 4;
        Specified by:
        getActionsList in interface WorkflowRuleSpecOrBuilder

      • getActionsCount

        public int getActionsCount()
         WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.
        repeated .temporal.api.rules.v1.WorkflowRuleAction actions = 4;
        Specified by:
        getActionsCount in interface WorkflowRuleSpecOrBuilder

      • getActions

        public WorkflowRuleAction getActions​(int index)
         WorkflowRuleAction to be taken when the rule is triggered and predicate is matched.
        repeated .temporal.api.rules.v1.WorkflowRuleAction actions = 4;
        Specified by:
        getActions in interface WorkflowRuleSpecOrBuilder

      • hasExpirationTime

        public boolean hasExpirationTime()
         Expiration time of the rule. After this time, the rule will be deleted.
 Can be empty if the rule should never expire.
        .google.protobuf.Timestamp expiration_time = 5;
        Specified by:
        hasExpirationTime in interface WorkflowRuleSpecOrBuilder
        Returns:
        Whether the expirationTime field is set.

      • getExpirationTime

        public com.google.protobuf.Timestamp getExpirationTime()
         Expiration time of the rule. After this time, the rule will be deleted.
 Can be empty if the rule should never expire.
        .google.protobuf.Timestamp expiration_time = 5;
        Specified by:
        getExpirationTime in interface WorkflowRuleSpecOrBuilder
        Returns:
        The expirationTime.

      • getExpirationTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()
         Expiration time of the rule. After this time, the rule will be deleted.
 Can be empty if the rule should never expire.
        .google.protobuf.Timestamp expiration_time = 5;
        Specified by:
        getExpirationTimeOrBuilder in interface WorkflowRuleSpecOrBuilder

      • 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 WorkflowRuleSpec parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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