Class Rule (0.38.0)

public final class Rule extends GeneratedMessageV3 implements RuleOrBuilder

Represents the rule for a content warehouse trigger.

Protobuf type google.cloud.contentwarehouse.v1.Rule

Implements

RuleOrBuilder

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()
Returns
Type Description
Descriptor

newBuilder()

public static Rule.Builder newBuilder()
Returns
Type Description
Rule.Builder

newBuilder(Rule prototype)

public static Rule.Builder newBuilder(Rule prototype)
Parameter
Name Description
prototype Rule
Returns
Type Description
Rule.Builder

parseDelimitedFrom(InputStream input)

public static Rule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Rule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Rule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Rule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Rule> parser()
Returns
Type Description
Parser<Rule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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;

Returns
Type Description
List<Action>

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
Returns
Type Description
ActionOrBuilder

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()
Returns
Type Description
Parser<Rule>
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;

Returns
Type Description
Rule.TriggerType

The triggerType.

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

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rule.Builder newBuilderForType()
Returns
Type Description
Rule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Rule.Builder toBuilder()
Returns
Type Description
Rule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException