Class Rule.DoNotAssociateAction (2.46.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.v2alpha.Rule.DoNotAssociateAction

Static Fields

DO_NOT_ASSOCIATE_TERMS_FIELD_NUMBER

public static final int DO_NOT_ASSOCIATE_TERMS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_TERMS_FIELD_NUMBER

public static final int QUERY_TERMS_FIELD_NUMBER
Field Value
Type Description
int

TERMS_FIELD_NUMBER

public static final int TERMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rule.DoNotAssociateAction getDefaultInstance()
Returns
Type Description
Rule.DoNotAssociateAction

getDescriptor()

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

newBuilder()

public static Rule.DoNotAssociateAction.Builder newBuilder()
Returns
Type Description
Rule.DoNotAssociateAction.Builder

newBuilder(Rule.DoNotAssociateAction prototype)

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

parseDelimitedFrom(InputStream input)

public static Rule.DoNotAssociateAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.DoNotAssociateAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Rule.DoNotAssociateAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule.DoNotAssociateAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Rule.DoNotAssociateAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule.DoNotAssociateAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Rule.DoNotAssociateAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.DoNotAssociateAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Rule.DoNotAssociateAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule.DoNotAssociateAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Rule.DoNotAssociateAction getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the doNotAssociateTerms.

getParserForType()

public Parser<Rule.DoNotAssociateAction> getParserForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the queryTerms.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTerms(int index)

public String getTerms(int index)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
int

The count of terms.

getTermsList()

public ProtocolStringList getTermsList()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
Type Description
ProtocolStringList

A list containing the terms.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Rule.DoNotAssociateAction.Builder toBuilder()
Returns
Type Description
Rule.DoNotAssociateAction.Builder

writeTo(CodedOutputStream output)

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