Package com.google.cloud.contentwarehouse.v1

Class Rule

  • All Implemented Interfaces:
    RuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Rule
extends com.google.protobuf.GeneratedMessageV3
implements RuleOrBuilder
     Represents the rule for a content warehouse trigger.
    Protobuf type google.cloud.contentwarehouse.v1.Rule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Rule.Builder
      Represents the rule for a content warehouse trigger.
      static class  Rule.TriggerType
      The trigger types for actions.

      • 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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      Action getActions​(int index)
      List of actions that are executed when the rule is satisfied.
      int getActionsCount()
      List of actions that are executed when the rule is satisfied.
      List<Action> getActionsList()
      List of actions that are executed when the rule is satisfied.
      ActionOrBuilder getActionsOrBuilder​(int index)
      List of actions that are executed when the rule is satisfied.
      List<? extends ActionOrBuilder> getActionsOrBuilderList()
      List of actions that are executed when the rule is satisfied.
      String getCondition()
      Represents the conditional expression to be evaluated.
      com.google.protobuf.ByteString getConditionBytes()
      Represents the conditional expression to be evaluated.
      static Rule getDefaultInstance()  
      Rule getDefaultInstanceForType()  
      String getDescription()
      Short description of the rule and its context.
      com.google.protobuf.ByteString getDescriptionBytes()
      Short description of the rule and its context.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<Rule> getParserForType()  
      String getRuleId()
      ID of the rule.
      com.google.protobuf.ByteString getRuleIdBytes()
      ID of the rule.
      int getSerializedSize()  
      Rule.TriggerType getTriggerType()
      Identifies the trigger type for running the policy.
      int getTriggerTypeValue()
      Identifies the trigger type for running the policy.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Rule.Builder newBuilder()  
      static Rule.Builder newBuilder​(Rule prototype)  
      Rule.Builder newBuilderForType()  
      protected Rule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Rule parseDelimitedFrom​(InputStream input)  
      static Rule parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rule parseFrom​(byte[] data)  
      static Rule parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rule parseFrom​(com.google.protobuf.ByteString data)  
      static Rule parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rule parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Rule parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rule parseFrom​(InputStream input)  
      static Rule parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Rule parseFrom​(ByteBuffer data)  
      static Rule parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Rule> parser()  
      Rule.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

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

      • internalGetFieldAccessorTable

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

      • getDescription

        public String getDescription()
         Short description of the rule and its context.
        string description = 1;
        Specified by:
        getDescription in interface RuleOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Short description of the rule and its context.
        string description = 1;
        Specified by:
        getDescriptionBytes in interface RuleOrBuilder
        Returns:
        The bytes for description.

      • getRuleId

        public String getRuleId()
         ID of the rule. It has to be unique across all the examples.
 This is managed internally.
        string rule_id = 2;
        Specified by:
        getRuleId in interface RuleOrBuilder
        Returns:
        The ruleId.

      • getRuleIdBytes

        public com.google.protobuf.ByteString getRuleIdBytes()
         ID of the rule. It has to be unique across all the examples.
 This is managed internally.
        string rule_id = 2;
        Specified by:
        getRuleIdBytes in interface RuleOrBuilder
        Returns:
        The bytes for ruleId.

      • getTriggerTypeValue

        public int getTriggerTypeValue()
         Identifies the trigger type for running the policy.
        .google.cloud.contentwarehouse.v1.Rule.TriggerType trigger_type = 3;
        Specified by:
        getTriggerTypeValue in interface RuleOrBuilder
        Returns:
        The enum numeric value on the wire for triggerType.

      • getTriggerType

        public Rule.TriggerType getTriggerType()
         Identifies the trigger type for running the policy.
        .google.cloud.contentwarehouse.v1.Rule.TriggerType trigger_type = 3;
        Specified by:
        getTriggerType in interface RuleOrBuilder
        Returns:
        The triggerType.

      • getCondition

        public String getCondition()
         Represents the conditional expression to be evaluated.
 Expression should evaluate to a boolean result.
 When the condition is true actions are executed.
 Example: user_role = "hsbc_role_1" AND doc.salary > 20000
        string condition = 4;
        Specified by:
        getCondition in interface RuleOrBuilder
        Returns:
        The condition.

      • getConditionBytes

        public com.google.protobuf.ByteString getConditionBytes()
         Represents the conditional expression to be evaluated.
 Expression should evaluate to a boolean result.
 When the condition is true actions are executed.
 Example: user_role = "hsbc_role_1" AND doc.salary > 20000
        string condition = 4;
        Specified by:
        getConditionBytes in interface RuleOrBuilder
        Returns:
        The bytes for condition.

      • getActionsList

        public List<Action> getActionsList()
         List of actions that are executed when the rule is satisfied.
        repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
        Specified by:
        getActionsList in interface RuleOrBuilder

      • getActionsOrBuilderList

        public List<? extends ActionOrBuilder> getActionsOrBuilderList()
         List of actions that are executed when the rule is satisfied.
        repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
        Specified by:
        getActionsOrBuilderList in interface RuleOrBuilder

      • getActionsCount

        public int getActionsCount()
         List of actions that are executed when the rule is satisfied.
        repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
        Specified by:
        getActionsCount in interface RuleOrBuilder

      • getActions

        public Action getActions​(int index)
         List of actions that are executed when the rule is satisfied.
        repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
        Specified by:
        getActions in interface RuleOrBuilder

      • getActionsOrBuilder

        public ActionOrBuilder getActionsOrBuilder​(int index)
         List of actions that are executed when the rule is satisfied.
        repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
        Specified by:
        getActionsOrBuilder in interface RuleOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Rule getDefaultInstance()

      • parser

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

      • getParserForType

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