Send feedback
Class Rule (0.51.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.51.0 keyboard_arrow_down
public final class Rule extends GeneratedMessageV3 implements RuleOrBuilder
Represents the rule for a content warehouse trigger.
Protobuf type google.cloud.contentwarehouse.v1.Rule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIONS_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER
Field Value
Type
Description
int
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value
Type
Description
int
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type
Description
int
RULE_ID_FIELD_NUMBER
public static final int RULE_ID_FIELD_NUMBER
Field Value
Type
Description
int
TRIGGER_TYPE_FIELD_NUMBER
public static final int TRIGGER_TYPE_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static Rule getDefaultInstance ()
Returns
Type
Description
Rule
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Rule . Builder newBuilder ()
newBuilder(Rule prototype)
public static Rule . Builder newBuilder ( Rule prototype )
Parameter
Name
Description
prototype
Rule
parseDelimitedFrom(InputStream input)
public static Rule parseDelimitedFrom ( InputStream input )
Returns
Type
Description
Rule
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Rule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parseFrom(byte[] data)
public static Rule parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
Returns
Type
Description
Rule
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parseFrom(ByteString data)
public static Rule parseFrom ( ByteString data )
Returns
Type
Description
Rule
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parseFrom(CodedInputStream input)
public static Rule parseFrom ( CodedInputStream input )
Returns
Type
Description
Rule
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Rule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parseFrom(InputStream input)
public static Rule parseFrom ( InputStream input )
Returns
Type
Description
Rule
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Rule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parseFrom(ByteBuffer data)
public static Rule parseFrom ( ByteBuffer data )
Returns
Type
Description
Rule
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Rule
parser()
public static Parser<Rule> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getActions(int index)
public Action getActions ( int index )
List of actions that are executed when the rule is satisfied.
repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
Parameter
Name
Description
index
int
Returns
Type
Description
Action
getActionsCount()
public int getActionsCount ()
List of actions that are executed when the rule is satisfied.
repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
Returns
Type
Description
int
getActionsList()
public List<Action> getActionsList ()
List of actions that are executed when the rule is satisfied.
repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
getActionsOrBuilder(int index)
public ActionOrBuilder getActionsOrBuilder ( int index )
List of actions that are executed when the rule is satisfied.
repeated .google.cloud.contentwarehouse.v1.Action actions = 5;
Parameter
Name
Description
index
int
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;
Returns
Type
Description
List <? extends com.google.cloud.contentwarehouse.v1.ActionOrBuilder >
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;
Returns
Type
Description
String
The condition.
getConditionBytes()
public 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;
Returns
Type
Description
ByteString
The bytes for condition.
getDefaultInstanceForType()
public Rule getDefaultInstanceForType ()
Returns
Type
Description
Rule
getDescription()
public String getDescription ()
Short description of the rule and its context.
string description = 1;
Returns
Type
Description
String
The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Short description of the rule and its context.
string description = 1;
Returns
Type
Description
ByteString
The bytes for description.
getParserForType()
public Parser<Rule> getParserForType ()
Overrides
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;
Returns
Type
Description
String
The ruleId.
getRuleIdBytes()
public ByteString getRuleIdBytes ()
ID of the rule. It has to be unique across all the examples.
This is managed internally.
string rule_id = 2;
Returns
Type
Description
ByteString
The bytes for ruleId.
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getTriggerType()
public Rule . TriggerType getTriggerType ()
Identifies the trigger type for running the policy.
.google.cloud.contentwarehouse.v1.Rule.TriggerType trigger_type = 3;
getTriggerTypeValue()
public int getTriggerTypeValue ()
Identifies the trigger type for running the policy.
.google.cloud.contentwarehouse.v1.Rule.TriggerType trigger_type = 3;
Returns
Type
Description
int
The enum numeric value on the wire for triggerType.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Rule . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public Rule . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]