Class Rule.DoNotAssociateAction (2.36.0)

public static final class Rule.DoNotAssociateAction extends GeneratedMessageV3 implements Rule.DoNotAssociateActionOrBuilder

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

Protobuf type google.cloud.retail.v2beta.Rule.DoNotAssociateAction

Static Fields

DO_NOT_ASSOCIATE_TERMS_FIELD_NUMBER

public static final int DO_NOT_ASSOCIATE_TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_TERMS_FIELD_NUMBER

public static final int QUERY_TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

TERMS_FIELD_NUMBER

public static final int TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rule.DoNotAssociateAction getDefaultInstance()
Returns
TypeDescription
Rule.DoNotAssociateAction

getDescriptor()

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

newBuilder()

public static Rule.DoNotAssociateAction.Builder newBuilder()
Returns
TypeDescription
Rule.DoNotAssociateAction.Builder

newBuilder(Rule.DoNotAssociateAction prototype)

public static Rule.DoNotAssociateAction.Builder newBuilder(Rule.DoNotAssociateAction prototype)
Parameter
NameDescription
prototypeRule.DoNotAssociateAction
Returns
TypeDescription
Rule.DoNotAssociateAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.DoNotAssociateAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.DoNotAssociateAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Rule.DoNotAssociateAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rule.DoNotAssociateAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Rule.DoNotAssociateAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rule.DoNotAssociateAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Rule.DoNotAssociateAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.DoNotAssociateAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Rule.DoNotAssociateAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rule.DoNotAssociateAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Rule.DoNotAssociateAction> parser()
Returns
TypeDescription
Parser<DoNotAssociateAction>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Rule.DoNotAssociateAction getDefaultInstanceForType()
Returns
TypeDescription
Rule.DoNotAssociateAction

getDoNotAssociateTerms(int index)

public String getDoNotAssociateTerms(int index)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The doNotAssociateTerms at the given index.

getDoNotAssociateTermsBytes(int index)

public ByteString getDoNotAssociateTermsBytes(int index)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the doNotAssociateTerms at the given index.

getDoNotAssociateTermsCount()

public int getDoNotAssociateTermsCount()

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Returns
TypeDescription
int

The count of doNotAssociateTerms.

getDoNotAssociateTermsList()

public ProtocolStringList getDoNotAssociateTermsList()

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the doNotAssociateTerms.

getParserForType()

public Parser<Rule.DoNotAssociateAction> getParserForType()
Returns
TypeDescription
Parser<DoNotAssociateAction>
Overrides

getQueryTerms(int index)

public String getQueryTerms(int index)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The queryTerms at the given index.

getQueryTermsBytes(int index)

public ByteString getQueryTermsBytes(int index)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the queryTerms at the given index.

getQueryTermsCount()

public int getQueryTermsCount()

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
TypeDescription
int

The count of queryTerms.

getQueryTermsList()

public ProtocolStringList getQueryTermsList()

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the queryTerms.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTerms(int index)

public String getTerms(int index)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The terms at the given index.

getTermsBytes(int index)

public ByteString getTermsBytes(int index)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the terms at the given index.

getTermsCount()

public int getTermsCount()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
TypeDescription
int

The count of terms.

getTermsList()

public ProtocolStringList getTermsList()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the terms.

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 Rule.DoNotAssociateAction.Builder newBuilderForType()
Returns
TypeDescription
Rule.DoNotAssociateAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Rule.DoNotAssociateAction.Builder toBuilder()
Returns
TypeDescription
Rule.DoNotAssociateAction.Builder

writeTo(CodedOutputStream output)

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