Class ExclusionRule.Builder (0.44.0)

public static final class ExclusionRule.Builder extends GeneratedMessage.Builder<ExclusionRule.Builder> implements ExclusionRuleOrBuilder

The rule that specifies conditions when filter detections are excluded from results.

Protobuf type google.cloud.modelarmor.v1.ExclusionRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ExclusionRule build()
Returns
Type Description
ExclusionRule

buildPartial()

public ExclusionRule buildPartial()
Returns
Type Description
ExclusionRule

clear()

public ExclusionRule.Builder clear()
Returns
Type Description
ExclusionRule.Builder
Overrides

clearDictionary()

public ExclusionRule.Builder clearDictionary()

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Returns
Type Description
ExclusionRule.Builder

clearMatchingScope()

public ExclusionRule.Builder clearMatchingScope()

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExclusionRule.Builder

This builder for chaining.

clearRegex()

public ExclusionRule.Builder clearRegex()

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Returns
Type Description
ExclusionRule.Builder

clearType()

public ExclusionRule.Builder clearType()
Returns
Type Description
ExclusionRule.Builder

getDefaultInstanceForType()

public ExclusionRule getDefaultInstanceForType()
Returns
Type Description
ExclusionRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDictionary()

public Dictionary getDictionary()

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Returns
Type Description
Dictionary

The dictionary.

getDictionaryBuilder()

public Dictionary.Builder getDictionaryBuilder()

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Returns
Type Description
Dictionary.Builder

getDictionaryOrBuilder()

public DictionaryOrBuilder getDictionaryOrBuilder()

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Returns
Type Description
DictionaryOrBuilder

getMatchingScope()

public MatchingScope getMatchingScope()

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MatchingScope

The matchingScope.

getMatchingScopeValue()

public int getMatchingScopeValue()

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for matchingScope.

getRegex()

public Regex getRegex()

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Returns
Type Description
Regex

The regex.

getRegexBuilder()

public Regex.Builder getRegexBuilder()

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Returns
Type Description
Regex.Builder

getRegexOrBuilder()

public RegexOrBuilder getRegexOrBuilder()

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Returns
Type Description
RegexOrBuilder

getTypeCase()

public ExclusionRule.TypeCase getTypeCase()
Returns
Type Description
ExclusionRule.TypeCase

hasDictionary()

public boolean hasDictionary()

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Returns
Type Description
boolean

Whether the dictionary field is set.

hasMatchingScope()

public boolean hasMatchingScope()

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the matchingScope field is set.

hasRegex()

public boolean hasRegex()

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Returns
Type Description
boolean

Whether the regex field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDictionary(Dictionary value)

public ExclusionRule.Builder mergeDictionary(Dictionary value)

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Parameter
Name Description
value Dictionary
Returns
Type Description
ExclusionRule.Builder

mergeFrom(ExclusionRule other)

public ExclusionRule.Builder mergeFrom(ExclusionRule other)
Parameter
Name Description
other ExclusionRule
Returns
Type Description
ExclusionRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExclusionRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExclusionRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExclusionRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExclusionRule.Builder
Overrides

mergeRegex(Regex value)

public ExclusionRule.Builder mergeRegex(Regex value)

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Parameter
Name Description
value Regex
Returns
Type Description
ExclusionRule.Builder

setDictionary(Dictionary value)

public ExclusionRule.Builder setDictionary(Dictionary value)

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Parameter
Name Description
value Dictionary
Returns
Type Description
ExclusionRule.Builder

setDictionary(Dictionary.Builder builderForValue)

public ExclusionRule.Builder setDictionary(Dictionary.Builder builderForValue)

Dictionary which defines the rule.

.google.cloud.modelarmor.v1.Dictionary dictionary = 1;

Parameter
Name Description
builderForValue Dictionary.Builder
Returns
Type Description
ExclusionRule.Builder

setMatchingScope(MatchingScope value)

public ExclusionRule.Builder setMatchingScope(MatchingScope value)

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MatchingScope

The matchingScope to set.

Returns
Type Description
ExclusionRule.Builder

This builder for chaining.

setMatchingScopeValue(int value)

public ExclusionRule.Builder setMatchingScopeValue(int value)

Optional. Specifies the scope of the input that should be matched against the exclusion rule. If unspecified, defaults to MATCHING_SCOPE_PARTIAL_MATCH.

optional .google.cloud.modelarmor.v1.MatchingScope matching_scope = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for matchingScope to set.

Returns
Type Description
ExclusionRule.Builder

This builder for chaining.

setRegex(Regex value)

public ExclusionRule.Builder setRegex(Regex value)

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Parameter
Name Description
value Regex
Returns
Type Description
ExclusionRule.Builder

setRegex(Regex.Builder builderForValue)

public ExclusionRule.Builder setRegex(Regex.Builder builderForValue)

Regular expression which defines the rule.

.google.cloud.modelarmor.v1.Regex regex = 2;

Parameter
Name Description
builderForValue Regex.Builder
Returns
Type Description
ExclusionRule.Builder