Class SuggestionDenyListEntry (0.36.0)

public final class SuggestionDenyListEntry extends GeneratedMessageV3 implements SuggestionDenyListEntryOrBuilder

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Protobuf type google.cloud.discoveryengine.v1.SuggestionDenyListEntry

Static Fields

BLOCK_PHRASE_FIELD_NUMBER

public static final int BLOCK_PHRASE_FIELD_NUMBER
Field Value
TypeDescription
int

MATCH_OPERATOR_FIELD_NUMBER

public static final int MATCH_OPERATOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SuggestionDenyListEntry getDefaultInstance()
Returns
TypeDescription
SuggestionDenyListEntry

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SuggestionDenyListEntry.Builder newBuilder()
Returns
TypeDescription
SuggestionDenyListEntry.Builder

newBuilder(SuggestionDenyListEntry prototype)

public static SuggestionDenyListEntry.Builder newBuilder(SuggestionDenyListEntry prototype)
Parameter
NameDescription
prototypeSuggestionDenyListEntry
Returns
TypeDescription
SuggestionDenyListEntry.Builder

parseDelimitedFrom(InputStream input)

public static SuggestionDenyListEntry parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SuggestionDenyListEntry parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SuggestionDenyListEntry parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SuggestionDenyListEntry parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SuggestionDenyListEntry parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SuggestionDenyListEntry parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SuggestionDenyListEntry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionDenyListEntry
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SuggestionDenyListEntry> parser()
Returns
TypeDescription
Parser<SuggestionDenyListEntry>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBlockPhrase()

public String getBlockPhrase()

Required. Phrase to block from suggestions served. Can be maximum 125 characters.

string block_phrase = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The blockPhrase.

getBlockPhraseBytes()

public ByteString getBlockPhraseBytes()

Required. Phrase to block from suggestions served. Can be maximum 125 characters.

string block_phrase = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for blockPhrase.

getDefaultInstanceForType()

public SuggestionDenyListEntry getDefaultInstanceForType()
Returns
TypeDescription
SuggestionDenyListEntry

getMatchOperator()

public SuggestionDenyListEntry.MatchOperator getMatchOperator()

Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.

.google.cloud.discoveryengine.v1.SuggestionDenyListEntry.MatchOperator match_operator = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SuggestionDenyListEntry.MatchOperator

The matchOperator.

getMatchOperatorValue()

public int getMatchOperatorValue()

Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.

.google.cloud.discoveryengine.v1.SuggestionDenyListEntry.MatchOperator match_operator = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for matchOperator.

getParserForType()

public Parser<SuggestionDenyListEntry> getParserForType()
Returns
TypeDescription
Parser<SuggestionDenyListEntry>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SuggestionDenyListEntry.Builder newBuilderForType()
Returns
TypeDescription
SuggestionDenyListEntry.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SuggestionDenyListEntry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SuggestionDenyListEntry.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SuggestionDenyListEntry.Builder toBuilder()
Returns
TypeDescription
SuggestionDenyListEntry.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException