Class ExclusionRule (0.44.0)

public final class ExclusionRule extends GeneratedMessage implements ExclusionRuleOrBuilder

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

Protobuf type google.cloud.modelarmor.v1.ExclusionRule

Static Fields

DICTIONARY_FIELD_NUMBER

public static final int DICTIONARY_FIELD_NUMBER
Field Value
Type Description
int

MATCHING_SCOPE_FIELD_NUMBER

public static final int MATCHING_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

REGEX_FIELD_NUMBER

public static final int REGEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExclusionRule getDefaultInstance()
Returns
Type Description
ExclusionRule

getDescriptor()

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

newBuilder()

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

newBuilder(ExclusionRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExclusionRule getDefaultInstanceForType()
Returns
Type Description
ExclusionRule

getDictionary()

public Dictionary getDictionary()

Dictionary which defines the rule.

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

Returns
Type Description
Dictionary

The dictionary.

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.

getParserForType()

public Parser<ExclusionRule> getParserForType()
Returns
Type Description
Parser<ExclusionRule>
Overrides

getRegex()

public Regex getRegex()

Regular expression which defines the rule.

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

Returns
Type Description
Regex

The regex.

getRegexOrBuilder()

public RegexOrBuilder getRegexOrBuilder()

Regular expression which defines the rule.

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

Returns
Type Description
RegexOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExclusionRule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExclusionRule.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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