Class SuggestionDenyListEntry (0.39.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.v1alpha.SuggestionDenyListEntry

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SuggestionDenyListEntry

Static Fields

BLOCK_PHRASE_FIELD_NUMBER

public static final int BLOCK_PHRASE_FIELD_NUMBER
Field Value
Type Description
int

MATCH_OPERATOR_FIELD_NUMBER

public static final int MATCH_OPERATOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SuggestionDenyListEntry getDefaultInstance()
Returns
Type Description
SuggestionDenyListEntry

getDescriptor()

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

newBuilder()

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

newBuilder(SuggestionDenyListEntry prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

The bytes for blockPhrase.

getDefaultInstanceForType()

public SuggestionDenyListEntry getDefaultInstanceForType()
Returns
Type Description
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.v1alpha.SuggestionDenyListEntry.MatchOperator match_operator = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
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.v1alpha.SuggestionDenyListEntry.MatchOperator match_operator = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for matchOperator.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SuggestionDenyListEntry.Builder newBuilderForType()
Returns
Type Description
SuggestionDenyListEntry.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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