Package io.temporal.api.workflowservice.v1

Interface CreateWorkflowRuleRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Rule description.Will be stored with the rule.
      com.google.protobuf.ByteString getDescriptionBytes()
      Rule description.Will be stored with the rule.
      boolean getForceScan()
      If true, the rule will be applied to the currently running workflows via batch job.
      java.lang.String getIdentity()
      Identity of the actor who created the rule.
      com.google.protobuf.ByteString getIdentityBytes()
      Identity of the actor who created the rule.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      java.lang.String getRequestId()
      Used to de-dupe requests.
      com.google.protobuf.ByteString getRequestIdBytes()
      Used to de-dupe requests.
      WorkflowRuleSpec getSpec()
      The rule specification .
      WorkflowRuleSpecOrBuilder getSpecOrBuilder()
      The rule specification .
      boolean hasSpec()
      The rule specification .

      • 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

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • hasSpec

        boolean hasSpec()
         The rule specification .
        .temporal.api.rules.v1.WorkflowRuleSpec spec = 2;
        Returns:
        Whether the spec field is set.

      • getSpec

        WorkflowRuleSpec getSpec()
         The rule specification .
        .temporal.api.rules.v1.WorkflowRuleSpec spec = 2;
        Returns:
        The spec.

      • getSpecOrBuilder

        WorkflowRuleSpecOrBuilder getSpecOrBuilder()
         The rule specification .
        .temporal.api.rules.v1.WorkflowRuleSpec spec = 2;

      • getForceScan

        boolean getForceScan()
         If true, the rule will be applied to the currently running workflows via batch job.
 If not set , the rule will only be applied when triggering condition is satisfied.
 visibility_query in the rule will be used to select the workflows to apply the rule to.
        bool force_scan = 3;
        Returns:
        The forceScan.

      • getRequestId

        java.lang.String getRequestId()
         Used to de-dupe requests. Typically should be UUID.
        string request_id = 4;
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         Used to de-dupe requests. Typically should be UUID.
        string request_id = 4;
        Returns:
        The bytes for requestId.

      • getIdentity

        java.lang.String getIdentity()
         Identity of the actor who created the rule. Will be stored with the rule.
        string identity = 5;
        Returns:
        The identity.

      • getIdentityBytes

        com.google.protobuf.ByteString getIdentityBytes()
         Identity of the actor who created the rule. Will be stored with the rule.
        string identity = 5;
        Returns:
        The bytes for identity.

      • getDescription

        java.lang.String getDescription()
         Rule description.Will be stored with the rule.
        string description = 6;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Rule description.Will be stored with the rule.
        string description = 6;
        Returns:
        The bytes for description.